Struct trillium_opentelemetry::Instrument

pub struct Instrument(/* private fields */);

a handler to send both traces and metrics in accordances with semantic conventions for http.

This is composed of a Trace handler and Metrics handler.

Implementations

impl Instrument

pub fn new( meter: impl Into<Metrics>, tracer: impl ObjectSafeTracer + Send + Sync + 'static, ) -> Self

construct a new Instrument with the provided meter and tracer

pub fn with_route<F>(self, route: F) -> Self

where F: Fn(&Conn) -> Option<Cow<'static, str>> + Send + Sync + 'static,

provides a route specification

in order to avoid forcing anyone to use a particular router, this is provided as a configuration hook.

for use with trillium-router,

use trillium_router::RouterConnExt;
trillium_opentelemetry::Metrics::new(&opentelemetry::global::meter("example"))
    .with_route(|conn| conn.route().map(|r| r.to_string().into()));

pub fn with_error_type<F>(self, error_type: F) -> Self

where F: Fn(&Conn) -> Option<Cow<'static, str>> + Send + Sync + 'static,

Provides an optional low-cardinality error type specification to the metrics collector.

The implementation of this is application specific, but will often look like checking the [Conn::state] for an error enum and mapping that to a low-cardinality &'static str.

pub fn with_metrics_server_address_and_port<F>( self, server_address_and_port: F, ) -> Self

where F: Fn(&Conn) -> Option<(Cow<'static, str>, u16)> + Send + Sync + 'static,

Provides a callback for server.address and server.port attributes to be used in metrics attributes. This has no effect on tracing span attributes, where server.address and server.port are always enabled.

These should be set based on request headers according to the OpenTelemetry HTTP semantic conventions.

It is not recommended to enable this when the server is exposed to clients outside of your control, as request headers could arbitrarily increase the cardinality of these attributes.

pub fn with_headers( self, headers: impl IntoIterator<Item = impl Into<HeaderName<'static>>>, ) -> Self

Specify a list of request headers to include in the trace spans

pub fn with_local_address_and_port(self) -> Self

Enable population of the local socket address and port in the trace spans.

This populates the network.local.address and network.local.port attributes.

Trait Implementations

impl Debug for Instrument

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

Formats the value using the given formatter.

impl Handler for Instrument

where Self: Send + Sync + 'static,

fn run<'life0, 'async_trait>( &'life0 self, conn: Conn, ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes this handler, performing any modifications to the Conn that are desired.

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, info: &'life1 mut Info, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn before_send<'life0, 'async_trait>( &'life0 self, conn: Conn, ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.

fn has_upgrade(&self, upgrade: &Upgrade) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement [Handler::upgrade]. The first handler that responds true to this will receive ownership of the [trillium::Upgrade][crate::Upgrade] in a subsequent call to [Handler::upgrade]

fn upgrade<'life0, 'async_trait>( &'life0 self, upgrade: Upgrade, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This will only be called if the handler reponds true to [Handler::has_upgrade] and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.