klauthed-observability 0.7.0

Observability for klauthed: tracing spans, metrics, and OpenTelemetry wiring.
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

//! The top-level [`TelemetryConfig`].

use klauthed_core::config::Profile;
use serde::{Deserialize, Serialize};

use super::{LogConfig, LogFormat, MetricsConfig, OtelConfig};

/// Top-level telemetry settings for a service.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TelemetryConfig {
    /// Service name reported in logs, metrics, and traces.
    #[serde(default = "default_service_name")]
    pub service_name: String,
    /// Logging / tracing-subscriber settings.
    #[serde(default)]
    pub log: LogConfig,
    /// Prometheus metrics settings.
    #[serde(default)]
    pub metrics: MetricsConfig,
    /// OpenTelemetry (OTLP) trace export settings.
    #[serde(default)]
    pub otel: OtelConfig,
}

fn default_service_name() -> String {
    "service".to_owned()
}

impl Default for TelemetryConfig {
    fn default() -> Self {
        Self {
            service_name: default_service_name(),
            log: LogConfig::default(),
            metrics: MetricsConfig::default(),
            otel: OtelConfig::default(),
        }
    }
}

impl TelemetryConfig {
    /// A config for `service_name` with profile-appropriate defaults: human
    /// `Pretty` logs on local/dev/test, structured `Json` logs on staging/prod.
    pub fn for_profile(profile: &Profile, service_name: impl Into<String>) -> Self {
        let format = if profile.requires_vault() { LogFormat::Json } else { LogFormat::Pretty };
        Self {
            service_name: service_name.into(),
            log: LogConfig { format, ..LogConfig::default() },
            ..Self::default()
        }
    }
}

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

    #[test]
    fn defaults_are_sensible() {
        let cfg = TelemetryConfig::default();
        assert_eq!(cfg.service_name, "service");
        assert_eq!(cfg.log.format, LogFormat::Pretty);
        assert_eq!(cfg.log.level, "info");
        assert!(!cfg.metrics.enabled);
        assert!(!cfg.otel.enabled);
        assert_eq!(cfg.otel.endpoint, "http://localhost:4318");
    }

    #[test]
    fn profile_selects_log_format() {
        assert_eq!(
            TelemetryConfig::for_profile(&Profile::Local, "svc").log.format,
            LogFormat::Pretty
        );
        assert_eq!(TelemetryConfig::for_profile(&Profile::Prod, "svc").log.format, LogFormat::Json);
    }

    #[test]
    fn deserializes_partial_config() {
        let cfg: TelemetryConfig = serde_json::from_value(json!({
            "service_name": "api",
            "log": { "format": "json", "level": "debug" },
            "otel": { "enabled": true }
        }))
        .unwrap();
        assert_eq!(cfg.service_name, "api");
        assert_eq!(cfg.log.format, LogFormat::Json);
        assert_eq!(cfg.log.level, "debug");
        assert!(cfg.otel.enabled);
        assert!(cfg.log.ansi); // default preserved
    }
}