https://github.com/open-telemetry/opentelemetry-swift-core
https://github.com/open-telemetry/opentelemetry-swift-core
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/open-telemetry/opentelemetry-swift-core
- Owner: open-telemetry
- License: apache-2.0
- Created: 2025-08-28T17:27:35.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-15T14:49:39.000Z (9 months ago)
- Last Synced: 2025-09-16T00:39:08.434Z (9 months ago)
- Language: Swift
- Homepage: https://opentelemetry.io/docs/instrumentation/swift/
- Size: 3.77 MB
- Stars: 2
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# 
opentelemetry-swift
[](https://github.com/open-telemetry/opentelemetry-swift/actions/workflows/BuildAndTest.yml?query=branch%3Amain+)
[](https://codecov.io/gh/open-telemetry/opentelemetry-swift)
## About
The repository contains the Swift [OpenTelemetry](https://opentelemetry.io/) 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](https://github.com/open-telemetry/opentelemetry-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`:
```swift
.package(url: "https://github.com/open-telemetry/opentelemetry-swift", from: "1.0.0"),
```
and to your application/library target, add `OpenTelemetryApi` or `OpenTelemetrySdk`to your `dependencies`, e.g. like this:
```swift
.target(name: "ExampleTelemetryProducerApp", dependencies: ["OpenTelemetryApi"]),
```
or
```swift
.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](https://opentelemetry.io/docs/instrumentation/swift/), including:
* Documentation about installation and [manual instrumentation](https://opentelemetry.io/docs/instrumentation/swift/manual/)
* [Libraries](https://opentelemetry.io/docs/instrumentation/swift/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 [&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-swift/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) and [&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-swift/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22)
to get started with the project.
For an overview of how to contribute, see the contributing guide in [CONTRIBUTING.md](CONTRIBUTING.md).
We have a weekly SIG meeting! See the [community page](https://github.com/open-telemetry/community#swift-sdk) for meeting details and notes.
We are also available in the [#otel-swift](https://cloud-native.slack.com/archives/C01NCHR19SB) channel in the [CNCF slack](https://slack.cncf.io/). Please join us there for OTel Swift discussions.
### Maintainers ([@open-telemetry/swift-core-maintainers](https://github.com/orgs/open-telemetry/teams/swift-core-maintainers))
- [Ariel Demarco](https://github.com/arieldemarco), Embrace
- [Bryce Buchanan](https://github.com/bryce-b), Elastic
- [Ignacio Bonafonte](https://github.com/nachobonafonte), Independent
For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).
### Approvers ([@open-telemetry/swift-core-approvers](https://github.com/orgs/open-telemetry/teams/swift-core-approvers))
- [Austin Emmons](https://github.com/atreat), Embrace
- [Vinod Vydier](https://github.com/vvydier), Independent
For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).
### Triager ([@open-telemetry/swift-core-triagers](https://github.com/orgs/open-telemetry/teams/swift-core-triagers))
- [Alolita Sharma](https://github.com/alolita), Apple
For more information about the triager role, see the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#triager).