Crate fregate

Developing an HTTP server requires to add code for logging, configuration, metrics, health checks etc. This crate aims to solve these problems providing user with Application builder for setting up HTTP service.

This project is in progress and might change a lot from version to version.

Re-exports

pub use axum;

pub use config;

pub use hyper;

pub use thiserror;

pub use tokio;

pub use tonic;

pub use tower;

pub use tower_http;

pub use tracing;

pub use tracing_subscriber;

pub use valuable;

Modules

error

fregate Errors

extensions

Extensions traits for different crates

health

Trait to implement custom Health checks

log_fmt

Fregate FormatEvent trait implementation

logging

Tools initialise logging and tracing

middleware

Middlewares to be used with axum::Router

proxy_router

Tool to implement reverse-proxy logic in axum::Router

sugar

Collection of syntax-sugar-like functions

tracing_fields

Instrument for logging

Structs

AppConfig

AppConfig reads and saves application configuration from different sources

AppConfigBuilder

AppConfig builder to set up multiple sources

Application

Application to set up HTTP server with given config AppConfig

Empty

Used as dummy structure to read AppConfig without private field

LoggerConfig

configuration for logs and traces

Enums

ConfigSource

Enum to specify configuration source type:

Functions

bootstrap

Reads AppConfig and init_tracing. Return Error if fails to read AppConfig or init_tracing. Return Error if called twice because of internal call to tracing_subscriber::registry().try_init().

get_metrics

Return rendered metrics

init_metrics

Initialise PrometheusRecorder