mirror of
https://github.com/eyre-rs/eyre.git
synced 2025-09-28 13:31:29 +00:00
111 lines
2.5 KiB
Markdown
111 lines
2.5 KiB
Markdown
color-spantrace
|
|
===============
|
|
|
|
[![Build Status][actions-badge]][actions-url]
|
|
[](https://crates.io/crates/color-spantrace)
|
|
[](https://docs.rs/color-spantrace)
|
|
|
|
[actions-badge]: https://github.com/eyre-rs/color-spantrace/workflows/Continuous%20integration/badge.svg
|
|
[actions-url]: https://github.com/eyre-rs/color-spantrace/actions?query=workflow%3A%22Continuous+integration%22
|
|
|
|
A rust library for colorizing [`tracing_error::SpanTrace`] objects in the style
|
|
of [`color-backtrace`].
|
|
|
|
## Setup
|
|
|
|
Add the following to your `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
color-spantrace = "0.2"
|
|
tracing = "0.1"
|
|
tracing-error = "0.2"
|
|
tracing-subscriber = "0.3"
|
|
```
|
|
|
|
Setup a tracing subscriber with an `ErrorLayer`:
|
|
|
|
```rust
|
|
use tracing_error::ErrorLayer;
|
|
use tracing_subscriber::{prelude::*, registry::Registry};
|
|
|
|
Registry::default().with(ErrorLayer::default()).init();
|
|
```
|
|
|
|
Create spans and enter them:
|
|
|
|
```rust
|
|
use tracing::instrument;
|
|
use tracing_error::SpanTrace;
|
|
|
|
#[instrument]
|
|
fn foo() -> SpanTrace {
|
|
SpanTrace::capture()
|
|
}
|
|
```
|
|
|
|
And finally colorize the `SpanTrace`:
|
|
|
|
```rust
|
|
use tracing_error::SpanTrace;
|
|
|
|
let span_trace = SpanTrace::capture();
|
|
println!("{}", color_spantrace::colorize(&span_trace));
|
|
```
|
|
|
|
## Example
|
|
|
|
This example is taken from `examples/usage.rs`:
|
|
|
|
```rust
|
|
use tracing::instrument;
|
|
use tracing_error::{ErrorLayer, SpanTrace};
|
|
use tracing_subscriber::{prelude::*, registry::Registry};
|
|
|
|
#[instrument]
|
|
fn main() {
|
|
Registry::default().with(ErrorLayer::default()).init();
|
|
|
|
let span_trace = one(42);
|
|
println!("{}", color_spantrace::colorize(&span_trace));
|
|
}
|
|
|
|
#[instrument]
|
|
fn one(i: u32) -> SpanTrace {
|
|
two()
|
|
}
|
|
|
|
#[instrument]
|
|
fn two() -> SpanTrace {
|
|
SpanTrace::capture()
|
|
}
|
|
```
|
|
|
|
This creates the following output
|
|
|
|
### Minimal Format
|
|
|
|
|
|
|
|
### Full Format
|
|
|
|
|
|
|
|
#### License
|
|
|
|
<sup>
|
|
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
|
|
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
|
|
</sup>
|
|
|
|
<br>
|
|
|
|
<sub>
|
|
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.
|
|
</sub>
|
|
|
|
[`tracing_error::SpanTrace`]: https://docs.rs/tracing-error/*/tracing_error/struct.SpanTrace.html
|
|
[`color-backtrace`]: https://github.com/athre0z/color-backtrace
|