HttpTracerProviderBuilder

Struct HttpTracerProviderBuilder 

Source
pub struct HttpTracerProviderBuilder<C: HttpClient = StdoutClient, I: IdGenerator = RandomIdGenerator, P: TextMapPropagator = TraceContextPropagator> { /* private fields */ }
Expand description

A type-safe builder for configuring and initializing a TracerProvider.

Implementations§

Source§

impl<C, I, P> HttpTracerProviderBuilder<C, I, P>
where C: HttpClient + 'static, I: IdGenerator + Send + Sync + 'static, P: TextMapPropagator + Send + Sync + 'static,

Source

pub fn new() -> HttpTracerProviderBuilder<StdoutClient, RandomIdGenerator, TraceContextPropagator>

Creates a new HttpTracerProviderBuilder with default settings.

The default exporter type is determined by the LAMBDA_OTEL_SPAN_PROCESSOR environment variable:

  • “batch” - Uses batch span processor
  • “simple” - Uses simple span processor (default)
  • Any other value will default to simple span processor with a warning
§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;
use otlp_stdout_client::StdoutClient;
use opentelemetry_sdk::propagation::TraceContextPropagator;
use opentelemetry_sdk::trace::RandomIdGenerator;

let builder = HttpTracerProviderBuilder::default();
Source

pub fn with_stdout_client(self) -> HttpTracerProviderBuilder<StdoutClient, I, P>

Configures the builder to use a stdout client for exporting traces.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .with_stdout_client();
Source

pub fn with_http_client<NewC>( self, client: NewC, ) -> HttpTracerProviderBuilder<NewC, I, P>
where NewC: HttpClient + 'static,

Sets a custom HTTP client for exporting traces.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;
use reqwest::Client;
use opentelemetry_sdk::propagation::TraceContextPropagator;
use opentelemetry_sdk::trace::RandomIdGenerator;

let client = Client::new();
let builder = HttpTracerProviderBuilder::default()
    .with_http_client(client);
Source

pub fn with_text_map_propagator<NewP>( self, propagator: NewP, ) -> HttpTracerProviderBuilder<C, I, NewP>
where NewP: TextMapPropagator + Send + Sync + 'static,

Adds a custom text map propagator.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;
use opentelemetry_sdk::propagation::TraceContextPropagator;

let builder = HttpTracerProviderBuilder::default()
    .with_text_map_propagator(TraceContextPropagator::new());
Source

pub fn with_default_text_map_propagator(self) -> Self

Adds the default text map propagator (TraceContextPropagator).

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .with_default_text_map_propagator();
Source

pub fn with_xray_text_map_propagator(self) -> Self

Adds the XRay text map propagator.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .with_xray_text_map_propagator();
Source

pub fn with_id_generator<NewI>( self, id_generator: NewI, ) -> HttpTracerProviderBuilder<C, NewI, P>
where NewI: IdGenerator + Send + Sync + 'static,

Sets a custom ID generator.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;
use opentelemetry_sdk::trace::RandomIdGenerator;

let builder = HttpTracerProviderBuilder::default()
    .with_id_generator(RandomIdGenerator::default());
Source

pub fn with_default_id_generator( self, ) -> HttpTracerProviderBuilder<C, RandomIdGenerator, P>

Sets the default ID generator (RandomIdGenerator).

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .with_default_id_generator();
Source

pub fn with_xray_id_generator( self, ) -> HttpTracerProviderBuilder<C, XrayIdGenerator, P>

Sets the XRay ID generator.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .with_xray_id_generator();
Source

pub fn with_simple_exporter(self) -> Self

Configures the builder to use a simple exporter.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .with_simple_exporter();
Source

pub fn with_batch_exporter(self) -> Self

Configures the builder to use a batch exporter.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .with_batch_exporter();
Source

pub fn enable_global(self, set_global: bool) -> Self

Enables or disables global installation of the tracer provider.

§Examples
use lambda_otel_utils::HttpTracerProviderBuilder;

let builder = HttpTracerProviderBuilder::default()
    .enable_global(true);
Source

pub fn build(self) -> Result<SdkTracerProvider, BuilderError>

Builds the TracerProvider with the configured settings.

§Errors

Returns a BuilderError if the exporter fails to build

Trait Implementations§

Source§

impl Default for HttpTracerProviderBuilder<StdoutClient, RandomIdGenerator, TraceContextPropagator>

Provides a default implementation for HttpTracerProviderBuilder.

This implementation creates a new HttpTracerProviderBuilder with default settings by calling the new() method.

§Examples

use lambda_otel_utils::HttpTracerProviderBuilder;

let default_builder = HttpTracerProviderBuilder::default();
Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<C, I, P> Freeze for HttpTracerProviderBuilder<C, I, P>
where C: Freeze, I: Freeze,

§

impl<C = StdoutClient, I = RandomIdGenerator, P = TraceContextPropagator> !RefUnwindSafe for HttpTracerProviderBuilder<C, I, P>

§

impl<C, I, P> Send for HttpTracerProviderBuilder<C, I, P>
where P: Send,

§

impl<C, I, P> Sync for HttpTracerProviderBuilder<C, I, P>
where P: Sync,

§

impl<C, I, P> Unpin for HttpTracerProviderBuilder<C, I, P>
where C: Unpin, I: Unpin, P: Unpin,

§

impl<C = StdoutClient, I = RandomIdGenerator, P = TraceContextPropagator> !UnwindSafe for HttpTracerProviderBuilder<C, I, P>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more