OpenTelemetry support for Tremor
Status
Exprimental - this library is a work in progress under active development
About
A tonic-build
based data-binding and utility code for OpenTelemetry v1
primarily for use in the tremor project for
OpenTelemetry v1 interoperability, integration and interworking.
The code in the gen
folder was seeded by tonic-build
.
The code in the src
folder extends the generated source with utility
code to allow for convenient usage and definition of tonic-based gRPC
servers. Specifically, this library is designed for use by the Tremor Project
but has no dependencies on tremor and can be used standalone.
This library does not provide an API or SDK designed for use as a tracing facility. The official OpenTelemetry Rust project is a complete OpenTelemetry SDK designed for that purpose. It uses the same underlying protocol buffer definitions and will be a better target for projects that require OpenTelemetry based observability instrumentation and iteroperability with the wider observability ecosystem through third party crates.
This library is designed for system integration and interoperability and is not recommended for use as a tracing SDK or for instrumentation as that is well covered already by the OpenTelemetry Rust crate. For instrumentation, use the official crate.
For those projects that need basic interworking, interoperability or integration with OpenTelemetry based systems at a wire level, this project may be useful.
Minimal dependencies for Cargo.toml
[]
= { = "0.1", = ["otel-all"] }
= { = "0.4", = ["tls"] }
= "0.7"
= "0.7"
= { = "1.1", = ["rt-multi-thread", "time", "fs", "macros"] }
Example OpenTelemetry Log client.
Note that clients simply use the generated client stub code from tonic-build
.
This library adds no extra utility or convenience.
async
Example OpenTelemetry Log Server.
Note that we use utility code to expose the server side functionality. We pass through the generated
Protocol Buffer message data binding generated code unadorned. The
data bindings for protocol buffer messages are generated by tonic-build
.
The tonic-build
in turns builds on prost-build
.
async
Example async-channel based OpenTelemetry server
For ease of integration with async runtimes such as tremor:
async