Skip to main content

LayerBuilder

Struct LayerBuilder 

Source
pub struct LayerBuilder { /* private fields */ }
Expand description

Tracing subscriber layer API. Tracing subscriber layer API. Tracing subscriber layer API. Builder for Layer.

Implementations§

Source§

impl LayerBuilder

Source

pub fn endpoint(self, endpoint: Url) -> Self

Sets the OTLP/gRPC endpoint, for example http://127.0.0.1:4317.

Source

pub fn token(self, token: SecretString) -> Self

Sets the bearer token sent to the observability server.

Source

pub fn source(self, source: SourceId) -> Self

Sets the source identity attached to every exported batch.

Source

pub fn batch_size(self, batch_size: usize) -> Self

Sets the maximum records per export request.

Source

pub fn flush_interval(self, flush_interval: Duration) -> Self

Sets the periodic flush interval.

Source

pub fn flush_timeout(self, flush_timeout: Duration) -> Self

Sets the timeout for each export or replay attempt, including requested flushes.

Source

pub fn queue_dir(self, queue_dir: PathBuf) -> Self

Sets the directory used for offline protobuf log batches.

Source

pub fn sample_rate(self, sample_rate: f64) -> Self

Sets a deterministic sample rate in the inclusive range 0.0..=1.0.

Source

pub fn compression(self, encoding: CompressionEncoding) -> Self

Compresses exported gRPC messages with gzip or zstd.

Requests are uncompressed by default for compatibility with older receivers.

Source

pub fn tls_config(self, config: ClientTlsConfig) -> Self

Sets HTTPS transport options, including custom CA roots and mutual TLS.

HTTPS endpoints use system trust roots by default. A custom configuration can add a private CA, override the expected domain, or supply a client identity.

Source

pub fn build(self) -> Result<Layer, LayerError>

Builds the layer and spawns its background exporter on the current Tokio runtime.

§Errors

Returns LayerError::MissingEndpoint, LayerError::MissingToken, LayerError::MissingSource, or LayerError::MissingQueueDir if the corresponding builder field was not set.

Trait Implementations§

Source§

impl Clone for LayerBuilder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LayerBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for LayerBuilder

Source§

fn default() -> Self

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

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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