#metrics-collection #prometheus-metrics #health-check

valensas-actuator

A library that provides Prometheus metrics collection capabilities for Rocket applications

8 unstable releases (3 breaking)

0.4.1 Sep 22, 2023
0.4.0 Sep 7, 2023
0.3.0 Aug 23, 2023
0.2.0 Aug 21, 2023
0.1.3 Jul 13, 2023

#493 in HTTP server

30 downloads per month
Used in valensas-rocket

MIT license

35KB
714 lines

Valensas Actuator

This library provides facilities for web server lifecycle operations.

Features:

  • Health checks: liveness and readiness

  • Prometheus metric collection

    • Rocket http request metrics

    • Tonic grpc request metrics

    • r2d2 connection pool metrics

    • Tokio runtime metrics

Installation

Add the following to your Cargo.toml:

[dependencies]
valensas-actuator = "*"

Features

The following crate features are available to use:

health: includes health check related functionalities

health-tonic: includes tonic-health health indicator

health-diesel: includes diesel health indicator

promtheteus-rocket: includes Prometheus scrap endpoint and Rocket http request metric collection

prometheus-tonic: includes Tonic grpc request metric collection

prometheus-r2d2: includes r2d2 connection pool metrics collection

Examples

For detailed usage examples, see the examples directory.

health.rs

Contains examples on how to configure health check endpoints and custom health indicators.

Run with cargo run --example health --features health,health-diesel.

prometheus.rs

Contains examples on how to configure Prometheus scrap endpoint and Rocket request metric collection.

Run with cargo run --example prometheus --features prometheus-rocket.

prometheus_tonic.rs

Contains examples on how to configure Prometheus scrap endpoint and Tonic gRPC request metric collection.

Run with cargo run --example prometheus_tonic --features prometheus-tonic.

prometheus_r2d2.rs

Contains examples on how to configure the r2d2 connection pool collector to expose pool usage metrics.

Run with cargo run --example prometheus_r2d2 --features prometheus-r2d2

prometheus_tokio.rs

Contains examples on how to configure the Tokio runtime pool collector to expose runtime usage metrics.

Dependencies

~16–47MB
~819K SLoC