7 releases (4 breaking)

0.6.0 Jan 13, 2021
0.5.2 Dec 16, 2020
0.3.1 Aug 2, 2020
0.2.0 Aug 1, 2020
0.1.0 Jul 31, 2020

#4 in #instrumentation

50 downloads per month
Used in opentelemetry-surf

MIT/Apache

28KB
162 lines


opentelemetry-tide

OpenTelemetry integration for Tide


Notes

  • It only implements very basic request tracing on the middleware layer. If you need spans for your executed code, you need to add them yourself.
  • The majority of the implementation is based on https://github.com/OutThereLabs/actix-web-opentelemetry.
  • It does not provide metrics, so it cannot be used for Prometheus metrics. Yet. Maybe I'll add it in the future. Or you want to contribute the extension. ;-)
  • You probably do not want to use it in production. 🤷

How to use

# Run jaeger in background
docker run -d \
  -p6831:6831/udp -p6832:6832/udp -p16686:16686 -p14268:14268 \
  jaegertracing/all-in-one:latest

# Run server example with tracing middleware
cargo run --example server

# Make a request or two ...
curl http://localhost:3000/

# Open browser and view the traces
firefox http://localhost:16686/

example jaeger trace

Code example

Cargo.toml

[dependencies]
async-std = { version = "1.8", features = ["attributes"] }
opentelemetry = { version = "0.11", features = ["async-std"] }
opentelemetry-jaeger = { version = "0.10", features = ["async-std"] }
opentelemetry-tide = "0.6"
tide = "0.15"

server.rs

use opentelemetry::global as otel_global;
use opentelemetry::sdk::propagation::TraceContextPropagator;
use opentelemetry_semantic_conventions::resource;
use opentelemetry_tide::OpenTelemetryTracingMiddleware;

const VERSION: &str = env!("CARGO_PKG_VERSION");

#[async_std::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    tide::log::start();
    otel_global::set_text_map_propagator(TraceContextPropagator::new());

    let tags = [resource::SERVICE_VERSION.string(VERSION)];

    let (tracer, _uninstall) = opentelemetry_jaeger::new_pipeline()
        .with_service_name("example-server")
        .with_tags(tags.iter().map(ToOwned::to_owned))
        .install()
        .expect("pipeline install failure");

    let mut app = tide::new();
    app.with(OpenTelemetryTracingMiddleware::new(tracer));
    app.at("/").get(|_| async move { Ok("Hello, OpenTelemetry!") });
    app.listen("127.0.0.1:3000").await?;

    Ok(())
}

Cargo Features:

Safety

This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% Safe Rust.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~7–9.5MB
~193K SLoC