The repository contains the Swift OpenTelemetry client
This package includes several libraries. The OpenTelemetryApi library includes protocols and no-op implementations that comprise the OpenTelemetry API following the specification. The OpenTelemetrySdk library is the reference implementation of the API.
Libraries that produce telemetry data should only depend on OpenTelemetryApi, and defer the choice of the SDK to the application developer. Applications may depend on OpenTelemetrySdk or another package that implements the API.
opentelemetry-swift is designed for Swift 5. To depend on the opentelemetry-swift package, you need to declare your dependency in your Package.swift:
.package(url: "https://github.com/open-telemetry/opentelemetry-swift", from: "1.0.0"),and to your application/library target, add OpenTelemetryApi or OpenTelemetrySdkto your dependencies, e.g. like this:
.target(name: "ExampleTelemetryProducerApp", dependencies: ["OpenTelemetryApi"]),or
.target(name: "ExampleApp", dependencies: ["OpenTelemetrySdk"]),Official documentation for the library can be found in the official opentelemetry documentation page, including:
-
Documentation about installation and manual instrumentation
-
Libraries that provide automatic instrumentation
Tracing and Baggage are considered stable
Logs are considered beta quality
Metrics is implemented using an outdated spec, is fully functional but will change in the future
- Exporters: Stdout, Jaeger, Zipkin, Datadog and OpenTelemetry (OTLP) collector
- Importers: OpenTracingShim
- Exporters: Prometheus, Datadog, and OpenTelemetry (OTLP) collector
- Importers: SwiftMetricsShim
- Exporters: OpenTelemetry (OTLP) collector
NOTE: OTLP exporters are supported both in GRPC and HTTP, only GRPC is production ready, HTTP is still experimental
URLSessionNetworkStatusSDKResourceExtensionSignPostIntegration
The package includes some example projects with basic functionality:
Datadog Sample- Shows the Datadog exporter used with a Simple Exporter, showing how to configure for sending.Logging Tracer- Simple api implementation of a Tracer that logs every api callNetwork Tracer- Shows how to use theURLSessionInstrumentationinstrumentation in your applicationSimple Exporter- Shows the Jaeger an Stdout exporters in action using a MultiSpanExporter. Can be easily modified for other exportersPrometheus Sample- Shows the Prometheus exporter reporting metrics to a Prometheus instanceOTLP Exporter- Shows the OTLP exporter reporting traces to Zipkin and metrics to a Prometheus via the otel-collector
For an overview of how to contribute, see the contributing guide in CONTRIBUTING.md.
We are also available in the #otel-swift channel in the CNCF slack. Please join us there for further discussions.