Struct tracing_axiom::Builder

pub struct Builder { /* private fields */ }

Builder for creating a tracing tracer, a layer or a subscriber that sends traces to Axiom via the OpenTelemetry protocol. The API token is read from the AXIOM_TOKEN environment variable. The dataset name is read from the AXIOM_DATASET environment variable. The URL defaults to Axiom Cloud whose URL is https://cloud.axiom.co but can be overridden by setting the AXIOM_URL environment variable for testing purposes

Implementations

impl Builder

pub fn new() -> Self

Create a new Builder.

pub fn with_dataset(self, dataset_name: impl Into<String>) -> Self

Set the Axiom dataset name to use. The dataset name is the name of the persistent dataset in Axiom cloud that will store the traces and make them available for querying using APL, the Axiom SDK or the Axiom CLI.

pub fn with_token(self, token: impl Into<String>) -> Self

Set the Axiom API token to use.

pub fn with_url(self, url: impl Into<String>) -> Self

Set the Axiom API URL to use. Defaults to Axiom Cloud.

pub fn with_trace_config(self, trace_config: impl Into<TraceConfig>) -> Self

Set the trace config.

pub fn with_service_name(self, service_name: impl Into<String>) -> Self

Set the service name. It will be set as a resource attribute with the name service_name.

pub fn no_env(self) -> Self

Don’t fall back to environment variables.

pub fn with_tags(self, tags: &[(&str, &str)]) -> Self

Set the resource tags for the open telemetry tracer that publishes to Axiom. These tags will be added to all spans.

Errors

Returns an error if a key is invalid.

pub fn init(self) -> Result<(), Error>

Initialize the global subscriber. This panics if the initialization was unsuccessful, likely because a global subscriber was already installed or AXIOM_TOKEN is not set or invalid.

Errors

Returns an error if the initialization was unsuccessful, likely because a global subscriber was already installed or AXIOM_TOKEN is not set or invalid.

pub fn layer<S>( self ) -> Result<Layered<OpenTelemetryLayer<S, Tracer>, AxiomOpenTelemetryLayer<S>, S>, Error>

where S: Subscriber + for<'span> LookupSpan<'span>,

Create a layer which sends traces to Axiom and a Guard which will shut down the tracer provider on drop.

Errors

Returns an error if the initialization was unsuccessful, likely because a global subscriber was already installed or AXIOM_TOKEN is not set or invalid.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.