Skip to main content

TelemetryGuard

Struct TelemetryGuard 

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

Guard that manages telemetry lifecycle

When dropped, ensures proper cleanup of telemetry resources including flushing any pending trace/metric data to exporters.

§Critical: Drop Behavior

The TelemetryGuard MUST outlive all traced code in your application.

When the guard is dropped, its Drop implementation:

  1. Flushes all pending traces to configured exporters (OTLP, etc.)
  2. Shuts down the OpenTelemetry tracer provider
  3. Releases telemetry resources

§Common Pitfall

// ❌ WRONG: Guard dropped too early
{
    let _guard = TelemetryConfig::default().init()?;
} // Guard dropped here
my_traced_function().await; // Traces lost!
// ✅ CORRECT: Guard outlives traced code
let _guard = TelemetryConfig::default().init()?;
my_traced_function().await;
// Guard dropped at end of scope, traces flushed

§Best Practice

Store the guard in your main application struct or as a variable in main():

#[tokio::main]
async fn main() -> Result<()> {
    let _telemetry = TelemetryConfig::default().init()?;

    // Run your server
    run_server().await?;

    Ok(())
    // Guard dropped here after server shutdown
}

§Example

use turbomcp_telemetry::{TelemetryConfig, TelemetryGuard};

let config = TelemetryConfig::builder()
    .service_name("my-server")
    .build();

// Initialize telemetry - guard must be kept alive
let _guard = config.init()?;

// Your application code here...

// Telemetry is properly cleaned up when guard is dropped

Implementations§

Source§

impl TelemetryGuard

Source

pub fn init(config: TelemetryConfig) -> Result<Self, TelemetryError>

Initialize telemetry with the provided configuration

Source

pub fn service_name(&self) -> &str

Get the service name

Source

pub fn service_version(&self) -> &str

Get the service version

Source

pub fn config(&self) -> &TelemetryConfig

Get the configuration

Trait Implementations§

Source§

impl Debug for TelemetryGuard

Source§

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

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

impl Drop for TelemetryGuard

Source§

fn drop(&mut self)

Executes the destructor for this 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.

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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