TracingSetup

Struct TracingSetup 

Source
pub struct TracingSetup {
    pub(crate) base_level: Option<String>,
    pub(crate) extra_directives: Option<String>,
    pub(crate) tokio_console_bind: Option<SocketAddr>,
    pub(crate) with_jaeger: bool,
    pub(crate) with_file: Option<File>,
}
Expand description

Consolidates the setup of server tracing into a helper

Fields§

§base_level: Option<String>§extra_directives: Option<String>§tokio_console_bind: Option<SocketAddr>§with_jaeger: bool§with_file: Option<File>

Implementations§

Source§

impl TracingSetup

Source

pub fn tokio_console_bind(&mut self, address: Option<SocketAddr>) -> &mut Self

Setup a console server for tokio logging https://docs.rs/console-subscriber

Source

pub fn with_jaeger(&mut self, enabled: bool) -> &mut Self

Setup telemetry export via OTLP (OpenTelemetry Protocol).

This uses the OTLP exporter which is compatible with Jaeger (since v1.35), the OpenTelemetry Collector, and many other observability backends.

Configure the endpoint with OTEL_EXPORTER_OTLP_ENDPOINT environment variable (defaults to http://localhost:4317 for gRPC).

To use with Jaeger:

docker run -d -p4317:4317 -p16686:16686 jaegertracing/all-in-one:latest
Source

pub fn with_file(&mut self, file: Option<File>) -> &mut Self

Source

pub fn with_base_level(&mut self, level: impl Into<String>) -> &mut Self

Sets the log level applied to most modules. Some overly chatty modules are muted even if this is set to a lower log level, use the RUST_LOG environment variable to override.

Source

pub fn with_directive(&mut self, directive: &str) -> &mut Self

Add a filter directive.

Source

pub fn init(&mut self) -> Result<()>

Initialize the logging, must be called for tracing to begin

Trait Implementations§

Source§

impl Default for TracingSetup

Source§

fn default() -> TracingSetup

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

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

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

fn with_current_context(self) -> WithContext<Self>

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

impl<T> Instrument for T

§

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

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

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
§

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

§

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
§

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,