diff --git a/README.md b/README.md index 1702e40..fb481c3 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,10 @@ Let's note that since `metrics-exporter-prometheus = "0.13"` that crate [introdu requires openssl support. The `axum_prometheus` crate __does not__ rely on, nor enable this feature by default — if you need it, you may enable it through the `"push-gateway"` feature in `axum_prometheus`. +## Prometheus push gateway feature + +This crate currently has no higher level API for the `push-gateway` feature. If you plan to use it, enable the `push-gateway` feature in `axum-prometheus`, use `BaseMetricLayer`, and setup your recorder manually, similar to the [`base-metric-layer-example`](./examples/base-metric-layer-example/src/main.rs). + ## Using a different exporter than Prometheus This crate may be used with other exporters than Prometheus. First, disable the default features: diff --git a/src/lib.rs b/src/lib.rs index 04ac2ce..2b0df42 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -88,6 +88,11 @@ //! axum_http_requests_duration_seconds_count{method="GET",status="200",endpoint="/metrics"} 4 //! ``` //! +//! ## Prometheus push gateway feature +//! This crate currently has no higher level API for the `push-gateway` feature. If you plan to use it, enable the +//! `push-gateway` feature in `axum-prometheus`, use `BaseMetricLayer`, and setup your recorder manually, similar to +//! the `base-metric-layer-example`. +//! //! ## Using a different exporter than Prometheus //! //! This crate may be used with other exporters than Prometheus. First, disable the default features: