init4-bin-base 0.19.1

Internal utilities for binaries produced by the init4 team
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use crate::utils::from_env::{FromEnv, FromEnvErr, FromEnvVar};
use core::net::SocketAddr;
use metrics_exporter_prometheus::PrometheusBuilder;

use super::from_env::EnvItemInfo;

/// Metrics port env var
const METRICS_PORT: &str = "METRICS_PORT";

/// Prometheus metrics configuration struct.
///
/// Uses the following environment variables:
/// - `METRICS_PORT` - optional. Defaults to 9000 if missing or unparseable.
///   The port to bind the metrics server to.
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Deserialize)]
#[non_exhaustive]
#[serde(from = "Option<u16>")]
pub struct MetricsConfig {
    /// `METRICS_PORT` - The port on which to bind the metrics server. Defaults
    /// to `9000` if missing or unparseable.
    pub port: u16,
}

impl Default for MetricsConfig {
    fn default() -> Self {
        Self { port: 9000 }
    }
}

impl From<Option<u16>> for MetricsConfig {
    fn from(port: Option<u16>) -> Self {
        Self {
            port: port.unwrap_or(9000),
        }
    }
}

impl From<u16> for MetricsConfig {
    fn from(port: u16) -> Self {
        Self { port }
    }
}

impl FromEnv for MetricsConfig {
    fn inventory() -> Vec<&'static EnvItemInfo> {
        vec![&EnvItemInfo {
            var: METRICS_PORT,
            description: "Port on which to serve metrics, u16, defaults to 9000",
            optional: true,
        }]
    }

    fn from_env() -> Result<Self, FromEnvErr> {
        match u16::from_env_var(METRICS_PORT).map(Self::from) {
            Ok(cfg) => Ok(cfg),
            Err(_) => Ok(Self::default()),
        }
    }
}

/// Initialize a [`metrics_exporter_prometheus`] exporter.
///
/// Reads the `METRICS_PORT` environment variable to determine the port to bind
/// the exporter to. If the variable is missing or unparseable, it defaults to
/// 9000.
///
/// See [`MetricsConfig`] for more information.
///
/// # Panics
///
/// This function will panic if the exporter fails to install, e.g. if the port
/// is in use.
pub fn init_metrics() {
    let cfg = MetricsConfig::from_env().unwrap();
    init_metrics_with_config(cfg)
}

pub(crate) fn init_metrics_with_config(config: MetricsConfig) {
    let address = SocketAddr::from(([0, 0, 0, 0], config.port));

    PrometheusBuilder::new()
        .with_http_listener(address)
        .install()
        .unwrap_or_else(|error| {
            panic!(
                "failed to install prometheus exporter on {address} (configure with {METRICS_PORT} env var): {error}",
            )
        });
}