tracing/tracing-core
Eliza Weisman f6a375e29d
core: add std::error::Error as a new primitive type (#277)
## Motivation

Currently, errors are typically recorded using their `fmt::Display` or
`fmt::Debug` implementations. This doesn't give the subscriber much
control over how the error is recorded --- in particular, it cannot
decide whether to format the error using `Display` or `Debug`, and it
cannot access the error's `source` or downcast it to another error type.
The `std::error::Error` type is implemented by a majority of errors in
both the standard library and in most crates, so its use is fairly
widespread.

## Solution

This commit adds `dyn std::error::Error + 'static` as a new primitive
type. The `'static` bound is included so that the error can be downcast.

Closes: #222

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
2019-08-15 08:44:10 -07:00
..
2019-08-09 13:27:35 -07:00

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.

Usage

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.

Subscriber implementations may depend on tracing-core rather than tracing, as the additional APIs provided by tracing are primarily useful for instrumenting libraries and applications, and are generally not necessary for Subscriber implementations.

Crate Feature Flags

The following crate feature flags are available:

  • std: Depend on the Rust standard library (enabled by default).

    no_std users may disable this feature with default-features = false:

    [dependencies]
    tracing-core = { version = "0.1.4", default-features = false }
    

    Note:tracing-core's no_std support requires liballoc.

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.