mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-02 07:20:35 +00:00

History

chore: specify path dependencies for workspace crates (#568 )

## Motivation

Intra-workspace dependencies can go out of sync if only referencing
crates.io, where changing one crate locally and testing the whole
library will result in errors stemming from two different versions of
the same trait etc. This is hard to keep track of and makes development
more difficult than it needs to be. 

## Solution

Afaik it's common practice to specify both a version and a path as per
[the cargo docs][1]. This is what tokio does with its subcrates too.

[1]: https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/specifying-dependencies.md#multiple-locations.

2020-02-07 10:54:49 -08:00

examples

error: introduce tracing-error crate (#556 )

2020-02-03 09:52:41 -08:00

Cargo.toml

chore: specify path dependencies for workspace crates (#568 )

2020-02-07 10:54:49 -08:00

README.md

Fix small typos (#405 )

2019-10-24 15:12:52 -07: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-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.
- 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.
tracing-futures:
- futures-proxy-server: Demonstrates the use of tracing-futures by implementing a simple proxy server, based on this example from tokio.
- futures-spawn: A simple demonstration of the relationship between the spans representing spawned futures.
tracing-tower:
- tower-h2-client: Demonstrates the use of tracing-tower to instrument a simple tower-h2 HTTP/2 client (based on this example from tower-h2).
- tower-h2-server: Demonstrates the use of tracing-tower to instrument a simple tower-h2 HTTP/2 server (based on this example from tower-h2).
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.

The nightly-examples directory contains examples of how tracing can be used with async/await. These are kept separate as async/await is currently only available on nightly Rust toolchains.