Provides utilities for collecting metrics from a Tokio application, including runtime and per-task metrics.
toml
[dependencies]
tokio-metrics = { version = "0.1.0", default-features = false }
Use TaskMonitor to instrument tasks before spawning them, and to observe
metrics for those tasks. All tasks instrumented with a given TaskMonitor
aggregate their metrics together. To split out metrics for different tasks, use
separate TaskMetrics instances.
```rust // construct a TaskMonitor let monitor = tokio_metrics::TaskMonitor::new();
// print task metrics every 500ms { let frequency = std::time::Duration::from_millis(500); let monitor = monitor.clone(); tokio::spawn(async move { for metrics in monitor.intervals() { println!("{:?}", metrics); tokio::time::sleep(frequency).await; } }); }
// instrument some tasks and spawn them loop { tokio::spawn(monitor.instrument(do_work())); } ```
This unstable functionality requires tokio_unstable, and the rt crate
feature. To enable tokio_unstable, the --cfg tokio_unstable must be passed
to rustc when compiling. You can do this by setting the RUSTFLAGS
environment variable before compiling your application; e.g.:
sh
RUSTFLAGS="--cfg tokio_unstable" cargo build
Or, by creating the file .cargo/config in the root directory of your crate
with the contents:
toml
[build]
rustflags = ["--cfg", "tokio_unstable"]
rustdocflags = ["--cfg", "tokio_unstable"]
The rt feature of tokio-metrics is on by default; simply check that you do
not set default-features = false when declaring it as a dependency; e.g.:
toml
[dependencies]
tokio-metrics = "0.1.0"
From within a Tokio runtime, use RuntimeMonitor to monitor key metrics of
that runtime.
```rust
let handle = tokio::runtime::Handle::current();
let runtime_monitor = RuntimeMonitor::new(&handle);
// print runtime metrics every 500ms let frequency = std::time::Duration::frommillis(500); tokio::spawn(async move { for metrics in runtimemonitor.intervals() { println!("Metrics = {:?}", metrics); tokio::time::sleep(frequency).await; } });
// run some tasks tokio::spawn(dowork()); tokio::spawn(dowork()); tokio::spawn(do_work()); ```
Currently, Tokio Console is primarily intended for local debugging. Tokio
metrics is intended to enable reporting of metrics in production to your
preferred tools. Longer term, it is likely that tokio-metrics will merge with
Tokio Console.
This project is licensed under the [MIT license].
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in tokio-metrics by you, shall be licensed as MIT, without any additional terms or conditions.