crabka-telemetry 0.3.6

Generic OTLP distributed-tracing pipeline for Crabka services
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

# crabka-telemetry

[![Crates.io](https://img.shields.io/crates/v/crabka-telemetry.svg)](https://crates.io/crates/crabka-telemetry)
[![Docs.rs](https://docs.rs/crabka-telemetry/badge.svg)](https://docs.rs/crabka-telemetry)
[![CI](https://github.com/robot-head/crabka/actions/workflows/ci.yml/badge.svg)](https://github.com/robot-head/crabka/actions/workflows/ci.yml)

Generic OTLP distributed-tracing pipeline for Crabka services.

This crate is part of [Crabka](https://github.com/robot-head/crabka), a Rust implementation of Kafka-compatible infrastructure and clients.

## Install

```toml
crabka-telemetry = "0.3.2"
```

For workspace development, use the path dependency from this repository instead.

## Usage example

Install stdout tracing plus optional OTLP export for a Crabka service process:

```rust,no_run
use crabka_telemetry::{init, OtlpConfig};

# fn run() -> Result<(), Box<dyn std::error::Error>> {
let otlp = OtlpConfig::from_env(
    |key| std::env::var(key).ok(),
    "broker-1",
    env!("CARGO_PKG_VERSION"),
    "crabka-broker",
);
let guard = init(otlp, "info", "info", "crabka-broker")?;
tracing::info!("tracing is configured");
guard.shutdown();
# Ok(())
# }
```

## Documentation

API documentation is published on [docs.rs/crabka-telemetry](https://docs.rs/crabka-telemetry). The repository README contains project-wide setup, development, and release notes.

## License

Apache-2.0. See the repository `LICENSE` and `NOTICE` files for details.