Struct cadence::UnixMetricSink
source · [−]pub struct UnixMetricSink { /* private fields */ }
Expand description
Implementation of a MetricSink
that emits metrics over a Unix socket.
This is the most basic version of MetricSink
that sends metrics over
a Unix socket. It accepts a Unix socket instance over which to write metrics
and the path of the socket for the Statsd server to send metrics to.
Each metric is sent to the Statsd server when the .emit()
method is
called, in the thread of the caller.
Note that unlike the UDP sinks, if there is no receiving socket at the path specified or nothing listening at the path, an error will be returned when metrics are emitted.
Implementations
sourceimpl UnixMetricSink
impl UnixMetricSink
sourcepub fn from<P>(path: P, socket: UnixDatagram) -> UnixMetricSink where
P: AsRef<Path>,
pub fn from<P>(path: P, socket: UnixDatagram) -> UnixMetricSink where
P: AsRef<Path>,
Construct a new UnixMetricSink
instance.
The socket does not need to be bound (i.e. UnixDatagram::unbound()
is
fine) but should have any desired configuration already applied
(blocking vs non-blocking, timeouts, etc.).
Example
use std::os::unix::net::UnixDatagram;
use cadence::UnixMetricSink;
let socket = UnixDatagram::unbound().unwrap();
let sink = UnixMetricSink::from("/run/statsd.sock", socket);
To send metrics over a non-blocking socket, simply put the socket in non-blocking mode before creating the Unix metric sink.
Non-blocking Example
use std::os::unix::net::UnixDatagram;
use cadence::UnixMetricSink;
let socket = UnixDatagram::unbound().unwrap();
socket.set_nonblocking(true).unwrap();
let sink = UnixMetricSink::from("/run/statsd.sock", socket);
Trait Implementations
sourceimpl Debug for UnixMetricSink
impl Debug for UnixMetricSink
sourceimpl MetricSink for UnixMetricSink
impl MetricSink for UnixMetricSink
Auto Trait Implementations
impl RefUnwindSafe for UnixMetricSink
impl Send for UnixMetricSink
impl Sync for UnixMetricSink
impl Unpin for UnixMetricSink
impl UnwindSafe for UnixMetricSink
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more