Struct fregate::Endpoints

pub struct Endpoints {
    pub health: Endpoint,
    pub live: Endpoint,
    pub ready: Endpoint,
    pub metrics: Endpoint,
}

By default endpoints are:

const HEALTH_ENDPOINT: &str = "/health";
const LIVE_ENDPOINT: &str = "/live";
const READY_ENDPOINT: &str = "/ready";
const METRICS_ENDPOINT: &str = "/metrics";

You might want to change those:
Example:

use fregate::{
    axum::{routing::get, Router},
    bootstrap, tokio, AppConfig, Application, ConfigSource,
};

async fn handler() -> &'static str {
    "Hello, World!"
}

#[tokio::main]
async fn main() {
    std::env::set_var("TEST_MANAGEMENT_ENDPOINTS_METRICS", "/observability");
    std::env::set_var("TEST_MANAGEMENT_ENDPOINTS_HEALTH", "///also_valid");
    // this is invalid default "/live" endpoint will be used.
    std::env::set_var("TEST_MANAGEMENT_ENDPOINTS_LIVE", "invalid");
    // this is invalid default "/ready" endpoint will be used.
    std::env::set_var("TEST_MANAGEMENT_ENDPOINTS_READY", "");

    let config: AppConfig = bootstrap([ConfigSource::EnvPrefix("TEST")]).unwrap();

    Application::new(&config)
        .router(Router::new().route("/", get(handler)))
        .serve()
        .await
        .unwrap();
}

Fields

health: Endpoint

health endpoint

live: Endpoint

live endpoint

ready: Endpoint

ready endpoint

metrics: Endpoint

metrics endpoint

Trait Implementations

impl Clone for Endpoints

fn clone(&self) -> Endpoints

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Endpoints

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Endpoints

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Endpoints

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.