1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
// Cadence - An extensible Statsd client for Rust!
//
// Copyright 2019 Daniel Smith
// Copyright 2019-2021 Nick Pillitteri
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use std::io;
use std::io::Write;
use std::os::unix::net::UnixDatagram;
use std::path::{Path, PathBuf};
use std::sync::Mutex;
use crate::io::MultiLineWriter;
use crate::sinks::core::MetricSink;
// Default size of the buffer for buffered metric sinks. This
// is a rather conservative value, picked for consistency with
// the UDP implementation. Users may want to use a different
// value based on the configuration of the server their
// application is running on.
const DEFAULT_BUFFER_SIZE: usize = 512;
/// 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.
#[derive(Debug)]
pub struct UnixMetricSink {
socket: UnixDatagram,
path: PathBuf,
}
impl UnixMetricSink {
/// 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
///
/// ```no_run
/// 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
///
/// ```no_run
/// 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);
/// ```
pub fn from<P>(path: P, socket: UnixDatagram) -> UnixMetricSink
where
P: AsRef<Path>,
{
UnixMetricSink {
path: path.as_ref().to_path_buf(),
socket,
}
}
}
impl MetricSink for UnixMetricSink {
fn emit(&self, metric: &str) -> io::Result<usize> {
self.socket.send_to(metric.as_bytes(), self.path.as_path())
}
}
/// Adapter for writing to a `UnixDatagram` socket via the `Write` trait
#[derive(Debug)]
pub(crate) struct UnixWriteAdapter {
path: PathBuf,
socket: UnixDatagram,
}
impl UnixWriteAdapter {
fn new<P>(socket: UnixDatagram, path: P) -> UnixWriteAdapter
where
P: AsRef<Path>,
{
UnixWriteAdapter {
path: path.as_ref().to_path_buf(),
socket,
}
}
}
impl Write for UnixWriteAdapter {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.socket.send_to(buf, &self.path)
}
fn flush(&mut self) -> io::Result<()> {
Ok(())
}
}
/// Implementation of a `MetricSink` that buffers metrics before
/// sending them to a Unix socket.
///
/// Metrics are line buffered, meaning that a trailing "\n" is added
/// after each metric written to this sink. When the buffer is sufficiently
/// full and a write is attempted, the contents of the buffer are flushed to
/// a Unix socket and then the metric is written to the buffer. The buffer is
/// also flushed when this sink is destroyed.
///
/// The default size of the buffer is 512 bytes. This is to be consistent with
/// the default for the `BufferedUdpMetricSink`. The buffer size can be customized
/// using the `with_capacity` method to create the sink if desired.
///
/// If a metric larger than the buffer is emitted, it will be written
/// directly to the underlying Unix socket, bypassing the buffer.
///
/// Note that since metrics are buffered until a certain size is reached, it's
/// possible that they may sit in the buffer for a while for applications
/// that do not emit metrics frequently or at a high volume. For these low-
/// throughput use cases, it may make more sense to use the `UnixMetricSink`
/// since it sends metrics immediately with no buffering.
///
/// Also 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 (though this may not happen on every write due to buffering).
#[derive(Debug)]
pub struct BufferedUnixMetricSink {
buffer: Mutex<MultiLineWriter<UnixWriteAdapter>>,
}
impl BufferedUnixMetricSink {
/// Construct a new `BufferedUnixMetricSink` instance with a default
/// buffer size of 512 bytes.
///
/// 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.).
///
/// Writes to this sink are automatically suffixed with a Unix newline
/// ('\n') by the sink and stored in a 512 byte buffer until the buffer
/// is full or this sink is destroyed, at which point the buffer will be
/// flushed.
///
/// # Example
///
/// ```no_run
/// use std::os::unix::net::UnixDatagram;
/// use cadence::BufferedUnixMetricSink;
///
/// let socket = UnixDatagram::unbound().unwrap();
/// let sink = BufferedUnixMetricSink::from("/run/statsd.sock", socket);
/// ```
pub fn from<P>(path: P, socket: UnixDatagram) -> BufferedUnixMetricSink
where
P: AsRef<Path>,
{
Self::with_capacity(path, socket, DEFAULT_BUFFER_SIZE)
}
/// Construct a new `BufferedUnixMetricSink` instance with a custom
/// buffer size.
///
/// The socket does not need to be bound (i.e. `UnixDatagram::unbound()` is
/// fine) but should have with any desired configuration already applied
/// (blocking vs non-blocking, timeouts, etc.).
///
/// Writes to this sink are automatically suffixed with a Unix newline
/// ('\n') by the sink and stored in a buffer until the buffer is full
/// or this sink is destroyed, at which point the buffer will be flushed.
///
/// # Example
///
/// ```no_run
/// use std::os::unix::net::UnixDatagram;
/// use cadence::BufferedUnixMetricSink;
///
/// let socket = UnixDatagram::unbound().unwrap();
/// let sink = BufferedUnixMetricSink::with_capacity("/run/statsd.sock", socket, 1432);
/// ```
pub fn with_capacity<P>(path: P, socket: UnixDatagram, cap: usize) -> BufferedUnixMetricSink
where
P: AsRef<Path>,
{
BufferedUnixMetricSink {
buffer: Mutex::new(MultiLineWriter::new(UnixWriteAdapter::new(socket, path), cap)),
}
}
}
impl MetricSink for BufferedUnixMetricSink {
fn emit(&self, metric: &str) -> io::Result<usize> {
let mut writer = self.buffer.lock().unwrap();
writer.write(metric.as_bytes())
}
fn flush(&self) -> io::Result<()> {
let mut writer = self.buffer.lock().unwrap();
writer.flush()
}
}
#[cfg(test)]
mod tests {
use super::{BufferedUnixMetricSink, MetricSink, UnixMetricSink};
use crate::test::UnixServerHarness;
use std::os::unix::net::UnixDatagram;
#[test]
fn test_unix_metric_sink() {
let harness = UnixServerHarness::new("test_unix_metric_sink");
harness.run_quiet(|path| {
let socket = UnixDatagram::unbound().unwrap();
let sink = UnixMetricSink::from(path, socket);
assert_eq!(7, sink.emit("buz:1|m").unwrap());
});
}
#[test]
fn test_non_blocking_unix_metric_sink() {
let harness = UnixServerHarness::new("test_non_blocking_unix_metric_sink");
harness.run_quiet(|path| {
let socket = UnixDatagram::unbound().unwrap();
socket.set_nonblocking(true).unwrap();
let sink = UnixMetricSink::from(path, socket);
assert_eq!(7, sink.emit("baz:1|m").unwrap());
});
}
#[test]
fn test_buffered_unix_metric_sink() {
let harness = UnixServerHarness::new("test_buffered_unix_metric_sink");
harness.run_quiet(|path| {
let socket = UnixDatagram::unbound().unwrap();
// Set the capacity of the buffer such that we know it will
// be flushed as a response to the metrics we're writing.
let sink = BufferedUnixMetricSink::with_capacity(path, socket, 16);
assert_eq!(8, sink.emit("foo:54|c").unwrap());
assert_eq!(8, sink.emit("foo:67|c").unwrap());
});
}
#[test]
fn test_buffered_unix_metric_sink_flush() {
let harness = UnixServerHarness::new("test_buffered_unix_metric_sink_flush");
harness.run_quiet(|path| {
let socket = UnixDatagram::unbound().unwrap();
// Set the capacity of the buffer such that it won't be flushed
// from a single write. Thus we can test the flush method.
let sink = BufferedUnixMetricSink::with_capacity(path, socket, 16);
assert_eq!(8, sink.emit("foo:54|c").unwrap());
assert!(sink.flush().is_ok());
});
}
}