Crate tracing_futures

Futures compatibility for tracing.

Overview

tracing is a framework for instrumenting Rust programs to collect structured, event-based diagnostic information. This crate provides utilities for using tracing to instrument asynchronous code written using futures and async/await.

The crate provides the following traits:

• Instrument allows a tracing span to be attached to a future, sink, stream, or executor.

• WithSubscriber allows a tracing Subscriber to be attached to a future, sink, stream, or executor.

Feature flags

This crate provides a number of feature flags that enable compatibility features with other crates in the asynchronous ecosystem:

• tokio: Enables compatibility with the tokio crate, including Instrument and WithSubscriber implementations for tokio::executor::Executor, tokio::runtime::Runtime, and tokio::runtime::current_thread. Enabled by default.

• tokio-executor: Enables compatibility with the tokio-executor crate, including Instrument and WithSubscriber implementations for types implementing tokio_executor::Executor. This is intended primarily for use in crates which depend on tokio-executor rather than tokio; in general the tokio feature should be used instead.

• std-future: Enables compatibility with std::future::Future.

• futures-01: Enables compatibility with version 0.1.x of the futures crate.

• futures-03: Enables compatibility with version 0.3.x of the futures crate's Spawn and LocalSpawn traits.

• tokio-alpha: Enables compatibility with tokio 0.2's alpha releases, including the tokio 0.2 Executor and TypedExecutor traits.

• std: Depend on the Rust standard library.

  no_std users may disable this feature with default-features = false:

  [dependencies]
  tracing-futures = { version = "0.2.3", default-features = false }
  

The tokio, std-future and std features are enabled by default.

Modules

executor

Implementations for Instrumented future executors.

Structs

Instrumented

A future, stream, sink, or executor that has been instrumented with a tracing span.

Traits

Instrument

Extension trait allowing futures, streams, sinks, and executors to be instrumented with a tracing span.