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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
use crate::sdk::resource::{EnvResourceDetector, SdkProvidedResourceDetector};
use crate::sdk::trace::runtime::TraceRuntime;
use crate::sdk::Resource;
use crate::trace::TraceResult;
use crate::{
global,
sdk::{self, export::trace::SpanExporter, trace::SpanProcessor},
};
use std::borrow::Cow;
use std::sync::Arc;
use std::time::Duration;
const DEFAULT_COMPONENT_NAME: &str = "rust.opentelemetry.io/sdk/tracer";
#[derive(Debug)]
pub(crate) struct TracerProviderInner {
processors: Vec<Box<dyn SpanProcessor>>,
config: sdk::trace::Config,
}
impl Drop for TracerProviderInner {
fn drop(&mut self) {
for processor in &mut self.processors {
if let Err(err) = processor.shutdown() {
global::handle_error(err);
}
}
}
}
#[derive(Clone, Debug)]
pub struct TracerProvider {
inner: Arc<TracerProviderInner>,
}
impl Default for TracerProvider {
fn default() -> Self {
TracerProvider::builder().build()
}
}
impl TracerProvider {
pub(crate) fn new(inner: Arc<TracerProviderInner>) -> Self {
TracerProvider { inner }
}
pub fn builder() -> Builder {
Builder::default()
}
pub fn span_processors(&self) -> &Vec<Box<dyn SpanProcessor>> {
&self.inner.processors
}
pub fn config(&self) -> &sdk::trace::Config {
&self.inner.config
}
}
impl crate::trace::TracerProvider for TracerProvider {
type Tracer = sdk::trace::Tracer;
fn versioned_tracer(
&self,
name: impl Into<Cow<'static, str>>,
version: Option<&'static str>,
_schema_url: Option<&'static str>,
) -> Self::Tracer {
let name = name.into();
let component_name = if name.is_empty() {
Cow::Borrowed(DEFAULT_COMPONENT_NAME)
} else {
name
};
let instrumentation_lib =
sdk::InstrumentationLibrary::new(component_name, version.map(Into::into));
sdk::trace::Tracer::new(instrumentation_lib, Arc::downgrade(&self.inner))
}
fn force_flush(&self) -> Vec<TraceResult<()>> {
self.span_processors()
.iter()
.map(|processor| processor.force_flush())
.collect()
}
}
#[derive(Debug)]
pub struct Builder {
processors: Vec<Box<dyn SpanProcessor>>,
config: sdk::trace::Config,
sdk_provided_resource: Resource,
}
impl Default for Builder {
fn default() -> Self {
Builder {
processors: Default::default(),
config: Default::default(),
sdk_provided_resource: Resource::from_detectors(
Duration::from_secs(0),
vec![
Box::new(SdkProvidedResourceDetector),
Box::new(EnvResourceDetector::new()),
],
),
}
}
}
impl Builder {
pub fn with_simple_exporter<T: SpanExporter + 'static>(self, exporter: T) -> Self {
let mut processors = self.processors;
processors.push(Box::new(sdk::trace::SimpleSpanProcessor::new(Box::new(
exporter,
))));
Builder { processors, ..self }
}
pub fn with_batch_exporter<T: SpanExporter + 'static, R: TraceRuntime>(
self,
exporter: T,
runtime: R,
) -> Self {
let batch = sdk::trace::BatchSpanProcessor::builder(exporter, runtime).build();
self.with_span_processor(batch)
}
pub fn with_span_processor<T: SpanProcessor + 'static>(self, processor: T) -> Self {
let mut processors = self.processors;
processors.push(Box::new(processor));
Builder { processors, ..self }
}
pub fn with_config(self, config: sdk::trace::Config) -> Self {
Builder { config, ..self }
}
pub fn sdk_provided_resource(&self) -> Resource {
self.sdk_provided_resource.clone()
}
pub fn build(self) -> TracerProvider {
let mut config = self.config;
config.resource = match config.resource {
None => Some(Arc::new(self.sdk_provided_resource)),
Some(resource) => {
if resource.is_empty() {
None
} else {
Some(Arc::new(self.sdk_provided_resource.merge(resource)))
}
}
};
TracerProvider {
inner: Arc::new(TracerProviderInner {
processors: self.processors,
config,
}),
}
}
}
#[cfg(test)]
mod tests {
use crate::sdk::export::trace::SpanData;
use crate::sdk::trace::provider::TracerProviderInner;
use crate::sdk::trace::{Config, Span, SpanProcessor};
use crate::sdk::Resource;
use crate::trace::{TraceError, TraceResult, TracerProvider};
use crate::{Context, Key, KeyValue};
use std::env;
use std::sync::Arc;
#[derive(Debug)]
struct TestSpanProcessor {
success: bool,
}
impl SpanProcessor for TestSpanProcessor {
fn on_start(&self, _span: &mut Span, _cx: &Context) {
unimplemented!()
}
fn on_end(&self, _span: SpanData) {
unimplemented!()
}
fn force_flush(&self) -> TraceResult<()> {
if self.success {
Ok(())
} else {
Err(TraceError::from("cannot export"))
}
}
fn shutdown(&mut self) -> TraceResult<()> {
self.force_flush()
}
}
#[test]
fn test_force_flush() {
let tracer_provider = super::TracerProvider::new(Arc::from(TracerProviderInner {
processors: vec![
Box::from(TestSpanProcessor { success: true }),
Box::from(TestSpanProcessor { success: false }),
],
config: Default::default(),
}));
let results = tracer_provider.force_flush();
assert_eq!(results.len(), 2);
}
#[test]
fn test_tracer_provider_default_resource() {
let assert_service_name = |provider: super::TracerProvider,
expect: Option<&'static str>| {
assert_eq!(
provider.config().resource.as_ref().and_then(|r| r
.get(Key::from_static_str("service.name"))
.map(|v| v.to_string())),
expect.map(|s| s.to_string())
);
};
let default_config_provider = super::TracerProvider::builder().build();
assert_service_name(default_config_provider, Some("unknown_service"));
let custom_config_provider = super::TracerProvider::builder()
.with_config(Config {
resource: Some(Arc::new(Resource::new(vec![KeyValue::new(
"service.name",
"test_service",
)]))),
..Default::default()
})
.build();
assert_service_name(custom_config_provider, Some("test_service"));
env::set_var("OTEL_RESOURCE_ATTRIBUTES", "key1=value1, k2, k3=value2");
let env_resource_provider = super::TracerProvider::builder().build();
assert_eq!(
env_resource_provider.config().resource,
Some(Arc::new(Resource::new(vec![
KeyValue::new("key1", "value1"),
KeyValue::new("k3", "value2"),
KeyValue::new("service.name", "unknown_service"),
])))
);
env::set_var(
"OTEL_RESOURCE_ATTRIBUTES",
"my-custom-key=env-val,k2=value2",
);
let user_provided_resource_config_provider = super::TracerProvider::builder()
.with_config(Config {
resource: Some(Arc::new(Resource::new(vec![KeyValue::new(
"my-custom-key",
"my-custom-value",
)]))),
..Default::default()
})
.build();
assert_eq!(
user_provided_resource_config_provider.config().resource,
Some(Arc::new(Resource::new(vec![
KeyValue::new("my-custom-key", "my-custom-value"),
KeyValue::new("k2", "value2"),
KeyValue::new("service.name", "unknown_service"),
])))
);
env::remove_var("OTEL_RESOURCE_ATTRIBUTES");
let no_service_name = super::TracerProvider::builder()
.with_config(Config {
resource: Some(Arc::new(Resource::empty())),
..Default::default()
})
.build();
assert_service_name(no_service_name, None);
}
}