tracing-opentelemetry-setup 0.5.1

Utilities to provide proper setup of tracing with OTEL export
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# tracing-opentelemetry-setup

[![Rust](https://github.com/DoumanAsh/tracing-opentelemetry-setup/actions/workflows/rust.yml/badge.svg)](https://github.com/DoumanAsh/tracing-opentelemetry-setup/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/tracing-opentelemetry-setup.svg)](https://crates.io/crates/tracing-opentelemetry-setup)
[![Documentation](https://docs.rs/tracing-opentelemetry-setup/badge.svg)](https://docs.rs/crate/tracing-opentelemetry-setup/)
[![dependency status](https://deps.rs/crate/tracing-opentelemetry-setup/0.5.1/status.svg)](https://deps.rs/crate/tracing-opentelemetry-setup/0.5.1)

OpenTelemetry integration for tracing.

The goal of this crate is to provide all-in-one crate to initialize OpenTelemetry integration with tracing

MSRV 1.85

## Features

- `panic` - Provides panic hook implementation. Must be enabled via panic module
- `propagation` - Enables propagation utilities
- `metrics` - Enable integration with [metrics](https://crates.io/crates/metrics)
- `tracing-metrics` - Enable metrics usage via [tracing-opentelemetry](https://docs.rs/tracing-opentelemetry/latest/tracing_opentelemetry/struct.MetricsLayer.html)
- `rt-tokio` - Tell OpenTelemetry sdk that you use tokio runtime

### Non-standard exporters

- `datadog` - Enables datadog agent exporter. Currently supports only traces & logs

### Grpc features

- `grpc` - Enables tonic based gRPC transport
- `grpc-compression` - Enables tonic based gRPC transport with compression
- `grpc-tls` - Enables tonic based gRPC transport with TLS

### HTTP features

Note that when enabling multiple clients, only one client will be used by default and it is up to [opentelemetry-otlp](https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-otlp)

- `http` - Enables http exporter code without specific client as default option.
- `http-compression` - Enables http transport with compression
- `http-tls` - Enables http transport with TLS

- `http-reqwest-blocking` - Enables blocking reqwest client.
- `http-reqwest` - Enables async reqwest client.
- `http-hyper` - Enables hyper client.

## Usage

Make sure `tracing-opentelemetry-setup` is installed to your dependencies

```rust
 use tracing_opentelemetry_setup::{Otlp, tracing_subscriber, tracing};
 use tracing_opentelemetry_setup::builder::{Destination, Protocol, Attributes, TraceSettings};

 use tracing_subscriber::layer::SubscriberExt;
 use tracing_subscriber::util::SubscriberInitExt;

 let default_attrs = Attributes::builder().with_attr("service.name", "サービス").finish();
 let trace_settings = TraceSettings::new(1.0);
 let destination = Destination {
     protocol: Protocol::HttpBinary,
     url: "http://localhost:45081".into()
 };
 let mut otlp = Otlp::builder(destination).with_header("Authorization", "Basic <my token>").with_trace(Some(&default_attrs), trace_settings).finish();
 let registry = tracing_subscriber::registry().with(otlp.create_layer("tracing-opentelemetry".into())) //aggregates sdk providers into single layer
                                              .with(tracing_subscriber::filter::LevelFilter::from_level(tracing::Level::INFO));

 let _guard = registry.set_default();
 //Do your job then shutdown to make sure you flush everything
 otlp.shutdown(None).expect("successfully shut down OTLP")
```