Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zio/zio-telemetry
ZIO-powered OpenTelemetry library
https://github.com/zio/zio-telemetry
functional-programming open-telemetry open-tracing scala zio
Last synced: about 2 months ago
JSON representation
ZIO-powered OpenTelemetry library
- Host: GitHub
- URL: https://github.com/zio/zio-telemetry
- Owner: zio
- License: apache-2.0
- Created: 2019-11-01T11:23:01.000Z (almost 5 years ago)
- Default Branch: series/2.x
- Last Pushed: 2024-07-31T23:04:02.000Z (about 2 months ago)
- Last Synced: 2024-08-01T01:55:43.435Z (about 2 months ago)
- Topics: functional-programming, open-telemetry, open-tracing, scala, zio
- Language: Scala
- Homepage: https://zio.dev/zio-telemetry
- Size: 2.22 MB
- Stars: 110
- Watchers: 10
- Forks: 55
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-zio - ZIO Telemetry - powered OpenTelemetry library (Official ZIO Libraries)
README
[//]: # (This file was autogenerated using `zio-sbt-website` plugin via `sbt generateReadme` command.)
[//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys)
[//]: # (e.g. "readmeDocumentation" and "readmeSupport".)
# ZIO Telemetry
[ZIO telemetry](https://github.com/zio/zio-telemetry) is purely-functional and type-safe. It provides clients for
[OpenTracing](https://opentracing.io/), [OpenCensus](https://opencensus.io/) and [OpenTelemetry](https://opentelemetry.io/).
[](https://github.com/zio/zio/wiki/Project-Stages)  [](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-opentracing_2.13/) [](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-opentracing_2.13/) [](https://javadoc.io/doc/dev.zio/zio-telemetry-docs_2.13) [](https://github.com/zio/zio-telemetry)
ZIO Telemetry consists of the following projects:
- [OpenTracing](docs/opentracing.md)
- [OpenCensus](docs/opencensus.md)
- [OpenTelemetry](docs/opentelemetry.md)
## Introduction
In monolithic architecture, everything is in one place, and we know when a request starts and then how it goes through
the components and when it finishes. We can obviously see what is happening with our request and where is it going.
But, in distributed systems like microservice architecture, we cannot find out the story of a request through various
services easily. This is where distributed tracing comes into play.
ZIO Telemetry is a purely functional client which helps up propagate context between services in a distributed environment.
## Installation
In order to use this library, we need to add the following line in our `build.sbt` file if we want to use [OpenTelemetry](https://opentelemetry.io/) client:
```scala
libraryDependencies += "dev.zio" %% "zio-opentelemetry" % ""
```
If you're using [ZIO Logging](https://github.com/zio/zio-logging) you can combine OpenTelemetry with ZIO Logging using:
```scala
libraryDependencies += "dev.zio" %% "zio-opentelemetry-zio-logging" % ""
```
For using [OpenTracing](https://opentracing.io/) client we should add the following line in our `build.sbt` file:
```scala
libraryDependencies += "dev.zio" %% "zio-opentracing" % ""
```
And for using [OpenCensus](https://opencensus.io/) client we should add the following line in our `build.sbt` file:
```scala
libraryDependencies += "dev.zio" %% "zio-opencensus" % ""
```
## Examples
You can find examples with full source code and instructions of how to run by following the links:
- [OpenTelemetry Example](docs/opentelemetry-example.md)
- [OpenTelemetry Instrumentation Example](docs/opentelemetry-instrumentation-example.md)
- [OpenTelemetry ZIO Logging Example](docs/opentelemetry-zio-logging.md)
- [OpenTracing Example](docs/opentracing-example.md)
## Articles
- [Trace your microservices with ZIO](https://kadek-marek.medium.com/trace-your-microservices-with-zio-telemetry-5f88d69cb26b) by Marek Kadek (September 2021)
## Documentation
Learn more on the [ZIO Telemetry homepage](https://zio.dev/zio-telemetry/)!
## Contributing
For the general guidelines, see ZIO [contributor's guide](https://zio.dev/contributor-guidelines).
## Code of Conduct
See the [Code of Conduct](https://zio.dev/code-of-conduct)
## Support
Come chat with us on [![Badge-Discord]][Link-Discord].
[Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord"
[Link-Discord]: https://discord.gg/2ccFBr4 "Discord"
## License
[License](LICENSE)