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

Files

T

Eliza Weismanandcsmoe 847fb59b17 trace-core: Introduce callsite classification in metadata (#1046 )

## Motivation

To ease the implementation of `Subscriber::register_callsite`, a field
should be added to `Metadata` to indicate if this callsite is an event or
a span.

## Solution

A new struct, `Kind`, is added to the `metadata` module in
`tokio-trace-core`, and a `Kind` field is added to the `Metadata`
struct. Macros which construct `metadata` now require a `Kind`.

`Kind` is represented as a struct with a private inner enum to allow new
`Kind`s to be added without breaking changes. However, the _addition_ of
the kind field _is_ a breaking change. While this could be done in a
backward-compatible way, it would permit the construction of metadata
with unknown kinds, and since the next `tokio-trace-core` release will
be a breaking change, I opted to make the breaking change instead.

New API tests for the `callsite!` and `metadata!` macros have been added
to guard against future API breakage.

Fixes: #986
Closes: #1008

Co-Authored-By: csmoe <[email protected]>

2019-04-11 11:56:42 -07:00

src

trace-core: Introduce callsite classification in metadata (#1046 )

2019-04-11 11:56:42 -07:00

tests

trace-core: Introduce callsite classification in metadata (#1046 )

2019-04-11 11:56:42 -07:00

Cargo.toml

trace-core: add a function to rebuild cached interest (#1039 )

2019-04-10 13:51:05 -07:00

CHANGELOG.md

Prepare tokio-trace-core for initial release. (#979 )

2019-03-13 10:29:27 -07:00

LICENSE

Introduce tokio-trace (#827 )

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

README.md

Prepare tokio-trace-core for initial release. (#979 )

2019-03-13 10:29:27 -07: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.