OpenTelemetry Swift Documentation

Classes

OTel

The main entry point to using OpenTelemetry.

OTel.​Batch​Span​Processor

A processor which hands off ended spans to a given exporter in batches.

Otlp​GRPCSpan​Exporter

A span exporter which sends spans to an OTel collector via gRPC in the OpenTelemetry protocol (OTLP).

Structures

OTel.​NoOpSpan​Exporter

A no-op span exporter that simply ignores the given spans and always succeeds.

OTel.​NoOpSpan​Processor

A no-op span processor that simply ignores the given spans.

OTel.​Simple​Span​Processor

A span processor that simply forwards all sampled spans to a given exporter.

OTel.​Multiplex​Propagator

A pseudo-OTelPropagator that may be used to instrument using multiple other OTelPropagators across a common OTel.SpanContext.

OTel.​W3CPropagator

A propagator which operates on HTTP headers using the W3C TraceContext.

OTel.​W3CPropagator.​Trace​Parent​Parsing​Error

An error that might occur during the parsing of the traceparent header.

OTel.​W3CPropagator.​Trace​State​Parsing​Error

An error that might occur during the parsing of the traceparent header.

OTel.​Random​IDGenerator

Generates random trace and span ids using a RandomNumberGenerator.

OTel.​Recorded​Span

Holds the read-only data collected during the lifetime of a span, typically created right after a span was ended.

OTel.​Resource

A resource represents the entity being traced.

OTel.​Constant​Sampler

A sampler that always returns either OTel.SamplingDecision.recordAndSampled or OTel.SamplingDecision.drop based on configuration.

OTel.​Parent​Based​Sampler

A sampler composed of multiple configurable samplers which are called based on whether the parent span is remote and/or sampled, or doesn't exist.

OTel.​Sampling​Result

The result of asking a sampler whether a given span should be sampled.

OTel.​Span​Context

A SpanContext represents the portion of a Span which must be serialized and propagated across asynchronous boundaries.

OTel.​Span​ID

Uniquely identifies a single span using an 8-byte array.

OTel.​Trace​Flags

A set of flags denoting e.g. whether a span is sampled.

OTel.​Trace​ID

Uniquely identifies a single trace using a 16-byte array.

OTel.​Trace​State

Provides additional vendor-specific trace identification information across different distributed tracing systems.

Otlp​GRPCSpan​Exporter.​Config

Configures an OtlpGRPCSpanExporter through arguments and environment variables.

Enumerations

OTel.​Hex

A collection of utilities when working with hex strings.

OTel.​W3CPropagator.​Trace​Parent​Parsing​Error.​Reason

A reason explaining why trace parent parsing failed.

OTel.​W3CPropagator.​Trace​State​Parsing​Error.​Reason

A reason explaining why trace state parsing failed.

OTel.​Resource​Detection

Configures how resource attributes may be detected.

OTel.​Sampling​Decision

A decision on whether a span should be recorded/sampled.

Protocols

OTel​Span​Exporter

An exporter receives processed, sampled spans to export them, e.g. over the network.

OTel​IDGenerator

Responsible for generating trace and span ids.

OTel​Span​Processor

A processor receives ended spans from the tracer and potentially hands them over to an exporter.

OTel​Propagator

A propagator carries span context over asynchronous boundaries such as HTTP calls.

OTel​Resource​Detector

A resource detector asynchronously detects attributes describing an OTel.Resource.

OTel​Sampler

Decides whether a given span should be sampled i.e. passed along to the span exporter.

Extensions

Baggage
OTel.W3CPropagator.TraceParentParsingError
OTel.W3CPropagator.TraceStateParsingError