Swiftpack.co - Package - undefinedlabs/opentelemetry-swift

opentelemetry-swift

A swift OpenTelemetry client

Installation

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 alpha, and shouldn't be used in production environments.

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/undefinedlabs/opentelemetry-swift", from: "0.1.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"]),

Current status

Current code is an adaptation of the Java OpenTelemetry client (0.2.1), some Swift style still missing.

Currently most of Tracing and Correlation Context implemented, missing all Metrics and exporters. Also missing OpenTracing shims.

Examples

The package includes some example projects with basic functionality:

  • Logging Tracer - Simple api implementation of a Tracer that logs every api call
  • Simple Exporter - Simple Stdout exporter for spans using sdk

Github

link
Stars: 0

Dependencies

Used By

Total: 0

Releases

0.1.0 - 2019-11-26 17:04:06

First initial release

Added

  • Tracing implementation in OpenTelemetryApi and OpenTelemetrySdk
  • Distributed Context implementation in OpenTelemetryApi and OpenTelemetrySdk
  • Examples with a simple tracer and a simple exporter