mirror of https://github.com/tokio-rs/tracing.git synced 2026-03-19 06:12:30 +00:00

Files

Eliza Weisman ae482f3829 examples: fix tower-util deprecation, remove broken examples (#645 )

## Motivation

A recent change to `tower-util` contains a deprecation in `ServiceExt`.
The deprecation means that the `deny(warnings)` CI build fails for the
`tower-load` example.

Additionally, the `tower-h2` examples depend on a Git version of
`tower-h2`. These examples are currently commented out, since they used
an earlier version of `tower-h2`, but their dependencies are still
specified in the `examples` crate.

## Solution

I removed the use of the deprecated `ready` method.

Furthermore, I removed the broken `tower-h2` examples, and thus the git
dependency on a different version of Tower. There are 3 other examples
(`tower-client`, `tower-server`, and `tower-load`) that also demonstrate
using `tracing` together with Tower, so these broken examples aren't
really worth keeping around.

This ought to fix CI.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>

2020-03-30 12:40:49 -07:00

examples

examples: fix tower-util deprecation, remove broken examples (#645 )

2020-03-30 12:40:49 -07:00

Cargo.toml

examples: fix tower-util deprecation, remove broken examples (#645 )

2020-03-30 12:40:49 -07:00

README.md

examples: fix tower-util deprecation, remove broken examples (#645 )

2020-03-30 12:40:49 -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.
- async_fn: Demonstrates how asynchronous functions can be instrumented.
- echo: Demonstrates a tracing-instrumented variant of Tokio's echo example.
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.