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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
//! bosun_emitter - A library to emit metric data to [Bosun](http://bosun.org) from your command line.
//!
//! > "[Bosun](http://bosun.org) is an open-source, MIT licensed, monitoring and alerting system by [Stack Exchange](http://stackexchange.com/). It has an expressive domain specific language for evaluating alerts and creating detailed notifications. It also lets you test your alerts against history for a faster development experience." <sup>[[1]](http://bosun.org)</sup>
//!
//! Bosun receives metric data mostly via [scollector](http://bosun.org/scollector/) which is Boson's agent running on each monitored host. scollector runs build-in as well as external collectors periodically to collect and transmit metrics on its hosts.
//!
//! While it is easy to create external collectors suitable for most needs, there are cases in which sending a single, individual metric datum may be helpful. Such cases may comprise any individually run program such as a Cron job for backups or in general any other shell script. Further, it might be helpful to send metric data from your own application.
//!
//! **bosun_emitter** is a library that makes it easy to send metric data and corresponding meta data describing the metric. Further, this crate contains a CLI standalone binary called `emit_bosun` that may be used on the command line or from any shell script to send a single metric datum.
//!
//! # Example
//!
//! ## Library
//!
//! ```no_run
//! use bosun_emitter::{BosunClient, Datum, EmitterError, Metadata, now_in_ms, Tags};
//!
//! let client = BosunClient::new("localhost:8070", 5);
//! let metric = "lukas.tests.count";
//!
//! let metadata = Metadata::new(&metric, "counter", "Test", "Amount of Lukas Tests");
//! let _ = client.emit_metadata(&metadata);
//!
//! let tags: Tags = Tags::new();
//! let datum = Datum::new(&metric, now_in_ms(), "42", &tags);
//!
//! match client.emit_datum(&datum) {
//! Ok(_) => {}
//! Err(EmitterError::JsonParseError(_)) => panic!("Failed to create JSON document."),
//! Err(EmitterError::EmitError(_)) => panic!("Failed to send."),
//! Err(EmitterError::ReceiveError(_)) => panic!("Failed to create resource."),
//! }
//! ```
//!
//! ## CLI Tool -- Shell Script
//!
//! ```bash
//! #!/bin/bash
//!
//! local start=$(date +%s)
//! # Complex, time consuming backup ...
//! local now=$(date +%s)
//! local runtime=$((${now}-${start}))
//!
//! emit_bosun --host localhost:8070 --hostname backup-server --tags 'type=mongodb,database=production' --metric backup.runtime --value $runtime --rate gauge --unit sec -d "Backup runtime"
//! ```
//!
//! `emit_bosun` parses scollector config files for settings like Bosun server `Host, --host`, local hostname `Hostname, --hostname`, and tags `Tags, --tags`. In case scollector is configured on your host, you can omit these CLI parameters and just pass the configuration file.
//!
//! ## CLI Tool -- Parsing scollector Configuration File
//!
//! ```bash
//! > emit_bosun -c /etc/bosun/scollector.conf --metric backup.runtime --value $runtime --rate gauge --unit sec -d "Backup Runtime in sec"
//! ```
//!
//! The above example scollector configuration file is the default path where `emit_bosun` looks for a configuration file. So you can even omit that parameter. In addition, tags passed on the command line will be merged with tags read from scollector's configuration file.
//!
//! ```bash
//! > emit_bosun --metric backup.runtime --value $runtime --rate gauge --unit sec -d "Backup Runtime in sec"
//! ```
#![deny(missing_docs)]
extern crate chrono;
#[macro_use]
extern crate log;
extern crate reqwest;
extern crate rustc_serialize;
extern crate toml;
use chrono::Timelike;
use reqwest::{Url, StatusCode};
use rustc_serialize::Decodable;
use rustc_serialize::json;
use rustc_serialize::json::EncoderError;
use std::collections::HashMap;
use std::convert::From;
use std::fs::File;
use std::io::Read;
use std::path::Path;
use std::time::Duration;
/// Result of an attempt to send meta data or a metric datum
pub type EmitterResult = Result<(), EmitterError>;
/// Errors which may occur while sending either meta data or metric data.
#[derive(Debug)]
pub enum EmitterError {
/// Failed to create JSON.
JsonParseError(EncoderError),
/// Failed to send JSON.
EmitError(String),
/// Failed to create Datum on server.
ReceiveError(String),
}
impl From<std::io::Error> for EmitterError {
fn from(err: std::io::Error) -> EmitterError {
EmitterError::EmitError(format!("{}", err))
}
}
impl From<EncoderError> for EmitterError {
fn from(err: EncoderError) -> EmitterError {
EmitterError::JsonParseError(err)
}
}
/// Encapsulates Bosun server connection.
#[derive(Debug)]
pub struct BosunClient {
/// `<HOSTNAME|IP ADDR>:<PORT>`
pub host: String,
/// Timeout for http request connection
pub timeout: u64,
}
impl BosunClient {
/// Creates a new BosunClient.
pub fn new(host: &str, timeout: u64) -> BosunClient {
BosunClient { host: host.to_string(), timeout }
}
/// Sends metric meta data to Bosun server.
///
/// # Example
///
/// ```no_run
/// # use bosun_emitter::{BosunClient, Metadata};
/// let metadata = Metadata::new("lukas.tests.count", "counter", "Tests", "Amount of Lukas Tests");
///
/// let client = BosunClient::new("localhost:8070", 5);
/// let _ = client.emit_metadata(&metadata);
/// ```
pub fn emit_metadata(&self, metadata: &Metadata) -> EmitterResult {
let timeout = 5u64;
let encoded = try!(metadata.to_json());
let res = BosunClient::send_to_bosun_api(&self.host, "/api/metadata/put", &encoded, timeout);
info!("Sent medata '{:?}' to '{:?}' with result: '{:?}'.",
encoded,
self.host,
res);
res
}
/// Sends metric datum to Bosun server.
///
/// # Example
///
/// ```no_run
/// # use bosun_emitter::{BosunClient, Datum, Tags};
/// let mut tags = Tags::new();
/// tags.insert("host".to_string(), "test-vm".to_string());
/// let datum = Datum::new("lukas.tests.count", 1458066838, "1", &tags);
///
/// let client = BosunClient::new("localhost:8070", 5);
/// let _ = client.emit_datum(&datum);
/// ```
pub fn emit_datum(&self, datum: &Datum) -> EmitterResult {
let timeout = 5u64;
let encoded = try!(datum.to_json());
let res = BosunClient::send_to_bosun_api(&self.host, "/api/put", &encoded, timeout);
info!("Sent datum '{:?}' to '{:?}' with result: '{:?}'.",
encoded,
&self.host,
res);
res
}
fn send_to_bosun_api<T: Into<Option<u64>>>(host: &str, path: &str, json: &str, timeout: T) -> EmitterResult {
let uri = if host.starts_with("http") {
format!("{}{}", host, path)
} else {
format!("http://{}{}", host, path)
};
let url = Url::parse(&uri).unwrap();
let timeout = timeout.into().unwrap_or(5); // Default timeout is set to 5 sec.
let client = reqwest::Client::builder()
.timeout(Duration::from_secs(timeout))
.build()
.map_err(|e| EmitterError::EmitError(
format!("failed to build http client because {}", e.to_string())
))?;
let body: Vec<u8> = json.as_bytes().into();
let req = client
.post(&uri)
.header("Content-Type", "application/json; charset=utf-8")
.body(body);
// Only add basic auth, if username and password are set
let req = if url.has_authority() {
let username = url.username();
let password = url.password();
match (username, password) {
(u, Some(_)) if u.len() > 0 => req.basic_auth(username, password),
_ => req,
}
} else {
req
};
let res = req.send();
match res {
Ok(ref response) if response.status() == StatusCode::NO_CONTENT => Ok(()),
Ok(response) => Err(EmitterError::ReceiveError(format!("{}", response.status()))),
Err(err) => Err(EmitterError::EmitError(format!("{}", err))),
}
}
}
#[derive(RustcEncodable, Debug)]
/// Represents metric meta data.
pub struct Metadata<'a> {
/// Metric name
pub metric: &'a str,
/// Metric rate type: [gauge, counter rate]
pub rate: &'a str,
/// Metric unit
pub unit: &'a str,
/// Metric description
pub description: &'a str,
}
// TODO: Add check for rate type: [gauge, counter rate]
impl<'a> Metadata<'a> {
/// Creates new metric meta data.
pub fn new(metric: &'a str,
rate: &'a str,
unit: &'a str,
description: &'a str)
-> Metadata<'a> {
Metadata {
metric: metric,
rate: rate,
unit: unit,
description: description,
}
}
/// Encodes Metadata to JSON as String.
///
/// # Example
///
/// ```
/// # extern crate bosun_emitter;
/// # extern crate rustc_serialize;
/// # use bosun_emitter::Metadata;
/// # use rustc_serialize::json::{Json};
/// #
/// # fn main() {
/// let metadata = Metadata::new("lukas.tests.count", "counter", "Tests", "Amount of Lukas Tests");
/// let json = metadata.to_json().unwrap();
///
/// # let json_json = Json::from_str(&json).unwrap();
/// # let expected = "[{\"value\":\"Tests\",\"name\":\"unit\",\"metric\":\"lukas.tests.count\"},{\"metric\":\"lukas.tests.count\",\"value\":\"counter\",\"name\":\"rate\"},{\"name\":\"desc\",\"metric\":\"lukas.tests.count\",\"value\":\"Amount of Lukas Tests\"}]";
/// # let expected_json = Json::from_str(&expected).unwrap();
/// # assert_eq!(expected_json, json_json);
/// # }
/// ```
pub fn to_json(&self) -> Result<String, EmitterError> {
let mut metadata = [HashMap::new(), HashMap::new(), HashMap::new()];
metadata[0].insert("metric", self.metric);
metadata[0].insert("name", "unit");
metadata[0].insert("value", self.unit);
metadata[1].insert("metric", self.metric);
metadata[1].insert("name", "rate");
metadata[1].insert("value", self.rate);
metadata[2].insert("metric", self.metric);
metadata[2].insert("name", "desc");
metadata[2].insert("value", self.description);
let json = try!(json::encode(&metadata));
debug!("Metadata::to_json '{:?}', '{:?}'", &self, json);
Ok(json)
}
}
/// Metric tags equivalent to Rust's `HashMap<String, String>`
pub type Tags = HashMap<String, String>;
/// Represents a metric datum.
#[derive(RustcEncodable, Debug)]
pub struct Datum<'a> {
/// Metric name
pub metric: &'a str,
/// Unix timestamp in either _s_ or _ms_
pub timestamp: i64,
/// Value as string representation
pub value: &'a str,
/// Tags for this metric datum
pub tags: &'a Tags,
}
impl<'a> Datum<'a> {
/// Creates a new metric datum with a specified timestamp in ms.
pub fn new(metric: &'a str,
timestamp: i64,
value: &'a str,
// TODO: make me use refs
tags: &'a Tags)
-> Datum<'a> {
Datum {
metric: metric,
timestamp: timestamp,
value: value,
tags: tags,
}
}
/// Creates a new metric datum with timestamp _now_.
pub fn now(metric: &'a str,
value: &'a str,
// TODO: make me use refs
tags: &'a Tags)
-> Datum<'a> {
Datum {
metric: metric,
timestamp: now_in_ms(),
value: value,
tags: tags,
}
}
/// Encodes a Datum to JSON as String.
///
/// # Example
///
/// ```
/// # use bosun_emitter::{Datum, Tags};
/// let mut tags = Tags::new();
/// tags.insert("host".to_string(), "test-vm".to_string());
/// let datum = Datum::new("lukas.tests.count", 1458066838, "1", &tags);
/// let json = datum.to_json().unwrap();
///
/// # let expected = "{\"metric\":\"lukas.tests.count\",\"timestamp\":1458066838,\"value\":\"1\",\"tags\":{\"host\":\"test-vm\"}}";
/// # assert_eq!(expected, json);
/// ```
pub fn to_json(&self) -> Result<String, EmitterError> {
let json = try!(json::encode(self));
debug!("Datum::to_json '{:?}', '{:?}'", &self, json);
Ok(json)
}
}
/// Returns Unix timestamp in ms.
pub fn now_in_ms() -> i64 {
let now = chrono::Local::now();
now.timestamp() * 1000 + (now.nanosecond() / 1_000_000) as i64
}
#[derive(Debug)]
#[derive(RustcDecodable)]
#[allow(non_snake_case)]
/// Represents connection parameters to reach Bosun as well as default tags to append to each metric
/// datum.
pub struct BosunConfig {
/// Bosun server host name
pub Host: String,
/// Local host name
pub Hostname: String,
/// Tags to always append to each metric
pub Tags: Tags,
}
impl BosunConfig {
/// Creates a default configuration for `localhost`, port `8070`.
pub fn default() -> BosunConfig {
BosunConfig {
Host: "localhost:8070".to_string(),
Hostname: "localhost".to_string(),
Tags: Tags::new(),
}
}
/// Loads a configuration from an [SCollector](http://bosun.org/scollector/) configuration file.
pub fn load_from_scollector_config(file_path: &Path) -> Result<BosunConfig, Box<std::error::Error>> {
match BosunConfig::load_toml(file_path) {
Ok(toml) => {
let mut decoder = toml::Decoder::new(toml);
let config = try!(BosunConfig::decode(&mut decoder));
Ok(config)
}
Err(err) => Err(err),
}
}
fn load_toml(file_path: &Path) -> Result<toml::Value, Box<std::error::Error>> {
let mut config_file = try!(File::open(file_path));
let mut config_content = String::new();
try!(config_file.read_to_string(&mut config_content));
let mut parser = toml::Parser::new(&config_content);
match parser.parse() {
Some(toml) => Ok(toml::Value::Table(toml)),
None => Err(From::from(parser.errors.pop().unwrap())),
}
}
}