Struct prima_datadog::Datadog

source · [−]

pub struct Datadog { /* private fields */ }

Expand description

The Datadog struct is the main entry point for the library

Implementations

source

impl Datadog

source

pub fn init(configuration: impl Configuration) -> Result<(), Error>

Initializes a Datadog instance with a struct that implements the Configuration trait. Make sure that you run it only once otherwise you will get an error.

source

pub fn new(
client: impl 'static + DogstatsdClient + Send + Sync,
is_reporting_enabled: bool
) -> Self

initialize a Datadog instance with bare parameters. This should be used carefully. Use Datadog::init instead

source

pub fn global() -> &'static Datadog

source

pub fn is_reporting_enabled(&self) -> bool

source

pub fn incr(
 &self,
 metric: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>
)

Increment a StatsD counter

source

pub fn decr(
 &self,
 metric: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>
)

Decrement a StatsD counter

source

pub fn count(
 &self,
 metric: impl AsRef<str>,
 count: i64,
 tags: impl IntoIterator<Item = String>
)

Make an arbitrary change to a StatsD counter

source

pub fn time(
 &self,
 metric: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>,
 block: impl FnOnce() + 'static
)

Time a block of code (reports in ms)

source

pub fn timing(
 &self,
 metric: impl AsRef<str>,
 ms: i64,
 tags: impl IntoIterator<Item = String>
)

Send your own timing metric in milliseconds

source

pub fn gauge(
 &self,
 metric: impl AsRef<str>,
 value: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>
)

Report an arbitrary value as a gauge

source

pub fn histogram(
 &self,
 metric: impl AsRef<str>,
 value: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>
)

Report a value in a histogram

source

pub fn distribution(
 &self,
 metric: impl AsRef<str>,
 value: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>
)

Report a value in a distribution

source

pub fn set(
 &self,
 metric: impl AsRef<str>,
 value: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>
)

Report a value in a set

source

pub fn service_check(
 &self,
 metric: impl AsRef<str>,
 value: ServiceStatus,
 tags: impl IntoIterator<Item = String>,
 options: Option<ServiceCheckOptions>
)

Report the status of a service

source

pub fn event(
 &self,
 metric: impl AsRef<str>,
 text: impl AsRef<str>,
 tags: impl IntoIterator<Item = String>
)

Send a custom event as a title and a body

Auto Trait Implementations

impl !RefUnwindSafe for Datadog

impl Send for Datadog

impl Sync for Datadog

impl Unpin for Datadog

impl !UnwindSafe for Datadog

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct prima_datadog::Datadog

Implementations

impl Datadog

pub fn init(configuration: impl Configuration) -> Result<(), Error>

pub fn new( client: impl 'static + DogstatsdClient + Send + Sync, is_reporting_enabled: bool) -> Self

pub fn global() -> &'static Datadog

pub fn is_reporting_enabled(&self) -> bool

pub fn incr( &self, metric: impl AsRef<str>, tags: impl IntoIterator<Item = String>)

pub fn decr( &self, metric: impl AsRef<str>, tags: impl IntoIterator<Item = String>)

pub fn count( &self, metric: impl AsRef<str>, count: i64, tags: impl IntoIterator<Item = String>)

pub fn time( &self, metric: impl AsRef<str>, tags: impl IntoIterator<Item = String>, block: impl FnOnce() + 'static)

pub fn timing( &self, metric: impl AsRef<str>, ms: i64, tags: impl IntoIterator<Item = String>)

pub fn gauge( &self, metric: impl AsRef<str>, value: impl AsRef<str>, tags: impl IntoIterator<Item = String>)

pub fn histogram( &self, metric: impl AsRef<str>, value: impl AsRef<str>, tags: impl IntoIterator<Item = String>)

pub fn distribution( &self, metric: impl AsRef<str>, value: impl AsRef<str>, tags: impl IntoIterator<Item = String>)

pub fn set( &self, metric: impl AsRef<str>, value: impl AsRef<str>, tags: impl IntoIterator<Item = String>)

pub fn service_check( &self, metric: impl AsRef<str>, value: ServiceStatus, tags: impl IntoIterator<Item = String>, options: Option<ServiceCheckOptions>)

pub fn event( &self, metric: impl AsRef<str>, text: impl AsRef<str>, tags: impl IntoIterator<Item = String>)

Auto Trait Implementations

impl !RefUnwindSafe for Datadog

impl Send for Datadog

impl Sync for Datadog

impl Unpin for Datadog

impl !UnwindSafe for Datadog

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn new(
client: impl 'static + DogstatsdClient + Send + Sync,
is_reporting_enabled: bool
) -> Self

pub fn incr(
&self,
metric: impl AsRef<str>,
tags: impl IntoIterator<Item = String>
)

pub fn decr(
&self,
metric: impl AsRef<str>,
tags: impl IntoIterator<Item = String>
)

pub fn count(
&self,
metric: impl AsRef<str>,
count: i64,
tags: impl IntoIterator<Item = String>
)

pub fn time(
&self,
metric: impl AsRef<str>,
tags: impl IntoIterator<Item = String>,
block: impl FnOnce() + 'static
)

pub fn timing(
&self,
metric: impl AsRef<str>,
ms: i64,
tags: impl IntoIterator<Item = String>
)

pub fn gauge(
&self,
metric: impl AsRef<str>,
value: impl AsRef<str>,
tags: impl IntoIterator<Item = String>
)

pub fn histogram(
&self,
metric: impl AsRef<str>,
value: impl AsRef<str>,
tags: impl IntoIterator<Item = String>
)

pub fn distribution(
&self,
metric: impl AsRef<str>,
value: impl AsRef<str>,
tags: impl IntoIterator<Item = String>
)

pub fn set(
&self,
metric: impl AsRef<str>,
value: impl AsRef<str>,
tags: impl IntoIterator<Item = String>
)

pub fn service_check(
&self,
metric: impl AsRef<str>,
value: ServiceStatus,
tags: impl IntoIterator<Item = String>,
options: Option<ServiceCheckOptions>
)

pub fn event(
&self,
metric: impl AsRef<str>,
text: impl AsRef<str>,
tags: impl IntoIterator<Item = String>
)

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,