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
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

//! Log record processor configuration.
//!
//! See the [OpenTelemetry Logs SDK specification](https://opentelemetry.io/docs/specs/otel/logs/sdk/)
//! for details on processor behavior and defaults.

use apollo_configuration::configuration;

use crate::config::processor::validate_rate_limited_processor;
use crate::config::{BatchProcessorConfig, LogExporter, RateLimitedProcessorConfig};

/// Log record processor configuration.
#[configuration]
pub(crate) enum LogRecordProcessor {
    /// Batch processor that collects log records and exports them in batches.
    Batch(BatchLogRecordProcessorConfig),
    /// Simple processor that exports each log record immediately.
    Simple(SimpleLogRecordProcessorConfig),
    /// Rate-limited processor that applies rate limiting before batch processing.
    RateLimited(RateLimitedLogRecordProcessorConfig),
}

/// Batch log record processor configuration.
///
/// Batches log records and exports them periodically or when the batch reaches
/// a size threshold. See the [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor)
/// for details (logs follow the same model as traces).
#[configuration]
pub(crate) struct BatchLogRecordProcessorConfig {
    #[config(required)]
    pub(crate) exporter: LogExporter,

    /// Maximum time to wait before exporting a batch (in milliseconds).
    ///
    /// Default: 5000ms per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 5000)]
    pub(crate) schedule_delay: u64,

    /// Maximum time to wait for export to complete (in milliseconds).
    ///
    /// Default: 30000ms per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 30000)]
    pub(crate) export_timeout: u64,

    /// Maximum number of log records per batch.
    ///
    /// Default: 512 per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 512)]
    pub(crate) max_export_batch_size: u32,

    /// Maximum queue size for pending log records.
    ///
    /// Default: 2048 per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 2048)]
    pub(crate) max_queue_size: u32,
}

/// Simple log record processor configuration.
///
/// Exports each log record immediately as it is emitted.
#[configuration]
pub(crate) struct SimpleLogRecordProcessorConfig {
    #[config(required)]
    pub(crate) exporter: LogExporter,
}

/// Rate-limited log record processor configuration.
///
/// Protects against unexpected telemetry costs by enforcing a maximum logs-per-second
/// limit. Logs exceeding the limit are dropped before entering the batch queue,
/// preventing runaway telemetry from infinite loops, retry storms, or load spikes.
///
/// # Observability
///
/// **UNSTABLE:** Metrics follow the [OTel SDK semantic conventions] which are currently
/// in development status. Metric names and attributes may change in future releases.
///
/// **Processor metric:** `otel.sdk.processor.log.processed`
///
/// | Attribute            | Description                                           |
/// |----------------------|-------------------------------------------------------|
/// | `otel.component.type`| `rate_limited_log_processor`                          |
/// | `otel.component.name`| `rate_limited_log_processor/{instance_id}`            |
/// | `error.type`         | `rate_limited` (only present when logs are dropped)   |
///
/// **Exporter metric:** `otel.sdk.exporter.log.exported`
///
/// | Attribute            | Description                                           |
/// |----------------------|-------------------------------------------------------|
/// | `otel.component.type`| `{exporter}_exporter` (e.g., `otlp_http_exporter`)    |
/// | `otel.component.name`| `{exporter}_exporter/{instance_id}`                   |
/// | `server.address`     | Destination host (e.g., `localhost`)                  |
/// | `server.port`        | Destination port (e.g., `4318`)                       |
/// | `error.type`         | `export_failed` (only present on failure)             |
///
/// The processor and exporter share the same `{instance_id}` so you can correlate
/// rate-limited drops with export failures for the same pipeline.
///
/// Use these metrics to:
/// - Alert when processor drops exceed a threshold (rate limit too low)
/// - Monitor exporter failures and retries
/// - Calculate drop rates by comparing records with/without `error.type`
///
/// [OTel SDK semantic conventions]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/otel/sdk-metrics.md
///
/// # Configuration
///
/// Batch parameters use SDK defaults. If `max_rate` exceeds the batch processor's
/// throughput (`max_export_batch_size / schedule_delay`), validation will fail with
/// suggestions for how to adjust the configuration.
#[configuration(validate = validate_rate_limited_processor)]
pub(crate) struct RateLimitedLogRecordProcessorConfig {
    #[config(required)]
    pub(crate) exporter: LogExporter,

    /// Maximum log records per second.
    ///
    /// Default: 100 per second.
    #[config(default = 100)]
    pub(crate) max_rate: u32,

    /// Maximum time to wait before exporting a batch (in milliseconds).
    ///
    /// Default: 5000ms per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 5000)]
    pub(crate) schedule_delay: u64,

    /// Maximum time to wait for export to complete (in milliseconds).
    ///
    /// Default: 30000ms per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 30000)]
    pub(crate) export_timeout: u64,

    /// Maximum number of log records per batch.
    ///
    /// Default: 512 per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 512)]
    pub(crate) max_export_batch_size: u32,

    /// Maximum queue size for pending log records.
    ///
    /// Default: 2048 per [SDK specification](https://opentelemetry.io/docs/specs/otel/trace/sdk/#batching-processor).
    #[config(default = 2048)]
    pub(crate) max_queue_size: u32,
}

impl BatchProcessorConfig for BatchLogRecordProcessorConfig {
    fn schedule_delay(&self) -> u64 {
        self.schedule_delay
    }

    fn export_timeout(&self) -> u64 {
        self.export_timeout
    }

    fn max_export_batch_size(&self) -> u32 {
        self.max_export_batch_size
    }

    fn max_queue_size(&self) -> u32 {
        self.max_queue_size
    }
}

impl BatchProcessorConfig for RateLimitedLogRecordProcessorConfig {
    fn schedule_delay(&self) -> u64 {
        self.schedule_delay
    }

    fn export_timeout(&self) -> u64 {
        self.export_timeout
    }

    fn max_export_batch_size(&self) -> u32 {
        self.max_export_batch_size
    }

    fn max_queue_size(&self) -> u32 {
        self.max_queue_size
    }
}

impl RateLimitedProcessorConfig for RateLimitedLogRecordProcessorConfig {
    fn max_rate(&self) -> u32 {
        self.max_rate
    }
}

/// Log record limits configuration.
///
/// See the [attribute limits specification](https://opentelemetry.io/docs/specs/otel/common/#attribute-limits)
/// for details on limit behavior.
#[configuration]
pub(crate) struct LogRecordLimitsConfig {
    /// Maximum number of attributes per log record.
    ///
    /// Default: 128 per [attribute limits specification](https://opentelemetry.io/docs/specs/otel/common/#attribute-limits).
    #[config(default = 128)]
    pub(crate) attribute_count_limit: u32,

    /// Maximum length of string attribute values. No limit by default.
    ///
    /// Per the [attribute limits specification](https://opentelemetry.io/docs/specs/otel/common/#attribute-limits),
    /// there is no default length limit.
    pub(crate) attribute_value_length_limit: Option<u32>,
}