Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slashmo/jaeger-client-swift
Jaeger Client built for Swift Distributed Tracing
https://github.com/slashmo/jaeger-client-swift
distributed-tracing jaeger jaeger-client monitoring swift swift-distributed-tracing
Last synced: 3 months ago
JSON representation
Jaeger Client built for Swift Distributed Tracing
- Host: GitHub
- URL: https://github.com/slashmo/jaeger-client-swift
- Owner: slashmo
- License: apache-2.0
- Created: 2020-09-17T08:18:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-09T14:16:23.000Z (about 4 years ago)
- Last Synced: 2023-03-05T18:58:48.842Z (almost 2 years ago)
- Topics: distributed-tracing, jaeger, jaeger-client, monitoring, swift, swift-distributed-tracing
- Language: Swift
- Homepage:
- Size: 75.2 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Swift Jaeger Client
[](https://swift.org/download/)
[](https://github.com/slashmo/jaeger-client-swift/actions?query=workflow%3ACI)
This Swift package provides a **WIP** client for Jaeger Tracing implemented using the
[Swift Tracing](https://github.com/slashmo/gsoc-swift-tracing) set of APIs.
## Goal 🥅
The main goal of this project is to create a test, yet real-world, implementation for fleshing out the API details for
Swift Tracing.
## Stretch Goal 🙆♀️ 🥅
As a stretch goal for this implementation we aim to pitch it to become embraced by the Jaeger project as an [officially supported library](https://www.jaegertracing.io/docs/1.19/client-libraries/#supported-libraries).
## Installation
First, Add the following package dependency to your `Package.swift` file:
```swift
.package(url: "https://github.com/slashmo/jaeger-client-swift.git", .branch("main")),
```
Then, add the `Jaeger` library to the target(s) you want to use it with:
```swift
.product(name: "Jaeger", package: "jaeger-client-swift"),
```
> 🔖 At this point in time no version has been tagged as the API is still very fragile. Make sure to watch the repository to stay tuned.
## Configuration
Now that you installed the Jaeger client you can use it in your project by bootstrapping the `InstrumentationSystem` with an instance of `JaegerClient`:
```swift
let reporter = // ... see instructions below
let jaegerSettings = JaegerTracer.Settings(
serviceName: "frontend",
reporter: reporter
)
let jaegerTracer = JaegerTracer(
settings: jaegerSettings,
group: eventLoopGroup
)
InstrumentationSystem.bootstrap(jaegerTracer)
```
### Reporting
Jaeger supports different [Span reporting APIs](https://www.jaegertracing.io/docs/1.20/apis/#span-reporting-apis), but
not all are supported (yet) by this client implementation. Here's a list of the supported reporters:
#### Zipkin
https://www.jaegertracing.io/docs/1.20/apis/#zipkin-formats-stable
> Make sure to set `COLLECTOR_ZIPKIN_HTTP_PORT` accordingly when configuring your Jaeger instance
```swift
let reporter = JaegerTracer.Reporter.zipkinv2(
collectorHost: "localhost",
collectorPort: 9411,
eventLoopGroup: eventLoopGroup
)
```
## Contributing
Please make sure to run the `./scripts/sanity.sh` script when contributing, it checks formatting and similar things.
You can ensure it always runs and passes before you push by installing a pre-push hook with git:
```sh
echo './scripts/sanity.sh' > .git/hooks/pre-push
chmod +x .git/hooks/pre-push
```