Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ttys3/axum-otel-metrics
axum OpenTelemetry Metrics middleware with prometheus exporter
https://github.com/ttys3/axum-otel-metrics
axum axum-middleware metric metrics middleware opentelemetry prometheus
Last synced: 2 months ago
JSON representation
axum OpenTelemetry Metrics middleware with prometheus exporter
- Host: GitHub
- URL: https://github.com/ttys3/axum-otel-metrics
- Owner: ttys3
- Created: 2022-10-12T20:26:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T12:55:05.000Z (8 months ago)
- Last Synced: 2024-05-06T14:35:04.047Z (8 months ago)
- Topics: axum, axum-middleware, metric, metrics, middleware, opentelemetry, prometheus
- Language: Rust
- Homepage:
- Size: 250 KB
- Stars: 17
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# axum-otel-metrics
[](https://github.com/ttys3/axum-otel-metrics/actions/workflows/rust.yml)
[](https://crates.io/crates/axum-otel-metrics)
[](https://docs.rs/axum-otel-metrics)
axum OpenTelemetry metrics middleware with prometheus exporter
follow [Semantic Conventions for HTTP Metrics](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md)
[axum](https://github.com/tokio-rs/axum) is an ergonomic and modular web framework built with Tokio, Tower, and Hyper
be default, the metrics will be exported at `/metrics` endpoint.
and below metrics will be exported:
`requests_total` **counter**
```
requests_total
```
`http_server_active_requests` **gauge**
The number of active HTTP requests
`http_server_request_duration_seconds` **histogram**
```
http_server_request_duration_seconds_bucket
http_server_request_duration_seconds_sum
http_server_request_duration_seconds_count
```
`http_server_request_size_bytes` **histogram**
```
http_server_request_size_bytes_bucket
http_server_request_size_bytes_sum
http_server_request_size_bytes_count
```
`http_server_response_size_bytes_` **histogram**
```
http_server_response_size_bytes_bucket
http_server_response_size_bytes_sum
http_server_response_size_bytes_count
```
labels for `requests_total`,
`http_server_request_duration_seconds`, `http_server_request_size_bytes`,
`http_server_response_size_bytes` :
```
http_request_method
http_route
http_response_status_code
server_address
```
labels for `http_server_active_requests` :
```
http_request_method
url_scheme
```
## Usage
```rust
use axum_otel_metrics::HttpMetricsLayerBuilder;
let metrics = HttpMetricsLayerBuilder::new()
.build();
let app = Router::new()
// export metrics at `/metrics` endpoint
.merge(metrics.routes())
.route("/", get(handler))
.route("/hello", get(handler))
.route("/world", get(handler))
// add the metrics middleware
.layer(metrics);
```
## Usage with `State`
```rust
use axum_otel_metrics::HttpMetricsLayerBuilder;
#[derive(Clone)]
pub struct SharedState {
}
let state = SharedState {
};
let metrics = HttpMetricsLayerBuilder::new()
.build();
let app = Router::new()
// export metrics at `/metrics` endpoint
.merge(metrics.routes::())
.route("/", get(handler))
.route("/hello", get(handler))
.route("/world", get(handler))
// add the metrics middleware
.layer(metrics)
.with_state(state.clone());
```
## OpenTelemetry Rust Instrumentation Status and Releases
https://opentelemetry.io/docs/instrumentation/rust/#status-and-releases
| Traces | Metrics | Logs |
|--------------------------------------------------------------------------------------------------|---------|---------------------|
| [Beta](https://opentelemetry.io/docs/reference/specification/versioning-and-stability/#stable) | Alpha | Alpha |
## OpenTelemetry Metrics Exporter
**Push Metric Exporter** https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter
**Pull Metric Exporter** https://opentelemetry.io/docs/reference/specification/metrics/sdk/#pull-metric-exporter
### exporters
https://opentelemetry.io/docs/reference/specification/metrics/sdk_exporters/
In-memory https://opentelemetry.io/docs/reference/specification/metrics/sdk_exporters/in-memory/
Prometheus https://opentelemetry.io/docs/reference/specification/metrics/sdk_exporters/prometheus/
OTLP https://opentelemetry.io/docs/reference/specification/metrics/sdk_exporters/otlp/
Standard output https://opentelemetry.io/docs/reference/specification/metrics/sdk_exporters/stdout/
## Metrics Data Model
https://opentelemetry.io/docs/reference/specification/metrics/data-model/
## Related Projects
https://github.com/nlopes/actix-web-prom
> Actix-web middleware to expose Prometheus metrics
https://github.com/sd2k/rocket_prometheus
> Prometheus fairing and handler for Rocket
https://github.com/Ptrskay3/axum-prometheus
> axum-prometheus relies on metrics.rs and its ecosystem to collect and export metrics - for instance for Prometheus, metrics_exporter_prometheus is used as a backend to interact with Prometheus.