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

//! Honeycomb OTLP exporter configuration.
//!
//! See [Honeycomb OpenTelemetry](https://docs.honeycomb.io/send-data/opentelemetry/)
//! for details.

use apollo_configuration::configuration;
use apollo_configuration::types::{HeaderValue, Url};
use apollo_redaction::Redacted;

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

/// Honeycomb HTTP exporter configuration.
#[configuration]
pub(crate) struct HoneycombHttpExporterConfig {
    /// Honeycomb API key.
    #[config(required)]
    pub(crate) api_key: Redacted<HeaderValue>,

    /// Honeycomb OTLP endpoint URL.
    ///
    /// See [Honeycomb endpoints](https://docs.honeycomb.io/send-data/opentelemetry/#using-the-honeycomb-opentelemetry-endpoint)
    /// for endpoint URLs by region:
    /// - US: `https://api.honeycomb.io`
    /// - EU: `https://api.eu1.honeycomb.io`
    #[config(required)]
    pub(crate) endpoint: Url,

    /// Dataset name (required for Honeycomb Classic).
    pub(crate) dataset: Option<HeaderValue>,

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

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

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

/// Honeycomb gRPC exporter configuration.
#[configuration]
pub(crate) struct HoneycombGrpcExporterConfig {
    /// Honeycomb API key.
    #[config(required)]
    pub(crate) api_key: Redacted<HeaderValue>,

    /// Honeycomb OTLP endpoint URL.
    ///
    /// See [Honeycomb endpoints](https://docs.honeycomb.io/send-data/opentelemetry/)
    /// for endpoint URLs by region:
    /// - US: `https://api.honeycomb.io:443`
    /// - EU: `https://api.eu1.honeycomb.io:443`
    #[config(required)]
    pub(crate) endpoint: Url,

    /// Dataset name (required for Honeycomb Classic).
    pub(crate) dataset: Option<HeaderValue>,

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

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

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

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

    use crate::config::OpenTelemetryConfig;

    #[test]
    fn parse_honeycomb_http_exporter() {
        let config: OpenTelemetryConfig = parse_yaml(
            indoc::indoc! {"
                tracer_provider:
                  processors:
                    - batch:
                        exporter:
                          honeycomb_http:
                            api_key: test-api-key
                            endpoint: https://api.eu1.honeycomb.io
                            dataset: my-dataset
            "},
            &Default::default(),
        )
        .unwrap();

        assert!(!config.tracer_provider.processors.is_empty());
    }
}