Struct 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. A random trace_id is assigned. Use TransactionContext::new_with_trace_id to specify a custom trace ID.

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 new_with_trace_id(name: &str, op: &str, trace_id: TraceId) -> Self

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

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.

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 either the sentry-trace or W3C traceparent header, which is used to associate the transaction with a distributed trace. If both are present, sentry-trace takes precedence.

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.

pub fn sampled(&self) -> Option<bool>

Get the sampling decision for this Transaction.

pub fn name(&self) -> &str

Get the name of this Transaction.

pub fn operation(&self) -> &str

Get the operation of this Transaction.

pub fn trace_id(&self) -> TraceId

Get the Trace ID of this Transaction.

pub fn span_id(&self) -> SpanId

Get the Span ID of this Transaction.

pub fn custom(&self) -> Option<&CustomTransactionContext>

Get the custom context of this Transaction.

pub fn custom_mut(&mut self) -> &mut Option<CustomTransactionContext>

Update the custom context of this Transaction.

For simply adding a key, use the custom_insert method.

pub fn custom_insert(&mut self, key: String, value: Value) -> Option<Value>

Inserts a key-value pair into the custom context.

If the context did not have this key present, None is returned.

If the context did have this key present, the value is updated, and the old value is returned.

pub fn builder(name: &str, op: &str) -> TransactionContextBuilder

Creates a transaction context builder initialized 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.

Trait Implementations

impl Clone for TransactionContext

fn clone(&self) -> TransactionContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionContext

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

Formats the value using the given formatter.