forked from open-telemetry/opentelemetry-rust
-
Notifications
You must be signed in to change notification settings - Fork 1
/
provider.rs
200 lines (171 loc) · 5.78 KB
/
provider.rs
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
//! # Trace Provider SDK
//!
//! ## Tracer Creation
//!
//! New `Tracer` instances are always created through a `TracerProvider`.
//!
//! All configuration objects and extension points (span processors,
//! propagators) are provided by the `TracerProvider`. `Tracer` instances do
//! not duplicate this data to avoid that different `Tracer` instances
//! of the `TracerProvider` have different versions of these data.
use crate::trace::TraceResult;
use crate::{
global,
runtime::Runtime,
sdk::{self, export::trace::SpanExporter, trace::SpanProcessor},
};
use std::sync::Arc;
/// Default tracer name if empty string is provided.
const DEFAULT_COMPONENT_NAME: &str = "rust.opentelemetry.io/sdk/tracer";
/// TracerProvider inner type
#[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);
}
}
}
}
/// Creator and registry of named `Tracer` instances.
#[derive(Clone, Debug)]
pub struct TracerProvider {
inner: Arc<TracerProviderInner>,
}
impl Default for TracerProvider {
fn default() -> Self {
TracerProvider::builder().build()
}
}
impl TracerProvider {
/// Build a new tracer provider
pub(crate) fn new(inner: Arc<TracerProviderInner>) -> Self {
TracerProvider { inner }
}
/// Create a new `TracerProvider` builder.
pub fn builder() -> Builder {
Builder::default()
}
/// Span processors associated with this provider
pub fn span_processors(&self) -> &Vec<Box<dyn SpanProcessor>> {
&self.inner.processors
}
/// Config associated with this tracer
pub fn config(&self) -> &sdk::trace::Config {
&self.inner.config
}
}
impl crate::trace::TracerProvider for TracerProvider {
/// This implementation of `TracerProvider` produces `Tracer` instances.
type Tracer = sdk::trace::Tracer;
/// Find or create `Tracer` instance by name.
fn get_tracer(&self, name: &'static str, version: Option<&'static str>) -> Self::Tracer {
// Use default value if name is invalid empty string
let component_name = if name.is_empty() {
DEFAULT_COMPONENT_NAME
} else {
name
};
let instrumentation_lib = sdk::InstrumentationLibrary::new(component_name, version);
sdk::trace::Tracer::new(instrumentation_lib, Arc::downgrade(&self.inner))
}
/// Force flush all remaining spans in span processors and return results.
fn force_flush(&self) -> Vec<TraceResult<()>> {
self.span_processors()
.iter()
.map(|processor| processor.force_flush())
.collect()
}
}
/// Builder for provider attributes.
#[derive(Default, Debug)]
pub struct Builder {
processors: Vec<Box<dyn SpanProcessor>>,
config: sdk::trace::Config,
}
impl Builder {
/// The `SpanExporter` that this provider should use.
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 }
}
/// The `SpanExporter` setup using a default `BatchSpanProcessor` that this provider should use.
pub fn with_batch_exporter<T: SpanExporter + 'static, R: Runtime>(
self,
exporter: T,
runtime: R,
) -> Self {
let batch = sdk::trace::BatchSpanProcessor::builder(exporter, runtime).build();
self.with_span_processor(batch)
}
/// The `SpanProcessor` that this provider should use.
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 }
}
/// The sdk `Config` that this provider will use.
pub fn with_config(self, config: sdk::trace::Config) -> Self {
Builder { config, ..self }
}
/// Create a new provider from this configuration.
pub fn build(self) -> TracerProvider {
TracerProvider {
inner: Arc::new(TracerProviderInner {
processors: self.processors,
config: self.config,
}),
}
}
}
#[cfg(test)]
mod tests {
use crate::sdk::export::trace::SpanData;
use crate::sdk::trace::provider::TracerProviderInner;
use crate::sdk::trace::{Span, SpanProcessor};
use crate::trace::{TraceError, TraceResult, TracerProvider};
use crate::Context;
use std::sync::Arc;
#[derive(Debug)]
struct TestSpanProcessor {
success: bool,
}
impl SpanProcessor for TestSpanProcessor {
fn on_start(&self, _span: &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);
}
}