Skip to content

Commit

Permalink
Document limitation around Counter::absolute etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
jorendorff committed Jan 12, 2024
1 parent 1b5425e commit d74f5a8
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
//! A [`metrics`] exporter that supports reporting metrics to Statsd. This exporter is basically
//! a thin wrapper on top of the [`cadence`] crate which supports Statsd/Datadog style metrics.
//!
//! **Versions of this crate are tightly coupled to metrics crate versions**
//! # Warnings
//!
//! * **Versions of this crate are tightly coupled to metrics crate versions.**
//!
//! * [`metrics::Counter::absolute`], [`metrics::Gauge::increment`], and
//! [`metrics::Gauge::decrement`] are not supported. Statsd doesn't have these concepts.
//! Unfortunately this means that if the application is using these methods, the metrics will
//! silently be missing or wrong.
//!
//! # Usage
//!
Expand Down

0 comments on commit d74f5a8

Please sign in to comment.