mirror of
https://github.com/tokio-rs/tokio.git
synced 2025-09-28 12:10:37 +00:00
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
# tokio-trace-core
|
|
|
|
Core primitives for `tokio-trace`.
|
|
|
|
[Documentation](https://tokio-rs.github.io/tokio/doc/tokio_trace_core/index.html)
|
|
|
|
## Overview
|
|
|
|
`tokio-trace` is a framework for instrumenting Rust programs to collect
|
|
structured, event-based diagnostic information. This crate defines the core
|
|
primitives of `tokio-trace`.
|
|
|
|
The crate provides:
|
|
|
|
* [`Span`] identifies a span within the execution of a program.
|
|
|
|
* [`Event`] represents a single event within a trace.
|
|
|
|
* [`Subscriber`], the trait implemented to collect trace data.
|
|
|
|
* [`Metadata`] and [`Callsite`] provide information describing `Span`s.
|
|
|
|
* [`Field`], [`FieldSet`], [`Value`], and [`ValueSet`] represent the
|
|
structured data attached to a `Span`.
|
|
|
|
* [`Dispatch`] allows span events to be dispatched to `Subscriber`s.
|
|
|
|
In addition, it defines the global callsite registry and per-thread current
|
|
dispatcher which other components of the tracing system rely on.
|
|
|
|
Application authors will typically not use this crate directly. Instead, they
|
|
will use the [`tokio-trace`] crate, which provides a much more fully-featured
|
|
API. However, this crate's API will change very infrequently, so it may be used
|
|
when dependencies must be very stable.
|
|
|
|
[`tokio-trace`]: ../
|
|
[`Span`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/span/struct.Span.html
|
|
[`Event`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/event/struct.Event.html
|
|
[`Subscriber`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/subscriber/trait.Subscriber.html
|
|
[`Metadata`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/metadata/struct.Metadata.html
|
|
[`Callsite`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/callsite/trait.Callsite.html
|
|
[`Field`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/struct.Field.html
|
|
[`FieldSet`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/struct.FieldSet.html
|
|
[`Value`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/trait.Value.html
|
|
[`ValueSet`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/struct.ValueSet.html
|
|
[`Dispatch`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/dispatcher/struct.Dispatch.html
|
|
|
|
## License
|
|
|
|
This project is licensed under the [MIT license](LICENSE).
|
|
|
|
### Contribution
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in Tokio by you, shall be licensed as MIT, without any additional
|
|
terms or conditions.
|