#OpenTelemetry SDK

#When To Import This Package

#Provider Lifecycle

1. Build a provider with the signal-specific builder.
2. Attach exporters, processors, readers, resources, samplers, or views.
3. Register the provider with sdk.set_*_provider() if application code uses global lookup.
4. Spawn background tasks for batch processors and periodic metric readers.
5. Force flush and shut down providers during teardown.

• BatchSpanProcessor
• BatchLogProcessor
• PeriodicMetricReader

#Minimal Trace Setup

///|
async fn _sdk_readme_trace_setup() -> Unit {
  let exporter = InMemorySpanExporter::new()
  let provider = tracer_provider_builder()
    .with_simple_exporter(exporter.into_span_exporter())
    .build()

  let tracer = provider.tracer("sdk-readme")
  let span = tracer.start("startup")
  span.end()

  ignore(provider.shutdown())
}

#Traces

• Config: sampler, ID generator, span limits, and resource
• SpanProcessor pipeline: on_start, on_end, force_flush, and shutdown
• SimpleSpanProcessor: exports each ended span immediately
• BatchSpanProcessor: queues ended spans and exports batches from a background loop
• SpanExporter: destination-agnostic exporter callback wrapper

#Metrics

• synchronous instruments that update in-memory aggregation state
• observable instruments whose callbacks run during collection
• ManualReader for pull-style collection in tests or integrations
• PeriodicMetricReader for scheduled background exports
• MetricExporter for exporting collected MetricData
• views that can rename streams, choose aggregation, filter attributes, and set cardinality limits

#Logs

• SimpleLogProcessor: exports each log record immediately
• BatchLogProcessor: queues log records and exports batches from a background loop
• LogExporter: destination-agnostic exporter callback wrapper

#Resources

• OTEL_SERVICE_NAME
• OTEL_RESOURCE_ATTRIBUTES

#Global SDK Helpers

• tracer_provider_builder(), logger_provider_builder(), meter_provider_builder()
• tracer(name, version?, schema_url?, attributes?)
• logger(name, version?, schema_url?, attributes?)
• meter(name, version?, schema_url?, attributes?)
• spawn_background_tasks(group, allow_failure?)

#Environment Variables

#Shutdown Rules

• Call force_flush() when you need a best-effort export before a known boundary.
• Call shutdown() exactly once for providers you own during application exit.
• After shutdown, providers reject or ignore later telemetry work depending on signal-specific behavior.
• Batch processors and periodic readers need background tasks to export before shutdown; without those tasks, data may only be exported by explicit flush or shutdown.