mysten_service/
metrics.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use prometheus::Registry;
use std::net::SocketAddr;
use std::net::{IpAddr, Ipv4Addr};

pub const METRICS_HOST_PORT: u16 = 9184;

/// This is an option if you need to use the underlying method
pub use mysten_metrics::start_prometheus_server;

/// Use the standard IP (0.0.0.0) and port (9184) to start a new
/// prometheus server.
///
/// Use this function to get a registry and then register your
/// own application metrics via
///
/// ```
/// use prometheus::{register_int_counter_with_registry, IntCounter, Registry};
///
/// pub struct MyMetrics {
///     pub requests: IntCounter,
/// }
///
/// impl MyMetrics {
///     pub fn new(registry: &Registry) -> Self {
///         Self {
///             requests: register_int_counter_with_registry!(
///                 "total_requests",
///                 "Total number of requests received by my service",
///                 registry
///             )
///             .unwrap(),
///         }
///     }
/// }
///
/// #[tokio::main]
/// async fn main() {
///      let prometheus_registry = mysten_service::metrics::start_basic_prometheus_server();
///      let metrics = MyMetrics::new(&prometheus_registry);
/// }
/// ```
pub fn start_basic_prometheus_server() -> Registry {
    let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), METRICS_HOST_PORT);
    mysten_metrics::start_prometheus_server(addr).default_registry()
}