lambda_otel_lite

Struct TelemetryConfigBuilder

Source
pub struct TelemetryConfigBuilder { /* private fields */ }
Expand description

Builder for configuring OpenTelemetry telemetry initialization.

This builder provides a fluent interface for customizing telemetry configuration:

  • Custom resources for additional attributes
  • Custom span processors for different export strategies
  • Custom library name for instrumentation
  • Control over formatting layer for logs

§Environment Variables

Several environment variables affect the configuration:

  • OTEL_SERVICE_NAME: Service name for spans
  • AWS_LAMBDA_FUNCTION_NAME: Fallback service name
  • OTEL_RESOURCE_ATTRIBUTES: Additional resource attributes
  • LAMBDA_SPAN_PROCESSOR_QUEUE_SIZE: Span buffer size
  • OTLP_STDOUT_SPAN_EXPORTER_COMPRESSION_LEVEL: Export compression
  • LAMBDA_TRACING_ENABLE_FMT_LAYER: Enable formatting layer (default: false)

§Example

use lambda_otel_lite::TelemetryConfigBuilder;
use opentelemetry_sdk::trace::SimpleSpanProcessor;
use otlp_stdout_span_exporter::OtlpStdoutSpanExporter;

let config = TelemetryConfigBuilder::default()
    .with_library_name("my-lambda")
    .with_fmt_layer(true)
    .with_span_processor(SimpleSpanProcessor::new(
        Box::new(OtlpStdoutSpanExporter::default())
    ))
    .build();

Implementations§

Source§

impl TelemetryConfigBuilder

Source

pub fn with_resource(self, resource: Resource) -> Self

Add a custom resource to the tracer provider.

If not set, the default Lambda resource will be used, which includes:

  • AWS Lambda environment attributes (region, function name, etc.)
  • OTEL_SERVICE_NAME or AWS_LAMBDA_FUNCTION_NAME as service.name
  • Any attributes from OTEL_RESOURCE_ATTRIBUTES environment variable
Source

pub fn with_span_processor<T>(self, processor: T) -> Self
where T: SpanProcessor + 'static,

Add a span processor to the tracer provider.

Note: Adding any processor will disable the default Lambda processor pipeline. If you need multiple processors, call this method multiple times.

§Example
use lambda_otel_lite::TelemetryConfigBuilder;
use opentelemetry_sdk::trace::SimpleSpanProcessor;
use otlp_stdout_span_exporter::OtlpStdoutSpanExporter;

let config = TelemetryConfigBuilder::default()
    .with_span_processor(SimpleSpanProcessor::new(Box::new(OtlpStdoutSpanExporter::default())))
    .build();
Source

pub fn with_library_name<S>(self, name: S) -> Self
where S: Into<Cow<'static, str>>,

Set a custom library name for the tracer.

If not set, defaults to the package name (“lambda-otel-lite”). This value is used as the library.name attribute in spans.

Source

pub fn with_fmt_layer(self, enable: bool) -> Self

Enable or disable the formatting layer for logs.

When enabled, trace data will also appear in application logs. Defaults to false if not set, can be overridden by LAMBDA_TRACING_ENABLE_FMT_LAYER.

Source

pub fn build(self) -> TelemetryConfig

Build the final telemetry configuration.

If no resource was set, uses the default Lambda resource. If no processors were added, uses the default Lambda processor pipeline. If fmt_layer not set, checks LAMBDA_TRACING_ENABLE_FMT_LAYER environment variable.

Trait Implementations§

Source§

impl Default for TelemetryConfigBuilder

Source§

fn default() -> TelemetryConfigBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more