A 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.
Please note that this library is currently in development, and you should be careful before using in production environments.
opentelemetry-swift is designed for Swift 5. To depend on the opentelemetry-swift package, you need to declare your dependency in your
.package(url: "https://github.com/open-telemetry/opentelemetry-swift", from: "0.6.0"),
and to your application/library target, add
dependencies, e.g. like this:
.target(name: "ExampleTelemetryProducerApp", dependencies: ["OpenTelemetryApi"]),
.target(name: "ExampleApp", dependencies: ["OpenTelemetrySdk"]),
Currently Tracing, Metrics and Baggage API's and SDK are implemented, also OpenTracing shim, for compatibility with existing Opentracing code.
Implemented traces exporters: Stdout, Jaeger, Zipkin, Datadog and OpenTelemetry collector
Implemented metrics exporters: Prometheus, Datadog, and OpenTelemetry collector
The package includes some example projects with basic functionality:
Logging Tracer- Simple api implementation of a Tracer that logs every api call
Simple Exporter- Shows the Jaeger an Stdout exporters in action using a MultiSpanExporter. Can be easily modified for other exporters
Prometheus Sample- Shows the Prometheus exporter reporting metrics to a Prometheus instance
|Last commit: 4 hours ago|
0.6.0 complies with version 1.0.1 of the OpenTelemetry Tracing Spec, and supports OTLP spec 0.7.0.
It also includes the following list of changes:
GRPCversion 1.0.0 #113
Statusis now an enum, with associated description for error #113
TraceStatemutating functions should not be used outside the library so are now internal #113
SpanLimits, and move
SpanLimitattribute names, and update default values #113
OpenTelemetryProtocol (OTLP) Exporter