Struct 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 with_dataset( self, dataset_name: impl Into<String>, ) -> Result<Self, Error>

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.

Errors

If the dataset name is empty.

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

Set the Axiom API token to use.

Errors

If the token is empty or does not start with xaat- (aka is not a api token).

pub fn with_url(self, url: &str) -> Result<Self, Error>

Set the Axiom API URL to use. Defaults to Axiom Cloud. When not set Axiom Cloud is used.

Errors

If the URL is not a valid URL.

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 with_tags<T, K, V>(self, tags: T) -> Self

where K: Into<Key>, V: Into<Value>, T: Iterator<Item = (K, V)>,

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

pub fn with_timeout(self, timeout: Duration) -> Self

Sets the collector timeout for the OTLP exporter. The default is 3 seconds.

pub fn with_env(self) -> Result<Self, Error>

Load defaults from environment variables, if variables were set before this call they will not be replaced.

The following environment variables are used:

• AXIOM_TOKEN
• AXIOM_DATASET
• AXIOM_URL

Errors

If an environment variable is not valid UTF8, or any of their values are invalid.

pub fn build<S>(self) -> Result<OpenTelemetryLayer<S, Tracer>, Error>

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

Create a layer which sends traces to Axiom that can be added to the tracing layers.

Errors

Returns an error if any of the settings are not valid

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.