Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typelevel/otel4s
An OpenTelemetry library for Scala based on Cats-Effect
https://github.com/typelevel/otel4s
cats cats-effect metrics opentelemetry scala tracing typelevel
Last synced: 6 days ago
JSON representation
An OpenTelemetry library for Scala based on Cats-Effect
- Host: GitHub
- URL: https://github.com/typelevel/otel4s
- Owner: typelevel
- License: apache-2.0
- Created: 2022-05-09T16:30:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:34:43.000Z (3 months ago)
- Last Synced: 2024-10-29T09:27:23.016Z (3 months ago)
- Topics: cats, cats-effect, metrics, opentelemetry, scala, tracing, typelevel
- Language: Scala
- Homepage: https://typelevel.org/otel4s
- Size: 4.21 MB
- Stars: 173
- Watchers: 18
- Forks: 36
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# otel4s
[](https://maven-badges.herokuapp.com/maven-central/org.typelevel/otel4s-core_2.13)
## Telemetry meets higher-kinded types
_otel4s_ is an [OpenTelemetry][otel] implementation for Scala. The
design goal is to fully and faithfully implement the [OpenTelemetry
Specification][otel spec] atop [Cats Effect][cats-effect].
## Features
* **Simple and idiomatic metrics and tracing API**
Provides a user-friendly and idiomatic API for telemetry, designed with Typelevel ecosystem best practices.
Intuitive interfaces for metrics, tracing, and context propagation.
* **Minimal overhead**
The library utilizes metaprogramming techniques to reduce runtime costs and allocations.
**Near-zero** overhead when telemetry is disabled,
ensuring production performance is unaffected when tracing or metrics collection is not required.
* **Modularity**
A modular architecture allows to include only the required components:
1. Core modules: designed for library instrumentation, offering a lightweight dependency footprint
2. Selective integration: use only the metrics or tracing functionality without requiring the other
* **Cross-platform**
All modules are available for Scala 2.13 and Scala 3.
Core modules are available on all platforms: JVM, Scala.js, and Scala Native.
* **OpenTelemetry Java SDK backend**
The backend utilizes [OpenTelemetry Java SDK][opentelemetry-java] under the hood, offering production-ready telemetry:
1. Low memory overhead
2. Extensive [instrumentation ecosystem][opentelemetry-java-instrumentation]
3. Well-tested implementation
* **SDK backend**
SDK modules are implemented in Scala from scratch. Available for JVM, Scala.js, and Scala Native.
While the implementation is compliant with the OpenTelemetry specification,
it remains **experimental** and some functionality may be lacking.
* **Testkit**
A testkit simplifies the validation of telemetry behavior in the applications and libraries:
1. Framework-agnostic, works with any test framework, such as weaver, munit, scalatest
2. Ideal for testing of the instrumented applications in end-to-end or unit tests
3. Available for OpenTelemetry Java and SDK backends
## Status
The API is still highly experimental, but we are actively
instrumenting various libraries and applications to check for fit.
Don't put it in a binary-stable library yet, but we invite you to try
it out and let us know what you think.
## Modules availability
| Module / Platform | JVM | Scala Native | Scala.js |
|:-----------------:|:---:|:------------:|:--------:|
| `otel4s-core` | ✅ | ✅ | ✅ |
| `otel4s-sdk` | ✅ | ✅ | ✅ |
| `otel4s-oteljava` | ✅ | ❌ | ❌ |
## Learn more
See the [website](https://typelevel.org/otel4s).
[cats-effect]: https://typelevel.org/cats-effect/
[opentelemetry-java]: https://opentelemetry.io/docs/languages/java/
[opentelemetry-java-instrumentation]: https://opentelemetry.io/docs/languages/java/instrumentation/
[otel]: https://opentelemetry.io/
[otel spec]: https://opentelemetry.io/docs/reference/specification/