tracing-samply 0.1.5

Tracing subscriber layer for samply
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

# tracing-samply

A [`tracing-subscriber`] layer that bridges [`tracing`] with [`samply`].

Currently, this only records spans as markers using `samply`'s ad-hoc marker file format,
which are then detected at runtime by `samply` and written to the profile.

Markers for a thread are only detected if `samply` is attached when the thread is created.

This crate will adapt to any changes upstream.
The creator has expressed that the marker file is a temporary measure and that it will be replaced with a more robust solution in the future: <https://github.com/mstange/samply/pull/143#issuecomment-2067747892>

See also: [mstange/samply#349](https://github.com/mstange/samply/issues/349)

### [Example Profile](https://share.firefox.dev/4jgig5C)

![samply](https://raw.githubusercontent.com/DaniPopes/tracing-samply/refs/heads/main/assets/sample.png)

## Usage

```rust
use tracing_subscriber::prelude::*;

fn main() {
    tracing_subscriber::registry()
        // ... other layers
        .with(tracing_samply::SamplyLayer::new().unwrap())
        .init();
    
    // Your application code that uses `tracing`
}
```

## Platform Support

| Platform | Status |
|----------|--------|
| 🐧 Linux | ✅ |
| 🍎 macOS | ✅ |
| 🪟 Windows | ⚠️ |

- ✅ = Compiles, tested in CI, works as expected
- ⚠️ = Compiles, but does not do anything (yet?)

## License

Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT license](LICENSE-MIT) at your option.

[`tracing`]: https://docs.rs/tracing
[`tracing-subscriber`]: https://docs.rs/tracing-subscriber
[`samply`]: https://github.com/mstange/samply