itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-02 15:24:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
tracing/tracing-core
History
Eliza Weisman e5994dfff1
core: update dispatcher documentation (#171) 
## Motivation

The `tracing-core::dispatcher` module is currently somewhat
under-documented, which has caused confusion for many users. There
should be a detailed description of how traces are dispatched, and the
different methods of setting a default subscriber. In addition, the
`tokio` feature flag that enables automatic dispatcher propagation is
undocumented, which has also caused issues (see  #169).

## Solution

This branch adds new module-level docs to the `dispatcher` module,
including examples of how default subscribers are set. It also corrects
a factual error in the documentation for `with_default`.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
2019-07-10 15:47:35 -07:00
..
src
core: update dispatcher documentation (#171)
2019-07-10 15:47:35 -07:00
tests
Fix typos. (#128)
2019-07-01 10:14:14 -07:00
Cargo.toml
core: prepare for 0.1.1 (#155)
2019-07-06 11:18:03 -07:00
CHANGELOG.md
core: prepare for 0.1.1 (#155)
2019-07-06 11:18:03 -07:00
LICENSE
meta: rename everything to tracing (#99)
2019-06-26 11:31:07 -07:00
README.md
core: prepare for 0.1.1 (#155)
2019-07-06 11:18:03 -07:00

README.md

tracing-core

Core primitives for application-level tracing.

Crates.io Documentation MIT licensed Build Status Gitter chat

Documentation | Chat

Overview

tracing is a framework for instrumenting Rust programs to collect structured, event-based diagnostic information. This crate defines the core primitives of tracing.

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 Spans.

  • Field, FieldSet, Value, and ValueSet represent the structured data attached to a Span.

  • Dispatch allows span events to be dispatched to Subscribers.

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 tracing 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.

License

This project is licensed under the MIT 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.