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

History

core: add initial support for valuable field values (#1608 )

This branch adds initial support for using the [`valuable`] crate as an
opt-in `Value` type in `tracing`. `valuable` provides a mechanism for
defining custom ways to record user-implemented types, as well as
structured recording of standard library data structures such as maps,
arrays, and sets.

For more details, see the tracking issue #1570.

In `tracing` v0.2, the intent is for `valuable` to replace the existing
`tracing_core::field::Value` trait. However, in v0.1.x, `valuable`
support must be added in a backwards-compatible way, so recording types
that implement `valuable::Valueable` currently requires opting in using
a `field::valuable` wrapper function.

Since this is the first release of `valuable` and the API is still
stabilizing, we don't want to tie `tracing-core`'s stability to
`valuable`'s. Therefore, the valuable dependency is feature-flagged
*and* also requires `RUSTFLAGS="--cfg tracing_unstable"`.

[`valuable`]: https://github.com/tokio-rs/valuable

Co-authored-by: Daniel McKenna <daniel@emotech.co>
Co-authored-by: David Barsky <me@davidbarsky.com>
Co-authored-by: Eliza Weisman <eliza@buoyant.io>

2022-01-21 21:29:38 +00:00

examples

core: add initial support for valuable field values (#1608 )

2022-01-21 21:29:38 +00:00

Cargo.toml

core: add initial support for valuable field values (#1608 )

2022-01-21 21:29:38 +00:00

README.md

subscriber: add Format::with_file and with_line_number (#1773 )

2022-01-14 12:12:09 -08:00

README.md

Tracing Examples

This directory contains a collection of examples that demonstrate the use of the tracing ecosystem:

tracing:
- counters: Implements a very simple metrics system to demonstrate how subscribers can consume field values as typed data.
- sloggish: A demo Subscriber implementation that mimics the output of slog-term's Compact formatter.
tracing-attributes:
- attrs-basic: A simple example of the #[instrument] attribute.
- attrs-literal-field-names: Demonstrates using literal field names rather than rust tokens..
- attrs-args: An example implementing a simple recursive calculation of Fibonacci numbers, to demonstrate how the #[instrument] attribute can record function arguments.
tracing-subscriber:
- fmt: Demonstrates the use of the fmt module in tracing-subscriber, which provides a subscriber implementation that logs traces to the console.
- fmt-stderr: Demonstrates overriding the output stream used by the fmt subscriber.
- fmt-custom-field: Demonstrates overriding how the fmt subscriber formats fields on spans and events.
- fmt-custom-event: Demonstrates overriding how the fmt subscriber formats events.
- fmt-multiple-writers.rs: demonstrates how fmt::Layer can write to multiple destinations (in this instance, stdout and a file) simultaneously.
- fmt-source-locations.rs: demonstrates displaying source code locations with fmt::Layer.
- subscriber-filter: Demonstrates the tracing-subscriber::filter module, which provides a layer which adds configurable filtering to a subscriber implementation.
- tower-load: Demonstrates how dynamically reloadable filters can be used to debug a server under load in production.
- journald: Demonstrates how to use fmt and journald layers to output to both the terminal and the system journal.
- toggle-layers : Demonstrates how Layers can be wrapped with an Option allowing them to be dynamically toggled.
tracing-futures:
- spawny-thing: Demonstrates the use of the #[instrument] attribute macro asynchronous functions.
- tokio-spawny-thing.rs: Similar to spawny-thingy, but with the additional demonstration instrumenting concurrent tasks created with tokio::spawn.
- futures-proxy-server: Demonstrates the use of tracing-futures by implementing a simple proxy server, based on this example from tokio.
- async_fn: Demonstrates how asynchronous functions can be instrumented.
- echo: Demonstrates a tracing-instrumented variant of Tokio's echo example.
tracing-flame:
- infero-flame: Demonstrates the use of tracing-flame to generate a flamegraph from spans.
tracing-tower:
- tower-client: Demonstrates the use of tracing-tower to instrument a simple tower HTTP/1.1 client.
- tower-server: Demonstrates the use of tracing-tower to instrument a simple tower HTTP/1.1 server.
tracing-serde:
- serde-yak-shave: Demonstrates the use of tracing-serde by implementing a subscriber that emits trace output as JSON.
tracing-log:
- hyper-echo: Demonstrates how tracing-log can be used to record unstructured logs from dependencies as tracing events, by instrumenting this example from hyper, and using tracing-log to record logs emitted by hyper.
tracing-opentelemetry:
- opentelemetry: Demonstrates how tracing-opentelemetry can be used to export and visualize tracing span data.
- opentelemetry-remote-context: Demonstrates how tracing-opentelemetry can be used to extract and inject remote context when traces span multiple systems.