itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-09-28 12:10:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

trace: Minor doc improvements (#913)

Browse Source 
This branch adds links to the master RustDoc published by CI to the
`tokio-trace` and `tokio-trace-core` README. In addition, it fixes a
broken links in the RustDoc for `tokio-trace` and updates the
`tokio-trace-core` RustDoc to match the README.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
This commit is contained in:
Eliza Weisman 2019-02-22 11:07:53 -08:00 committed by GitHub
parent 80162306e7
commit 02a5091885
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 43 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tokio-trace/README.md
View File

@ -2,6 +2,8 @@
A scoped, structured logging and diagnostics system.
[Documentation](https://tokio-rs.github.io/tokio/tokio_trace/index.html)
## Overview
`tokio-trace` is a framework for instrumenting Rust programs to collect
@ -156,6 +158,7 @@ be used with the `tokio-trace` ecosystem. It includes a collection of
`Subscriber` implementations, as well as utility and adapter crates.
[`log`]: https://docs.rs/log/0.4.6/log/
[`tokio-trace-nursery`]: https://github.com/tokio-rs/tokio-trace-nursery
## License

2
tokio-trace/src/lib.rs
View File

@ -292,7 +292,7 @@
//! [`exit`]: subscriber/trait.Subscriber.html#tymethod.exit
//! [`enabled`]: subscriber/trait.Subscriber.html#tymethod.enabled
//! [metadata]: struct.Metadata.html
//! [`tokio-trace-nursury`]: https://github.com/tokio-rs/tokio-trace-nursery
//! [`tokio-trace-nursery`]: https://github.com/tokio-rs/tokio-trace-nursery
extern crate tokio_trace_core;
// Somehow this `use` statement is necessary for us to re-export the `core`

26
tokio-trace/tokio-trace-core/README.md
View File

@ -2,6 +2,8 @@
Core primitives for `tokio-trace`.
[Documentation](https://tokio-rs.github.io/tokio/tokio_trace_core/index.html)
## Overview
`tokio-trace` is a framework for instrumenting Rust programs to collect
@ -10,16 +12,18 @@ primitives of `tokio-trace`.
The crate provides:
* `Span` identifies a span within the execution of a program.
* [`Span`] identifies a span within the execution of a program.
* `Subscriber`, the trait implemented to collect trace data.
* [`Event`] represents a single event within a trace.
* `Metadata` and `Callsite` provide information describing `Span`s.
* [`Subscriber`], the trait implemented to collect trace data.
* `Field` and `FieldSet` describe and access the structured data attached to a
`Span`.
* [`Metadata`] and [`Callsite`] provide information describing `Span`s.
* `Dispatch` allows span events to be dispatched to `Subscriber`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.
@ -30,6 +34,16 @@ 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/tokio_trace_core/span/struct.Span.html
[`Event`]: https://tokio-rs.github.io/tokio/tokio_trace_core/event/struct.Event.html
[`Subscriber`]: https://tokio-rs.github.io/tokio/tokio_trace_core/subscriber/trait.Subscriber.html
[`Metadata`]: https://tokio-rs.github.io/tokio/tokio_trace_core/metadata/struct.Metadata.html
[`Callsite`]: https://tokio-rs.github.io/tokio/tokio_trace_core/callsite/trait.Callsite.html
[`Field`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/struct.Field.html
[`FieldSet`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/struct.FieldSet.html
[`Value`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/trait.Value.html
[`ValueSet`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/struct.ValueSet.html
[`Dispatch`]: https://tokio-rs.github.io/tokio/tokio_trace_core/dispatcher/struct.Dispatch.html
## License

30
tokio-trace/tokio-trace-core/src/lib.rs
View File

@ -7,16 +7,18 @@
//! structured, event-based diagnostic information. This crate defines the core
//! primitives of `tokio-trace`.
//!
//! The crate provides:
//! This 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`] and [`FieldSet`] describe and access the structured data attached to
//! a `Span`.
//! * [`Field`], [`FieldSet`], [`Value`], and [`ValueSet`] represent the
//! structured data attached to a `Span`.
//!
//! * [`Dispatch`] allows span events to be dispatched to `Subscriber`s.
//!
@ -28,15 +30,21 @@
//! fully-featured API. However, this crate's API will change very infrequently,
//! so it may be used when dependencies must be very stable.
//!
//! [`Span`]: ::span::Span
//! [`Subscriber`]: ::subscriber::Subscriber
//! [`Metadata`]: ::metadata::Metadata
//! [`Callsite`]: ::callsite::Callsite
//! [`Field`]: ::field::Field
//! [`FieldSet`]: ::field::FieldSet
//! [`Dispatch`]: ::dispatcher::Dispatch
//! The [`tokio-trace-nursery`] repository contains less stable crates designed to
//! be used with the `tokio-trace` ecosystem. It includes a collection of
//! `Subscriber` implementations, as well as utility and adapter crates.
//!
//! [`Span`]: span/struct.Span.html
//! [`Event`]: event/struct.Event.html
//! [`Subscriber`]: subscriber/trait.Subscriber.html
//! [`Metadata`]: metadata/struct.Metadata.html
//! [`Callsite`]: callsite/trait.Callsite.html
//! [`Field`]: field/struct.Field.html
//! [`FieldSet`]: field/struct.FieldSet.html
//! [`Value`]: field/trait.Value.html
//! [`ValueSet`]: field/struct.ValueSet.html
//! [`Dispatch`]: dispatcher/struct.Dispatch.html
//! [`tokio-trace-nursery`]: https://github.com/tokio-rs/tokio-trace-nursery
#[macro_use]
extern crate lazy_static;