Struct prometheus_hyper::Server

pub struct Server {}

Metrics Server based on tokio and hyper

Implementations

impl Server

pub async fn run<S, F, R>(registry: R, addr: S, shutdown: F) -> Result<(), Error>where
    S: Into<SocketAddr>,
    F: Future<Output = ()>,
    R: Deref<Target = Registry> + Clone + Send + 'static,

Create and run the metrics Server

Arguments

• registry - provide the Registry you are also registering your metric types to.
• addr - host:ip to tcp listen on.
• shutdown - a Future, once this completes the server will start to shut down. You can use a signal or Notify for clean shutdown or pending to newer shutdown.

Result

• hyper::Error returns the result if the shutdown was successful.

Examples

use prometheus::Registry;
use prometheus_hyper::Server;
use std::{net::SocketAddr, sync::Arc};

let registry = Arc::new(Registry::new());

// Start Server endlessly
tokio::spawn(async move {
    Server::run(
        Arc::clone(&registry),
        SocketAddr::from(([0; 4], 8080)),
        futures_util::future::pending(),
    )
    .await
});