pub struct UdpMetricSink { /* private fields */ }
Expand description

Implementation of a MetricSink that emits metrics over UDP.

This is the most basic version of MetricSink that sends metrics over UDP. It accepts a UDP socket instance over which to write metrics and the address of the Statsd server to send packets to.

Each metric is sent to the Statsd server when the .emit() method is called, in the thread of the caller.

Implementations

Construct a new UdpMetricSink instance.

The address should be the address of the remote metric server to emit metrics to over UDP. The socket should already be bound to a local address with any desired configuration applied (blocking vs non-blocking, timeouts, etc.).

Example
use std::net::UdpSocket;
use cadence::{UdpMetricSink, DEFAULT_PORT};

let socket = UdpSocket::bind("0.0.0.0:0").unwrap();
let host = ("metrics.example.com", DEFAULT_PORT);
let sink = UdpMetricSink::from(host, socket);

To send metrics over a non-blocking socket, simply put the socket in non-blocking mode before creating the UDP metric sink.

Non-blocking Example

Note that putting the UDP socket into non-blocking mode is the default when sink and socket are automatically created with the StatsdClient::from_udp_host method.

use std::net::UdpSocket;
use cadence::{UdpMetricSink, DEFAULT_PORT};

let socket = UdpSocket::bind("0.0.0.0:0").unwrap();
socket.set_nonblocking(true).unwrap();
let host = ("metrics.example.com", DEFAULT_PORT);
let sink = UdpMetricSink::from(host, socket);
Failures

This method may fail if:

  • It is unable to resolve the hostname of the metric server.
  • The host address is otherwise unable to be parsed

Trait Implementations

Formats the value using the given formatter. Read more

Send the Statsd metric using this sink and return the number of bytes written or an I/O error. Read more

Flush any currently buffered metrics to the underlying backend, returning an I/O error if they could not be written for some reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.