https://github.com/sd2k/rocket_prometheus

Prometheus fairing and handler for Rocket
https://github.com/sd2k/rocket_prometheus

metrics prometheus rocket rust

Last synced: 28 days ago
JSON representation

Prometheus fairing and handler for Rocket

• Host: GitHub
• URL: https://github.com/sd2k/rocket_prometheus
• Owner: sd2k
• License: apache-2.0
• Created: 2019-04-15T16:16:47.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-20T09:42:34.000Z (6 months ago)
• Last Synced: 2024-09-26T20:45:39.455Z (about 1 month ago)
• Topics: metrics, prometheus, rocket, rust
• Language: Rust
• Homepage:
• Size: 131 KB
• Stars: 43
• Watchers: 3
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Rocket Prometheus

[![Build Status](https://github.com/sd2k/rocket_prometheus/workflows/Rust/badge.svg)](https://github.com/sd2k/rocket_prometheus/actions)

[![docs.rs](https://docs.rs/rocket_prometheus/badge.svg)](https://docs.rs/rocket_prometheus)

[![crates.io](https://img.shields.io/crates/v/rocket_prometheus.svg)](https://crates.io/crates/rocket_prometheus)

Prometheus instrumentation for Rocket applications.

## Usage

Add this crate to your `Cargo.toml` alongside Rocket 0.5.0:

```toml

[dependencies]

rocket = "0.5.0"

rocket_prometheus = "0.10.1"

```

Then attach and mount a `PrometheusMetrics` instance to your Rocket app:

```rust

use rocket_prometheus::PrometheusMetrics;

#[rocket::launch]

fn launch() -> _ {

    let prometheus = PrometheusMetrics::new();

    rocket::build()

        .attach(prometheus.clone())

        .mount("/metrics", prometheus)

```

This will expose metrics like this at the /metrics endpoint of your application:

```shell

$ curl localhost:8000/metrics

# HELP rocket_http_requests_duration_seconds HTTP request duration in seconds for all requests

# TYPE rocket_http_requests_duration_seconds histogram

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="0.005"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="0.01"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="0.025"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="0.05"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="0.1"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="0.25"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="0.5"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="1"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="2.5"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="5"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="10"} 2

rocket_http_requests_duration_seconds_bucket{endpoint="/metrics",method="GET",status="200",le="+Inf"} 2

rocket_http_requests_duration_seconds_sum{endpoint="/metrics",method="GET",status="200"} 0.0011045669999999999

rocket_http_requests_duration_seconds_count{endpoint="/metrics",method="GET",status="200"} 2

# HELP rocket_http_requests_total Total number of HTTP requests

# TYPE rocket_http_requests_total counter

rocket_http_requests_total{endpoint="/metrics",method="GET",status="200"} 2

```

## Metrics

By default this crate tracks two metrics:

- `rocket_http_requests_total` (labels: endpoint, method, status): the

  total number of HTTP requests handled by Rocket.

- `rocket_http_requests_duration_seconds` (labels: endpoint, method, status):

  the request duration for all HTTP requests handled by Rocket.

The 'rocket' prefix of these metrics can be changed by setting the

`ROCKET_PROMETHEUS_NAMESPACE` environment variable.

### Custom Metrics

Further metrics can be tracked by registering them with the registry of the

PrometheusMetrics instance:

```rust

#[macro_use]

use once_cell::sync::Lazy;

use rocket::{get, launch, routes};

use rocket_prometheus::{

    prometheus::{opts, IntCounterVec},

    PrometheusMetrics,

};

static NAME_COUNTER: Lazy = Lazy::new(|| {

    IntCounterVec::new(opts!("name_counter", "Count of names"), &["name"])

        .expect("Could not create NAME_COUNTER")

});

#[get("/hello/")]

pub fn hello(name: &str) -> String {

    NAME_COUNTER.with_label_values(&[name]).inc();

    format!("Hello, {}!", name)

}

#[launch]

fn launch() -> _ {

    let prometheus = PrometheusMetrics::new();

    prometheus

        .registry()

        .register(Box::new(NAME_COUNTER.clone()))

        .unwrap();

    rocket::build()

        .attach(prometheus.clone())

        .mount("/", routes![hello])

        .mount("/metrics", prometheus)

}

```