mirror of https://github.com/tokio-rs/tokio.git synced 2026-09-07 00:00:08 +02:00

Files

T

Eliza Weisman 4313d65b38 trace: Switch to using local_inner_macros for instrumentation API (#969 )

## Motivation

Currently, it isn't possible to import individual macros from
`tokio-trace` using the macros 1.2 syntax:

```rust
use tokio_trace::{debug, info, span};
```

This is because these macros require that `callsite` and `enabled` are
imported as well.

## Solution

This branch resolves the problem by adding the [`local_inner_macros`]
attribute to the instrumentation API's macros. This allows other macros
from within the crate to be used without requiring them to be explicitly
imported. 

However, this also requires duplicating any macros from other sources
(such as std and `tokio-trace-core`) with wrappers due to the behaviour
of `local_inner_macros`. I've added these wrapper macros as well.

Since the macros got even longer as a result of this, I've moved them
to a separate file to make `lib.rs` easier to read. I've also wrapped
some very long lines in the macros, and removed the explicit drop of
the result of evaluating some event macros (it's no longer necessary
as all event macros now evaluate to `()`).

[`local_inner_macros`]: https://doc.rust-lang.org/nightly/edition-guide/rust-2018/macros/macro-changes.html#local-helper-macros

Fixes #968

Signed-off-by: Eliza Weisman <[email protected]>

2019-03-11 14:48:23 -07:00

src

trace: Switch to using local_inner_macros for instrumentation API (#969 )

2019-03-11 14:48:23 -07:00

Cargo.toml

Introduce tokio-trace (#827 )

2019-02-19 12:15:01 -08:00

LICENSE

Introduce tokio-trace (#827 )

2019-02-19 12:15:01 -08:00

README.md

trace: Fix tokio-trace documentation url in the README (#939 )

2019-03-01 15:31:59 -08:00

README.md

tokio-trace-core

Core primitives for tokio-trace.

Documentation

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

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.