Struct sentry_core::TransactionContext

pub struct TransactionContext { /* private fields */ }

The Transaction Context used to start a new Performance Monitoring Transaction.

The Transaction Context defines the metadata for a Performance Monitoring Transaction, and also the connection point for distributed tracing.

Implementations

impl TransactionContext

pub fn new(name: &str, op: &str) -> Self

Creates a new Transaction Context with the given name and op.

See https://docs.sentry.io/platforms/native/enriching-events/transaction-name/ for an explanation of a Transaction’s name, and https://develop.sentry.dev/sdk/performance/span-operations/ for conventions around an operation’s value.

See also the TransactionContext::continue_from_headers function that can be used for distributed tracing.

pub fn continue_from_headers<'a, I: IntoIterator<Item = (&'a str, &'a str)>>(
    name: &str,
    op: &str,
    headers: I
) -> Self

Creates a new Transaction Context based on the distributed tracing headers.

The headers in particular need to include the sentry-trace header, which is used to associate the transaction with a distributed trace.

pub fn continue_from_span(
    name: &str,
    op: &str,
    span: Option<TransactionOrSpan>
) -> Self

Creates a new Transaction Context based on an existing Span.

This should be used when an independent computation is spawned on another thread and should be connected to the calling thread via a distributed tracing transaction.

pub fn set_sampled(&mut self, sampled: impl Into<Option<bool>>)

Set the sampling decision for this Transaction.

This can be either an explicit boolean flag, or None, which will fall back to use the configured traces_sample_rate option.

Trait Implementations

impl Debug for TransactionContext

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

Formats the value using the given formatter.