atomr-telemetry 0.3.1

Tracing, metrics, and exporter probes for atomr — actors, dead letters, cluster, sharding, persistence, remote, streams, and distributed data.
Documentation 
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
90
91
92
93
94
95
96
97
98

//! Runtime configuration for exporters. Safe to parse even when the
//! corresponding exporter cargo features are disabled — applying an
//! unknown exporter returns an error rather than panicking.

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ExportersConfig {
    #[serde(default)]
    pub prometheus: Option<PrometheusConfig>,
    #[serde(default)]
    pub otlp: Option<OtlpConfig>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PrometheusConfig {
    #[serde(default)]
    pub namespace: Option<String>,
    #[serde(default = "default_true")]
    pub enabled: bool,
}

fn default_true() -> bool {
    true
}

impl Default for PrometheusConfig {
    fn default() -> Self {
        Self { namespace: None, enabled: true }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OtlpConfig {
    #[serde(default = "default_true")]
    pub enabled: bool,
    /// OTLP collector endpoint (e.g. `http://localhost:4317` for gRPC or
    /// `http://localhost:4318` for HTTP).
    pub endpoint: String,
    /// Transport protocol: `grpc` or `http`.
    #[serde(default = "default_protocol")]
    pub protocol: String,
    /// Service name attached as the `service.name` resource attribute.
    #[serde(default)]
    pub service_name: Option<String>,
    /// Metric push interval in seconds.
    #[serde(default = "default_interval")]
    pub interval_secs: u64,
    /// Optional headers (e.g. auth tokens).
    #[serde(default)]
    pub headers: std::collections::HashMap<String, String>,
    /// Extra resource attributes beyond `service.name`.
    #[serde(default)]
    pub resource_attributes: std::collections::HashMap<String, String>,
    /// Emit traces (spans) in addition to metrics.
    #[serde(default = "default_true")]
    pub traces: bool,
    /// Use the stdout exporter instead of OTLP. Useful for dev/tests.
    #[serde(default)]
    pub stdout: bool,
}

fn default_protocol() -> String {
    "grpc".into()
}

fn default_interval() -> u64 {
    30
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parses_full_config_from_toml() {
        let toml = r#"
            [prometheus]
            namespace = "atomr"

            [otlp]
            endpoint = "http://collector:4317"
            protocol = "grpc"
            service_name = "my-service"
            interval_secs = 15
            stdout = false

            [otlp.headers]
            authorization = "Bearer x"
        "#;
        let parsed: ExportersConfig = toml::from_str(toml).unwrap();
        assert_eq!(parsed.prometheus.unwrap().namespace.unwrap(), "atomr");
        let otlp = parsed.otlp.unwrap();
        assert_eq!(otlp.endpoint, "http://collector:4317");
        assert_eq!(otlp.protocol, "grpc");
        assert_eq!(otlp.headers.get("authorization").unwrap(), "Bearer x");
    }
}