Go to file
Francis Lalonde b904fb795a superdocc 2018-11-12 08:41:00 -05:00
assets Skeptic fix 2018-10-18 10:22:38 -04:00
examples superdoc 2018-10-26 01:20:47 +00:00
schema Adding protobuf prometheus 2018-06-24 09:54:11 -04:00
src superdocc 2018-11-12 08:41:00 -05:00
tests TLS Mock Clock for tests 2018-05-25 12:28:01 -04:00
.directory Raw Bridge 2018-06-21 16:28:25 -04:00
.gitignore superdocc 2018-11-12 08:41:00 -05:00
.travis.yml
CHANGES.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Cargo.toml Save scopes 2018-10-17 16:43:08 -04:00
HANDBOOK.md superdocc 2018-11-12 08:41:00 -05:00
LICENSE-APACHE
LICENSE-MIT
Makefile Skeptic fix 2018-10-18 10:22:38 -04:00
README.md superdocc 2018-11-12 08:41:00 -05:00
README.md.skt.md Skeptic fix 2018-10-18 10:22:38 -04:00
build.rs Updating README 2018-09-19 16:40:08 -04:00

README.md

crates.io docs.rs Build Status

dipstick a dipstick picture

A one-stop shop metrics library for Rust applications with lots of features,
minimal impact on applications and a choice of output to downstream systems.

Features

Dipstick is a toolkit to help all sorts of application collect and send out metrics. As such, it needs a bit of set up to suit one's needs. Skimming through the handbook should help you get an idea of the possible configurations.

In short, dipstick-enabled apps can:

  • Send metrics to console, log, statsd, graphite or prometheus (one or many)
  • Serve metrics over HTTP
  • Locally aggregate the count, sum, mean, min, max and rate of metric values
  • Publish aggregated metrics, on schedule or programmatically
  • Customize output statistics and formatting
  • Define global or scoped (e.g. per request) metrics
  • Statistically sample metrics (statsd)
  • Choose between sync or async operation
  • Choose between buffered or immediate output
  • Switch between metric backends at runtime

For convenience, dipstick builds on stable Rust with minimal, feature-gated dependencies.

Non-goals

Dipstick's focus is on metrics collection (input) and forwarding (output). Although it will happily track aggregated statistics, for the sake of simplicity and performance Dipstick will not

  • plot graphs
  • send alerts
  • track histograms

These are all best done by downstream timeseries visualization and monitoring tools.

Show me the code!

Here's a basic aggregating & auto-publish counter metric:

let bucket = Bucket::new();
bucket.set_target(Stream::stdout());
bucket.flush_every(Duration::from_secs(3));
let counter = bucket.counter("counter_a");
counter.count(8)

Persistent apps wanting to declare static metrics will prefer using the metrics! macro:

metrics! { METRICS = "my_app" => {
        pub COUNTER: Counter = "my_counter";
    }
}

fn main() {
    METRICS.set_target(Graphite::send_to("graphite.com:2003").unwrap().input());
    COUNTER.count(32);
}

For sample applications see the examples. For documentation see the handbook.

To use Dipstick in your project, add the following line to your Cargo.toml in the [dependencies] section:

dipstick = "0.7.0"

License

Dipstick is licensed under the terms of the Apache 2.0 and MIT license.