opentelemetry-swift

About

The repository contains the Swift OpenTelemetry client

Getting Started

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.

Adding the dependency

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"]),

Cocoapods

As of version 1.11.0, OpenTelemetry-Swift support cocoapods. Two pods are provided:

• OpenTelemetry-Swift-Api

• OpenTelemetry-Swift-Sdk

OpenTelemetry-Swift-Api is a dependency of OpenTelemetry-Swift-Sdk.

Most users will want to add the following to their pod file:

pod 'OpenTelemetry-Swift-Sdk'

This will add both the API and SDK. If you're only interesting in Adding the API add the following:

pod 'OpenTelemetry-Swift-Api'

Documentation

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

Current status

API and SDK

Tracing and Baggage are considered stable

Logs are considered stable.

Metrics is considered stable.

Contributing

We'd love your help! Use labels and to get started with the project. For an overview of how to contribute, see the contributing guide in CONTRIBUTING.md.

We have a weekly SIG meeting! See the community page for meeting details and notes.

We are also available in the #otel-swift channel in the CNCF slack. Please join us there for OTel Swift discussions.

Maintainers (@open-telemetry/swift-core-maintainers)

• Ariel Demarco, Embrace
• Bryce Buchanan, Elastic
• Ignacio Bonafonte, Independent

For more information about the maintainer role, see the community repository.

Approvers (@open-telemetry/swift-core-approvers)

• Austin Emmons, Embrace
• Vinod Vydier, Independent

For more information about the approver role, see the community repository.

Triager (@open-telemetry/swift-core-triagers)

• Alolita Sharma, Apple

For more information about the triager role, see the community repository.