datadog-opentelemetry 0.4.0

A Datadog layer of compatibility for the opentelemetry SDK
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

// Copyright 2025-Present Datadog, Inc. https://www.datadoghq.com/
// SPDX-License-Identifier: Apache-2.0

/// This file is generated by the scripts/local_config_map_generate.py script.
/// Do not edit this file manually. To add a new configuration,
/// add it to the supported-configurations.json file, then run this script.
#[allow(nonstandard_style)]
#[derive(Debug, PartialEq, Copy, Clone)]
#[non_exhaustive]
pub(crate) enum SupportedConfigurations {
    DD_AGENT_HOST,
    DD_DOGSTATSD_HOST,
    DD_DOGSTATSD_PORT,
    DD_DOGSTATSD_URL,
    DD_ENV,
    DD_INSTRUMENTATION_TELEMETRY_ENABLED,
    DD_LOGS_OTEL_ENABLED,
    DD_LOG_LEVEL,
    DD_METRICS_OTEL_ENABLED,
    DD_REMOTE_CONFIGURATION_ENABLED,
    DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS,
    DD_SERVICE,
    DD_TAGS,
    DD_TELEMETRY_HEARTBEAT_INTERVAL,
    DD_TELEMETRY_LOG_COLLECTION_ENABLED,
    DD_TRACE_AGENT_PORT,
    DD_TRACE_AGENT_URL,
    DD_TRACE_BAGGAGE_TAG_KEYS,
    DD_TRACE_ENABLED,
    DD_TRACE_PARTIAL_FLUSH_ENABLED,
    DD_TRACE_PARTIAL_FLUSH_MIN_SPANS,
    DD_TRACE_PROPAGATION_EXTRACT_FIRST,
    DD_TRACE_PROPAGATION_STYLE,
    DD_TRACE_PROPAGATION_STYLE_EXTRACT,
    DD_TRACE_PROPAGATION_STYLE_INJECT,
    DD_TRACE_RATE_LIMIT,
    DD_TRACE_SAMPLE_RATE,
    DD_TRACE_SAMPLING_RULES,
    DD_TRACE_STATS_COMPUTATION_ENABLED,
    DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH,
    DD_VERSION,
    OTEL_EXPORTER_OTLP_ENDPOINT,
    OTEL_EXPORTER_OTLP_HEADERS,
    OTEL_EXPORTER_OTLP_LOGS_ENDPOINT,
    OTEL_EXPORTER_OTLP_LOGS_HEADERS,
    OTEL_EXPORTER_OTLP_LOGS_PROTOCOL,
    OTEL_EXPORTER_OTLP_LOGS_TIMEOUT,
    OTEL_EXPORTER_OTLP_METRICS_ENDPOINT,
    OTEL_EXPORTER_OTLP_METRICS_HEADERS,
    OTEL_EXPORTER_OTLP_METRICS_PROTOCOL,
    OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE,
    OTEL_EXPORTER_OTLP_METRICS_TIMEOUT,
    OTEL_EXPORTER_OTLP_PROTOCOL,
    OTEL_EXPORTER_OTLP_TIMEOUT,
    OTEL_LOGS_EXPORTER,
    OTEL_METRICS_EXPORTER,
    OTEL_METRIC_EXPORT_INTERVAL,
    OTEL_METRIC_EXPORT_TIMEOUT,
    OTEL_RESOURCE_ATTRIBUTES,
    _DD_TRACE_STATS_COMPUTATION_EXPERIMENTAL_CLIENT_OBFUSCATION_ENABLED,

    /// Used for testing purposes only
    #[cfg(test)]
    #[allow(unused)]
    DD_COMPLEX_STRUCT,
    #[cfg(test)]
    #[allow(unused)]
    DD_NONEXISTANT_CONFIGURATION,
    #[cfg(test)]
    #[allow(unused)]
    DD_NONEXISTANT_CONFIGURATION_ALIAS,
    #[cfg(test)]
    #[allow(unused)]
    DD_NONEXISTANT_CONFIGURATION_DEPRECATED,
}

impl SupportedConfigurations {
    pub fn as_str(&self) -> &'static str {
        match self {
            SupportedConfigurations::DD_AGENT_HOST => "DD_AGENT_HOST",
            SupportedConfigurations::DD_DOGSTATSD_HOST => "DD_DOGSTATSD_HOST",
            SupportedConfigurations::DD_DOGSTATSD_PORT => "DD_DOGSTATSD_PORT",
            SupportedConfigurations::DD_DOGSTATSD_URL => "DD_DOGSTATSD_URL",
            SupportedConfigurations::DD_ENV => "DD_ENV",
            SupportedConfigurations::DD_INSTRUMENTATION_TELEMETRY_ENABLED => "DD_INSTRUMENTATION_TELEMETRY_ENABLED",
            SupportedConfigurations::DD_LOGS_OTEL_ENABLED => "DD_LOGS_OTEL_ENABLED",
            SupportedConfigurations::DD_LOG_LEVEL => "DD_LOG_LEVEL",
            SupportedConfigurations::DD_METRICS_OTEL_ENABLED => "DD_METRICS_OTEL_ENABLED",
            SupportedConfigurations::DD_REMOTE_CONFIGURATION_ENABLED => "DD_REMOTE_CONFIGURATION_ENABLED",
            SupportedConfigurations::DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS => "DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS",
            SupportedConfigurations::DD_SERVICE => "DD_SERVICE",
            SupportedConfigurations::DD_TAGS => "DD_TAGS",
            SupportedConfigurations::DD_TELEMETRY_HEARTBEAT_INTERVAL => "DD_TELEMETRY_HEARTBEAT_INTERVAL",
            SupportedConfigurations::DD_TELEMETRY_LOG_COLLECTION_ENABLED => "DD_TELEMETRY_LOG_COLLECTION_ENABLED",
            SupportedConfigurations::DD_TRACE_AGENT_PORT => "DD_TRACE_AGENT_PORT",
            SupportedConfigurations::DD_TRACE_AGENT_URL => "DD_TRACE_AGENT_URL",
            SupportedConfigurations::DD_TRACE_BAGGAGE_TAG_KEYS => "DD_TRACE_BAGGAGE_TAG_KEYS",
            SupportedConfigurations::DD_TRACE_ENABLED => "DD_TRACE_ENABLED",
            SupportedConfigurations::DD_TRACE_PARTIAL_FLUSH_ENABLED => "DD_TRACE_PARTIAL_FLUSH_ENABLED",
            SupportedConfigurations::DD_TRACE_PARTIAL_FLUSH_MIN_SPANS => "DD_TRACE_PARTIAL_FLUSH_MIN_SPANS",
            SupportedConfigurations::DD_TRACE_PROPAGATION_EXTRACT_FIRST => "DD_TRACE_PROPAGATION_EXTRACT_FIRST",
            SupportedConfigurations::DD_TRACE_PROPAGATION_STYLE => "DD_TRACE_PROPAGATION_STYLE",
            SupportedConfigurations::DD_TRACE_PROPAGATION_STYLE_EXTRACT => "DD_TRACE_PROPAGATION_STYLE_EXTRACT",
            SupportedConfigurations::DD_TRACE_PROPAGATION_STYLE_INJECT => "DD_TRACE_PROPAGATION_STYLE_INJECT",
            SupportedConfigurations::DD_TRACE_RATE_LIMIT => "DD_TRACE_RATE_LIMIT",
            SupportedConfigurations::DD_TRACE_SAMPLE_RATE => "DD_TRACE_SAMPLE_RATE",
            SupportedConfigurations::DD_TRACE_SAMPLING_RULES => "DD_TRACE_SAMPLING_RULES",
            SupportedConfigurations::DD_TRACE_STATS_COMPUTATION_ENABLED => "DD_TRACE_STATS_COMPUTATION_ENABLED",
            SupportedConfigurations::DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH => "DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH",
            SupportedConfigurations::DD_VERSION => "DD_VERSION",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_ENDPOINT => "OTEL_EXPORTER_OTLP_ENDPOINT",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_HEADERS => "OTEL_EXPORTER_OTLP_HEADERS",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_LOGS_ENDPOINT => "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_LOGS_HEADERS => "OTEL_EXPORTER_OTLP_LOGS_HEADERS",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_LOGS_PROTOCOL => "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_LOGS_TIMEOUT => "OTEL_EXPORTER_OTLP_LOGS_TIMEOUT",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_METRICS_ENDPOINT => "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_METRICS_HEADERS => "OTEL_EXPORTER_OTLP_METRICS_HEADERS",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_METRICS_PROTOCOL => "OTEL_EXPORTER_OTLP_METRICS_PROTOCOL",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE => "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_METRICS_TIMEOUT => "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_PROTOCOL => "OTEL_EXPORTER_OTLP_PROTOCOL",
            SupportedConfigurations::OTEL_EXPORTER_OTLP_TIMEOUT => "OTEL_EXPORTER_OTLP_TIMEOUT",
            SupportedConfigurations::OTEL_LOGS_EXPORTER => "OTEL_LOGS_EXPORTER",
            SupportedConfigurations::OTEL_METRICS_EXPORTER => "OTEL_METRICS_EXPORTER",
            SupportedConfigurations::OTEL_METRIC_EXPORT_INTERVAL => "OTEL_METRIC_EXPORT_INTERVAL",
            SupportedConfigurations::OTEL_METRIC_EXPORT_TIMEOUT => "OTEL_METRIC_EXPORT_TIMEOUT",
            SupportedConfigurations::OTEL_RESOURCE_ATTRIBUTES => "OTEL_RESOURCE_ATTRIBUTES",
            SupportedConfigurations::_DD_TRACE_STATS_COMPUTATION_EXPERIMENTAL_CLIENT_OBFUSCATION_ENABLED => "_DD_TRACE_STATS_COMPUTATION_EXPERIMENTAL_CLIENT_OBFUSCATION_ENABLED",
            #[cfg(test)]
            SupportedConfigurations::DD_COMPLEX_STRUCT => "DD_COMPLEX_STRUCT",
            #[cfg(test)]
            SupportedConfigurations::DD_NONEXISTANT_CONFIGURATION => "DD_NONEXISTANT_CONFIGURATION",
            #[cfg(test)]
            SupportedConfigurations::DD_NONEXISTANT_CONFIGURATION_ALIAS => "DD_NONEXISTANT_CONFIGURATION_ALIAS",
            #[cfg(test)]
            SupportedConfigurations::DD_NONEXISTANT_CONFIGURATION_DEPRECATED => "DD_NONEXISTANT_CONFIGURATION_DEPRECATED",
        }
    }

    pub fn aliases(&self) -> &[&'static str] {
        match self {
            SupportedConfigurations::DD_REMOTE_CONFIGURATION_ENABLED => {
                &["DD_REMOTE_CONFIG_ENABLED"]
            }
            #[cfg(test)]
            SupportedConfigurations::DD_NONEXISTANT_CONFIGURATION => &[
                "DD_NONEXISTANT_CONFIGURATION_ALIAS",
                "DD_NONEXISTANT_CONFIGURATION_DEPRECATED_ALIAS",
            ],
            _ => &[],
        }
    }

    pub fn is_deprecated(&self) -> bool {
        match self {
            #[cfg(test)]
            SupportedConfigurations::DD_NONEXISTANT_CONFIGURATION_DEPRECATED => true,
            _ => false,
        }
    }

    /// Whether this configuration's value is excluded from configuration telemetry.
    pub fn is_sensitive(&self) -> bool {
        matches!(
            self,
            SupportedConfigurations::OTEL_EXPORTER_OTLP_HEADERS
                | SupportedConfigurations::OTEL_EXPORTER_OTLP_LOGS_HEADERS
                | SupportedConfigurations::OTEL_EXPORTER_OTLP_METRICS_HEADERS
        )
    }
}

pub(crate) fn is_alias_deprecated(name: &str) -> bool {
    match name {
        "DD_REMOTE_CONFIG_ENABLED" => true,
        #[cfg(test)]
        "DD_NONEXISTANT_CONFIGURATION_DEPRECATED_ALIAS" => true,
        _ => false,
    }
}