https://github.com/open-telemetry/opentelemetry-swift
OpenTelemetry API for Swift
https://github.com/open-telemetry/opentelemetry-swift
Last synced: about 1 year ago
JSON representation
OpenTelemetry API for Swift
- Host: GitHub
- URL: https://github.com/open-telemetry/opentelemetry-swift
- Owner: open-telemetry
- License: apache-2.0
- Created: 2020-02-19T07:24:42.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T16:39:28.000Z (about 1 year ago)
- Last Synced: 2025-03-31T20:05:22.457Z (about 1 year ago)
- Language: Swift
- Homepage: https://opentelemetry.io/docs/instrumentation/swift/
- Size: 3.99 MB
- Stars: 257
- Watchers: 21
- Forks: 168
- Open Issues: 114
-
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 beta quality
Metrics is implemented using an outdated spec, is fully functional but will change in the future
### Supported exporters and importers
#### Traces
* Exporters: Stdout, Jaeger, Zipkin, Datadog and OpenTelemetry (OTLP) collector
* Importers: OpenTracingShim
#### Metrics
* Exporters: Prometheus, Datadog, and OpenTelemetry (OTLP) collector
* Importers: SwiftMetricsShim
#### Logs
* Exporters: OpenTelemetry (OTLP) collector
> **_NOTE:_** OTLP exporters are supported both in GRPC and HTTP, only GRPC is production ready, HTTP is still experimental
### Instrumentation libraries
* `URLSession`
* `NetworkStatus`
* `SDKResourceExtension`
* `SignPostIntegration`
## Examples
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 call
* `Network Tracer` - Shows how to use the `URLSessionInstrumentation` instrumentation in your application
* `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
* `OTLP Exporter` - Shows the OTLP exporter reporting traces to Zipkin and metrics to a Prometheus via the otel-collector
## Contributing
We'd love your help!. Use tags [help wanted][help wanted] and
[good first issue][good first issues] 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.
### Community members
#### Maintainers ([@open-telemetry/swift-maintainers](https://github.com/orgs/open-telemetry/teams/swift-maintainers))
- [Ignacio Bonaforte](https://github.com/nachob), Independent
- [Bryce Buchanan](https://github.com/bryce-b), Elastic
*Find more about the maintainer role in the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).*
#### Approvers ([@open-telemetry/swift-approvers](https://github.com/orgs/open-telemetry/teams/swift-approvers))
- [Vinod Vydier](https://github.com/vvydier)), Independent
- [Austin Emmons](https://github.com/atreat), Embrace
*Find more about the approver role in the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).*
#### Triager ([@open-telemetry/swift-triagers](https://github.com/orgs/open-telemetry/teams/swift-triagers))
- [Alolita Sharma](https://github.com/alolita), Apple
*Find more about the triager role in the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#triager).*