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

//! # OpenTelemetry Tracer Provider Interface
//!
//! ### Obtaining a Tracer
//!
//! New `Tracer` instances can be created via a `Provider` and its `get_tracer`
//! method. This method expects an Into<String> argument:
//!
//! - `name` (required): This name must identify the instrumentation library (also
//!   referred to as integration, e.g. `io.opentelemetry.contrib.mongodb`) and *not*
//!   the instrumented library.
//!   In case an invalid name (empty string) is specified, a working
//!   default Tracer implementation as a fallback is returned rather than returning
//!   None or throwing an exception.
//!   A library, implementing the OpenTelemetry API *may* also ignore this name and
//!   return a default instance for all calls, if it does not support "named"
//!   functionality (e.g. an implementation which is not even observability-related).
//!   A Provider could also return a no-op Tracer here if application owners configure
//!   the SDK to suppress telemetry produced by this library.
//!
//! Implementations might require the user to specify configuration properties at
//! `Provider` creation time, or rely on external configuration.
use crate::api;
use std::fmt;

/// An interface to create `Tracer` instances.
pub trait Provider: fmt::Debug + 'static {
    /// The `Tracer` type that this `Provider` will return.
    type Tracer: api::Tracer;

    /// Creates a named tracer instance of `Self::Tracer`.
    /// If the name is an empty string then provider uses default name.
    fn get_tracer(&self, name: &'static str) -> Self::Tracer;
}