mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-02 15:24:47 +00:00

History

Eliza Weisman e63d8e454b core: add Subscriber impl for Box<dyn Subscriber + ...> (#1358 )

In some cases, users may wish to erase the type of a `Subscriber`
implementation, such as when it is dynamically constructed from a
complex parameterized type. When doing so, it's important to ensure that
all trait methods with default implementations are properly forwarded to
the inner erased type. For example, if the type does not implement
`try_close`, but the inner erased subscriber does, then the the
subscriber will not be notified when spans close — which could result in
a memory leak.

To avoid potential footguns resulting from users implementing
type-erased subscribers incorrectly, this branch adds a new `impl
Subscriber for Box<dyn Subscriber + Send + Sync + 'static>` in
`tracing-core`. This is also somewhat more ergonomic than any solution
in another crate, since the implementation  is for `Box<dyn Subscriber +
...>` directly, rather than some `BoxedSubscriber` newtype.

2021-04-30 11:27:10 -07:00

src

core: add Subscriber impl for Box<dyn Subscriber + ...> (#1358 )

2021-04-30 11:27:10 -07:00

tests

core: Add set_default method to set default dispatcher (#388 )

2019-10-18 11:56:33 -07:00

Cargo.toml

core: make Level and LevelFilter Copy (#992 )

2020-09-28 09:06:38 -07:00

CHANGELOG.md

core: prepare to release 0.1.17 (#996 )

2020-09-28 10:39:22 -07:00

LICENSE

meta: rename everything to tracing (#99 )

2019-06-26 11:31:07 -07:00

README.md

chore: fix nightly clippy warnings (#991 ) (#1025 )

2020-10-07 14:10:49 -07:00

README.md

tracing-core

Core primitives for application-level tracing.

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::Id 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 and events.
Field, FieldSet, Value, and ValueSet represent the structured data attached to spans and events.
Dispatch allows spans and 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.

Compiler support: requires rustc 1.42+

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.17", default-features = false }
```
Note:tracing-core's no_std support requires liballoc.

Supported Rust Versions

Tracing is built against the latest stable release. The minimum supported version is 1.42. The current Tracing version is not guaranteed to build on Rust versions earlier than the minimum supported version.

Tracing follows the same compiler support policies as the rest of the Tokio project. The current stable Rust compiler and the three most recent minor versions before it will always be supported. For example, if the current stable compiler version is 1.45, the minimum supported version will not be increased past 1.42, three minor versions prior. Increasing the minimum supported compiler version is not considered a semver breaking change as long as doing so complies with this policy.

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.