Crate prima_datadog
source ·Expand description
This is an opinionated library to share code and approach to Datadog logging in prima.it
Getting started
You need to call Datadog::init in your main binary, and to do so you’ll need as argument a type that implements the Configuration trait. If you never call Datadog::init in your binary NO metrics will be sent.
Inside the configuration you’ll find an implementation of this trait tailored for prima.it needs.
use prima_datadog::{*, configuration::PrimaConfiguration};
// initializes the PrimaConfiguration struct
let configuration = PrimaConfiguration::new(
"0.0.0.0:1234", // to address
"0.0.0.0:0", // from address
"service_name", // namespace for all metrics
"production".parse().unwrap() // environment
);
// Initializes a Datadog instance
Datadog::init(configuration);Then you can use the macros exposed at the base level of the module. All macros accepts
- a string value or a path to a type that implements AsRef
as first argument. - zero or more arguments, separated by comma
,, for the metrics that needs more data. For examplecount!andtiming!accepts a number whileservice_check!accepts a ServiceStatus and a ServiceCheckOptions - a list of tags (which is separated from the rest of the arguments by semicolon
;) in the form of"name" => "value"
incr!("test");
decr!("test"; "some" => "data");
count!("test", 20);
count!("test", 10; "some" => "data");
time!("test", || { println!("expensive computation");});
time!("test", || { println!("expensive computation");}; "some" => "data");
timing!("test", 20; "some" => "data");
gauge!("test", "gauge value"; "some" => "data");
histogram!("test", "histogram value"; "some" => "data");
distribution!("test", "distribution value"; "some" => "data");
set!("test", "set value"; "some" => "data");
service_check!("test", ServiceStatus::OK);
service_check!("test", ServiceStatus::OK, ServiceCheckOptions::default());
event!("test", "test event"; "some" => "data");This is an example of a custom metric, in this case based on an enum type, but it can really be whatever you want, as long as it implements AsRef
enum Metric {
John,
Paul,
George,
Ringo,
}
impl AsRef<str> for Metric {
fn as_ref(&self) -> &str {
match self {
Metric::John => "john",
Metric::Paul => "paul",
Metric::George => "george",
Metric::Ringo => "ringo",
}
}
}
// now you can do
incr!(Metric::John; "play" => "guitar");
incr!(Metric::Paul; "play" => "bass");
incr!(Metric::George; "play" => "sitar");
incr!(Metric::Ringo; "play" => "drums");Note - Avoid high tag cardinality!
It’s important to avoid passing a large number of values for a given tag, as Datadog tracks each unique combination of tag values as a separate metric, which can significantly impact billing. For example, avoid passing things like user IDs, session IDs, request IDs, or other values that vary significantly. See https://docs.datadoghq.com/getting_started/tagging/ for more information.
Users may configure some actions to be taken when a metric cardinality threshold is exceeded. See tracker::TagTrackerConfiguration for more information.
References
Re-exports
pub use tracker::*;