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 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
use crate::exporter::config::{
build_config_and_process, install_tracer_provider_and_get_tracer, HasRequiredConfig,
TransformationConfig,
};
use crate::exporter::uploader::{AsyncUploader, Uploader};
use crate::{Exporter, JaegerTraceRuntime};
use http::Uri;
use opentelemetry::sdk::trace::BatchConfig;
use opentelemetry::{sdk, sdk::trace::Config as TraceConfig, trace::TraceError};
use std::borrow::BorrowMut;
use std::convert::TryFrom;
use std::env;
use std::sync::Arc;
#[cfg(feature = "collector_client")]
use std::time::Duration;
#[cfg(feature = "collector_client")]
use opentelemetry_http::HttpClient;
#[cfg(feature = "collector_client")]
use crate::config::collector::http_client::CollectorHttpClient;
#[cfg(feature = "collector_client")]
use crate::exporter::collector::AsyncHttpClient;
#[cfg(feature = "wasm_collector_client")]
use crate::exporter::collector::WasmCollector;
#[cfg(feature = "collector_client")]
mod http_client;
/// HTTP endpoint for Jaeger collector.
/// e.g. "http://localhost:14250"
const ENV_ENDPOINT: &str = "OTEL_EXPORTER_JAEGER_ENDPOINT";
const DEFAULT_ENDPOINT: &str = "http://localhost:14250/api/trace";
/// Timeout for Jaeger collector.
#[cfg(feature = "collector_client")]
const ENV_TIMEOUT: &str = "OTEL_EXPORTER_JAEGER_TIMEOUT";
/// Default of 10s
#[cfg(feature = "collector_client")]
const DEFAULT_COLLECTOR_TIMEOUT: Duration = Duration::from_secs(10);
/// Username to send as part of "Basic" authentication to the collector endpoint.
const ENV_USER: &str = "OTEL_EXPORTER_JAEGER_USER";
/// Password to send as part of "Basic" authentication to the collector endpoint.
const ENV_PASSWORD: &str = "OTEL_EXPORTER_JAEGER_PASSWORD";
/// CollectorPipeline config and build a exporter targeting a jaeger collector using HTTP protocol.
///
/// ## Environment variables
///
/// - `OTEL_EXPORTER_JAEGER_ENDPOINT`: set the endpoint of the collector. Usually starts with `http://` or `https://`
///
/// - `OTEL_EXPORTER_JAEGER_TIMEOUT`: set the timeout of the http client timeout. It only applies to build in http clients.
///
/// - `OTEL_EXPORTER_JAEGER_USER`: set the username. Part of the authentication for the collector. It only applies to build in http clients.
///
/// - `OTEL_EXPORTER_JAEGER_PASSWORD`: set the password. Part of the authentication for the collector. It only applies to build in http clients.
///
/// ## Built-in http clients
/// To help user setup the exporter, `opentelemetry-jaeger` provides the following build in http client
/// implementation and relative configurations.
///
/// - [hyper], requires `hyper_collector_client` feature enabled, use [`with_hyper`][CollectorPipeline::with_hyper] function to setup.
/// - [surf], requires `surf_collector_client` feature enabled, use [`with_surf`][CollectorPipeline::with_surf] function to setup.
/// - [isahc], requires `isahc_collector_client` feature enabled, use [`with_isahc`][CollectorPipeline::with_isahc] function to setup.
/// - [reqwest], requires `reqwest_collector_client` feature enabled, use [`with_reqwest`][CollectorPipeline::with_reqwest] function to setup.
/// - [reqwest blocking client], requires `reqwest_blocking_collector_client` feature enabled, use [`with_reqwest_blocking`][CollectorPipeline::with_surf] function to setup.
///
/// Additionally you can enable https
///
/// Note that the functions to setup build in http clients override each other. That means if you have a pipeline with the following setup
///
/// ```no_run
/// # use opentelemetry::trace::TraceError;
/// # #[cfg(all(feature="reqwest_collector_client", feature="surf_collector_client"))]
/// let tracer = opentelemetry_jaeger::new_collector_pipeline()
/// .with_surf()
/// .with_reqwest()
/// .install_batch(opentelemetry::runtime::Tokio)
/// # .unwrap();
/// ```
///
/// The pipeline will use [reqwest] http client.
///
/// [reqwest]: reqwest::Client
/// [reqwest blocking client]: reqwest::blocking::Client
#[derive(Debug)]
pub struct CollectorPipeline {
transformation_config: TransformationConfig,
trace_config: Option<TraceConfig>,
batch_config: Option<BatchConfig>,
#[cfg(feature = "collector_client")]
collector_timeout: Duration,
// only used by builtin http clients.
collector_endpoint: Option<Result<http::Uri, http::uri::InvalidUri>>,
collector_username: Option<String>,
collector_password: Option<String>,
client_config: ClientConfig,
}
impl Default for CollectorPipeline {
fn default() -> Self {
let mut pipeline = Self {
#[cfg(feature = "collector_client")]
collector_timeout: DEFAULT_COLLECTOR_TIMEOUT,
collector_endpoint: None,
collector_username: None,
collector_password: None,
client_config: ClientConfig::default(),
transformation_config: Default::default(),
trace_config: Default::default(),
batch_config: Some(Default::default()),
};
#[cfg(feature = "collector_client")]
if let Some(timeout) = env::var(ENV_TIMEOUT).ok().filter(|var| !var.is_empty()) {
let timeout = match timeout.parse() {
Ok(timeout) => Duration::from_millis(timeout),
Err(e) => {
eprintln!("{} malformed defaulting to 10000: {}", ENV_TIMEOUT, e);
DEFAULT_COLLECTOR_TIMEOUT
}
};
pipeline = pipeline.with_timeout(timeout);
}
if let Some(endpoint) = env::var(ENV_ENDPOINT).ok().filter(|var| !var.is_empty()) {
pipeline = pipeline.with_endpoint(endpoint);
}
if let Some(user) = env::var(ENV_USER).ok().filter(|var| !var.is_empty()) {
pipeline = pipeline.with_username(user);
}
if let Some(password) = env::var(ENV_PASSWORD).ok().filter(|var| !var.is_empty()) {
pipeline = pipeline.with_password(password);
}
pipeline
}
}
// implement the seal trait
impl HasRequiredConfig for CollectorPipeline {
fn set_transformation_config<T>(&mut self, f: T)
where
T: FnOnce(&mut TransformationConfig),
{
f(self.transformation_config.borrow_mut())
}
fn set_trace_config(&mut self, config: TraceConfig) {
self.trace_config = Some(config)
}
fn set_batch_config(&mut self, config: BatchConfig) {
self.batch_config = Some(config)
}
}
#[derive(Debug)]
enum ClientConfig {
#[cfg(feature = "collector_client")]
Http { client_type: CollectorHttpClient },
#[cfg(feature = "wasm_collector_client")]
Wasm, // no config is available for wasm for now. But we can add in the future
}
impl Default for ClientConfig {
fn default() -> Self {
// as long as collector is enabled, we will in favor of it
#[cfg(feature = "collector_client")]
{
ClientConfig::Http {
client_type: CollectorHttpClient::None,
}
}
// when collector_client is disabled and wasm_collector_client is enabled
#[cfg(not(feature = "collector_client"))]
ClientConfig::Wasm
}
}
/// Start a new pipeline to configure a exporter that target a jaeger collector.
///
/// See details for each configurations at [`CollectorPipeline`].
///
/// [`CollectorPipeline`]: crate::config::collector::CollectorPipeline
#[cfg(feature = "collector_client")]
pub fn new_collector_pipeline() -> CollectorPipeline {
CollectorPipeline::default()
}
/// Similar to [`new_collector_pipeline`] but the exporter is configured to run with wasm.
#[cfg(feature = "wasm_collector_client")]
#[allow(clippy::field_reassign_with_default)] // make sure when collector_cilent and wasm_collector_client are both set. We will create a wasm type client
pub fn new_wasm_collector_pipeline() -> CollectorPipeline {
let mut pipeline = CollectorPipeline::default();
pipeline.client_config = ClientConfig::Wasm;
pipeline
}
impl CollectorPipeline {
/// Set the http client timeout.
///
/// This function only applies to build in http clients.
///
/// Default to be 10s.
#[cfg(feature = "collector_client")]
pub fn with_timeout(self, collector_timeout: Duration) -> Self {
Self {
collector_timeout,
..self
}
}
/// Set the collector endpoint.
///
/// E.g. "http://localhost:14268/api/traces"
pub fn with_endpoint<T>(self, collector_endpoint: T) -> Self
where
http::Uri: core::convert::TryFrom<T>,
<http::Uri as core::convert::TryFrom<T>>::Error: Into<http::uri::InvalidUri>,
{
Self {
collector_endpoint: Some(
core::convert::TryFrom::try_from(collector_endpoint).map_err(Into::into),
),
..self
}
}
/// Set the username used in authentication to communicate with the collector.
///
/// *Note* that if the password is not set by calling `with_password` or set `OTEL_EXPORTER_JAEGER_PASSWORD`
/// environment variables. The username will be ignored.
///
/// This function only applies to build in http clients.
pub fn with_username<S: Into<String>>(self, collector_username: S) -> Self {
Self {
collector_username: Some(collector_username.into()),
..self
}
}
/// Set the password used in authentication to communicate with the collector.
///
/// *Note* that if the username is not set by calling `with_username` or set `OTEL_EXPORTER_JAEGER_USER`
/// environment variables. The username will be ignored.
///
/// This function only applies to build in http clients.
pub fn with_password<S: Into<String>>(self, collector_password: S) -> Self {
Self {
collector_password: Some(collector_password.into()),
..self
}
}
/// Get collector's username set in the builder. Default to be the value of
/// `OTEL_EXPORTER_JAEGER_USER` environment variable.
///
/// If users uses custom http client. This function can help retrieve the value of
/// `OTEL_EXPORTER_JAEGER_USER` environment variable.
pub fn collector_username(&self) -> Option<String> {
self.collector_username.clone()
}
/// Get the collector's password set in the builder. Default to be the value of
/// `OTEL_EXPORTER_JAEGER_PASSWORD` environment variable.
///
/// If users uses custom http client. This function can help retrieve the value of
/// `OTEL_EXPORTER_JAEGER_PASSWORD` environment variable.
pub fn collector_password(&self) -> Option<String> {
self.collector_password.clone()
}
/// Custom http client used to send spans.
///
/// **Note** that all configuration other than the [`endpoint`][CollectorPipeline::with_endpoint] are not
/// applicable to custom clients.
#[cfg(feature = "collector_client")]
pub fn with_http_client<T: HttpClient + 'static>(mut self, client: T) -> Self {
self.client_config = match self.client_config {
ClientConfig::Http { .. } => ClientConfig::Http {
client_type: CollectorHttpClient::Custom(Box::new(client)),
},
// noop for wasm
#[cfg(feature = "wasm_collector_client")]
ClientConfig::Wasm => ClientConfig::Wasm,
};
self
}
/// Use isahc http client in the exporter.
#[cfg(feature = "isahc_collector_client")]
pub fn with_isahc(self) -> Self {
Self {
client_config: ClientConfig::Http {
client_type: CollectorHttpClient::Isahc,
},
..self
}
}
/// Use surf http client in the exporter.
#[cfg(feature = "surf_collector_client")]
pub fn with_surf(self) -> Self {
Self {
client_config: ClientConfig::Http {
client_type: CollectorHttpClient::Surf,
},
..self
}
}
/// Use reqwest http client in the exporter.
#[cfg(feature = "reqwest_collector_client")]
pub fn with_reqwest(self) -> Self {
Self {
client_config: ClientConfig::Http {
client_type: CollectorHttpClient::Reqwest,
},
..self
}
}
/// Use reqwest blocking http client in the exporter.
#[cfg(feature = "reqwest_blocking_collector_client")]
pub fn with_reqwest_blocking(self) -> Self {
Self {
client_config: ClientConfig::Http {
client_type: CollectorHttpClient::ReqwestBlocking,
},
..self
}
}
/// Use hyper http client in the exporter.
#[cfg(feature = "hyper_collector_client")]
pub fn with_hyper(self) -> Self {
Self {
client_config: ClientConfig::Http {
client_type: CollectorHttpClient::Hyper,
},
..self
}
}
/// Set the service name of the application. It generally is the name of application.
/// Critically, Jaeger backend depends on `Span.Process.ServiceName` to identify the service
/// that produced the spans.
///
/// Opentelemetry allows set the service name using multiple methods.
/// This functions takes priority over all other methods.
///
/// If the service name is not set. It will default to be `unknown_service`.
pub fn with_service_name<T: Into<String>>(mut self, service_name: T) -> Self {
self.set_transformation_config(|config| {
config.service_name = Some(service_name.into());
});
self
}
/// Config whether to export information of instrumentation library.
///
/// It's required to [report instrumentation library as span tags].
/// However it does have a overhead on performance, performance sensitive applications can
/// use this function to opt out reporting instrumentation library.
///
/// Default to be `true`.
///
/// [report instrumentation library as span tags]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/non-otlp.md#instrumentationscope
pub fn with_instrumentation_library_tags(mut self, should_export: bool) -> Self {
self.set_transformation_config(|config| {
config.export_instrument_library = should_export;
});
self
}
/// Assign the opentelemetry SDK configurations for the exporter pipeline.
///
/// For mapping between opentelemetry configurations and Jaeger spans. Please refer [the spec].
///
/// [the spec]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/jaeger.md#mappings
/// # Examples
/// Set service name via resource.
/// ```rust
/// use opentelemetry::{sdk::{self, Resource}, KeyValue};
///
/// let pipeline = opentelemetry_jaeger::new_collector_pipeline()
/// .with_trace_config(
/// sdk::trace::Config::default()
/// .with_resource(Resource::new(vec![KeyValue::new("service.name", "my-service")]))
/// );
///
/// ```
pub fn with_trace_config(mut self, config: sdk::trace::Config) -> Self {
self.set_trace_config(config);
self
}
/// Assign the batch span processor for the exporter pipeline.
///
/// # Examples
/// Set max queue size.
/// ```rust
/// use opentelemetry::sdk::trace::BatchConfig;
///
/// let pipeline = opentelemetry_jaeger::new_collector_pipeline()
/// .with_batch_processor_config(
/// BatchConfig::default().with_max_queue_size(200)
/// );
///
/// ```
pub fn with_batch_processor_config(mut self, config: BatchConfig) -> Self {
self.set_batch_config(config);
self
}
/// Build a `TracerProvider` using a async exporter and configurations from the pipeline.
///
/// The exporter will collect spans in a batch and send them to the agent.
///
/// It's possible to lose spans up to a batch when the application shuts down. So users should
/// use [`shut_down_tracer_provider`] to block the shut down process until
/// all remaining spans have been sent.
///
/// Commonly used runtime are provided via `rt-tokio`, `rt-tokio-current-thread`, `rt-async-std`
/// features.
///
/// [`shut_down_tracer_provider`]: opentelemetry::global::shutdown_tracer_provider
// todo: we don't need JaegerTraceRuntime, we only need otel runtime
pub fn build_batch<R: JaegerTraceRuntime>(
mut self,
runtime: R,
) -> Result<sdk::trace::TracerProvider, TraceError> {
let mut builder = sdk::trace::TracerProvider::builder();
// build sdk trace config and jaeger process.
// some attributes like service name has attributes like service name
let export_instrument_library = self.transformation_config.export_instrument_library;
let (config, process) = build_config_and_process(
self.trace_config.take(),
self.transformation_config.service_name.take(),
);
let batch_config = self.batch_config.take();
let uploader = self.build_uploader::<R>()?;
let exporter = Exporter::new(process.into(), export_instrument_library, uploader);
let batch_processor = sdk::trace::BatchSpanProcessor::builder(exporter, runtime)
.with_batch_config(batch_config.unwrap_or_default())
.build();
builder = builder.with_span_processor(batch_processor);
builder = builder.with_config(config);
Ok(builder.build())
}
/// Similar to [`build_batch`][CollectorPipeline::build_batch] but also returns a tracer from the
/// tracer provider.
///
/// The tracer name is `opentelemetry-jaeger`. The tracer version will be the version of this crate.
pub fn install_batch<R: JaegerTraceRuntime>(
self,
runtime: R,
) -> Result<sdk::trace::Tracer, TraceError> {
let tracer_provider = self.build_batch(runtime)?;
install_tracer_provider_and_get_tracer(tracer_provider)
}
/// Build an jaeger exporter targeting a jaeger collector.
pub fn build_collector_exporter<R>(mut self) -> Result<crate::Exporter, TraceError>
where
R: JaegerTraceRuntime,
{
let export_instrument_library = self.transformation_config.export_instrument_library;
let (_, process) = build_config_and_process(
self.trace_config.take(),
self.transformation_config.service_name.take(),
);
let uploader = self.build_uploader::<R>()?;
let exporter = Exporter::new(process.into(), export_instrument_library, uploader);
Ok(exporter)
}
fn build_uploader<R>(self) -> Result<Arc<dyn Uploader>, crate::Error>
where
R: JaegerTraceRuntime,
{
let endpoint = self
.collector_endpoint
.transpose()
.map_err::<crate::Error, _>(|err| crate::Error::ConfigError {
pipeline_name: "collector",
config_name: "collector_endpoint",
reason: format!("invalid uri, {}", err),
})?
.unwrap_or_else(|| {
Uri::try_from(DEFAULT_ENDPOINT).unwrap() // default endpoint should always valid
});
match self.client_config {
#[cfg(feature = "collector_client")]
ClientConfig::Http { client_type } => {
let client = client_type.build_client(
self.collector_username,
self.collector_password,
self.collector_timeout,
)?;
let collector = AsyncHttpClient::new(endpoint, client);
Ok(Arc::new(AsyncUploader::<R>::Collector(collector)))
}
#[cfg(feature = "wasm_collector_client")]
ClientConfig::Wasm => {
let collector =
WasmCollector::new(endpoint, self.collector_username, self.collector_password)
.map_err::<crate::Error, _>(Into::into)?;
Ok(Arc::new(AsyncUploader::<R>::WasmCollector(collector)))
}
}
}
}
#[cfg(test)]
#[cfg(feature = "rt-tokio")]
mod tests {
use super::*;
use crate::config::collector::http_client::test_http_client;
use opentelemetry::runtime::Tokio;
#[test]
fn test_collector_defaults() {
// No Env Variable
std::env::remove_var(ENV_TIMEOUT);
let builder = CollectorPipeline::default();
assert_eq!(DEFAULT_COLLECTOR_TIMEOUT, builder.collector_timeout);
// Bad Env Variable
std::env::set_var(ENV_TIMEOUT, "a");
let builder = CollectorPipeline::default();
assert_eq!(DEFAULT_COLLECTOR_TIMEOUT, builder.collector_timeout);
// Good Env Variable
std::env::set_var(ENV_TIMEOUT, "777");
let builder = CollectorPipeline::default();
assert_eq!(Duration::from_millis(777), builder.collector_timeout);
}
#[test]
fn test_set_collector_endpoint() {
let invalid_uri = new_collector_pipeline()
.with_endpoint("127.0.0.1:14268/api/traces")
.with_http_client(test_http_client::TestHttpClient)
.build_uploader::<Tokio>();
assert!(invalid_uri.is_err());
assert_eq!(
format!("{:?}", invalid_uri.err().unwrap()),
"ConfigError { pipeline_name: \"collector\", config_name: \"collector_endpoint\", reason: \"invalid uri, invalid format\" }",
);
let valid_uri = new_collector_pipeline()
.with_http_client(test_http_client::TestHttpClient)
.with_endpoint("http://127.0.0.1:14268/api/traces")
.build_uploader::<Tokio>();
assert!(valid_uri.is_ok());
}
#[test]
fn test_collector_exporter() {
let exporter = new_collector_pipeline()
.with_endpoint("http://127.0.0.1:14268/api/traces")
.with_http_client(test_http_client::TestHttpClient)
.build_collector_exporter::<Tokio>();
assert!(exporter.is_ok());
}
}