apollo-opentelemetry 0.8.0

OpenTelemetry configuration types for Apollo platform
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

//! Grafana Cloud OTLP exporter configuration.
//!
//! See [Grafana Cloud OTLP](https://grafana.com/docs/grafana-cloud/send-data/otlp/)
//! for details.

use apollo_configuration::configuration;
use apollo_configuration::types::Url;
use apollo_redaction::Redacted;

use super::otlp::{Compression, TlsConfig};

/// Grafana Cloud OTLP exporter configuration.
///
/// Uses Basic authentication with instance ID and API key.
#[configuration]
pub(crate) struct GrafanaCloudHttpExporterConfig {
    /// Grafana Cloud instance ID.
    #[config(required)]
    pub(crate) instance_id: String,

    /// Grafana Cloud API key (typically starts with `glc_...`).
    #[config(required)]
    pub(crate) api_key: Redacted<String>,

    /// Grafana Cloud OTLP endpoint URL.
    ///
    /// See [Grafana Cloud OTLP endpoint](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#manual-opentelemetry-setup-for-advanced-users)
    /// for endpoint URL format: `https://otlp-gateway-{zone}.grafana.net/otlp`
    ///
    /// Common zones: `prod-us-central-0`, `prod-eu-west-0`, `prod-ap-southeast-0`
    #[config(required)]
    pub(crate) endpoint: Url,

    /// Compression algorithm.
    pub(crate) compression: Compression,

    /// Export timeout in milliseconds.
    #[config(default = 10000)]
    pub(crate) timeout: u64,

    /// TLS configuration.
    pub(crate) tls: Option<TlsConfig>,
}

impl GrafanaCloudHttpExporterConfig {
    /// Returns the Basic auth header value.
    ///
    /// See [Grafana Cloud authentication](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#manual-opentelemetry-setup-for-advanced-users).
    pub(crate) fn auth_header(&self) -> String {
        use base64::Engine;
        let credentials = format!("{}:{}", self.instance_id, self.api_key.unredact());
        format!(
            "Basic {}",
            base64::engine::general_purpose::STANDARD.encode(credentials)
        )
    }
}

#[cfg(test)]
mod tests {
    use apollo_configuration::parse_yaml;

    use super::*;
    use crate::config::OpenTelemetryConfig;
    use crate::config::SpanExporter;
    use crate::config::traces::SpanProcessor;

    fn get_grafana_config(config: &OpenTelemetryConfig) -> &GrafanaCloudHttpExporterConfig {
        match &config.tracer_provider.processors[0] {
            SpanProcessor::Batch(batch) => match &batch.exporter {
                SpanExporter::GrafanaCloud(gc) => gc,
                _ => panic!("Expected GrafanaCloud exporter"),
            },
            _ => panic!("Expected Batch processor"),
        }
    }

    #[test]
    fn parse_grafana_cloud_exporter() {
        let config: OpenTelemetryConfig = parse_yaml(
            indoc::indoc! {"
                tracer_provider:
                  processors:
                    - batch:
                        exporter:
                          grafana_cloud:
                            instance_id: '123456'
                            api_key: glc_test_key
                            endpoint: https://otlp-gateway-prod-us-central-0.grafana.net/otlp
            "},
            &Default::default(),
        )
        .unwrap();

        let gc = get_grafana_config(&config);
        assert_eq!(
            gc.endpoint.as_str(),
            "https://otlp-gateway-prod-us-central-0.grafana.net/otlp"
        );
    }

    #[test]
    fn auth_header_basic_encoding() {
        let config: OpenTelemetryConfig = parse_yaml(
            indoc::indoc! {"
                tracer_provider:
                  processors:
                    - batch:
                        exporter:
                          grafana_cloud:
                            instance_id: '123456'
                            api_key: glc_test_key
                            endpoint: https://otlp-gateway-prod-us-central-0.grafana.net/otlp
            "},
            &Default::default(),
        )
        .unwrap();

        let gc = get_grafana_config(&config);
        let auth = gc.auth_header();

        assert!(auth.starts_with("Basic "));
        // Decode and verify: "123456:glc_test_key" -> base64
        use base64::Engine;
        let encoded = auth.strip_prefix("Basic ").unwrap();
        let decoded = base64::engine::general_purpose::STANDARD
            .decode(encoded)
            .unwrap();
        let credentials = String::from_utf8(decoded).unwrap();
        assert_eq!(credentials, "123456:glc_test_key");
    }
}