commit metrics-exporter-log v0.1.0

metrics-exporter-log/.gitignore

@@ -0,0 +1,3 @@
+/target
+**/*.rs.bk
+Cargo.lock

metrics-exporter-log/CODE_OF_CONDUCT.md

@@ -0,0 +1,27 @@
+# The Code of Conduct
+
+This document is based on the [Rust Code of Conduct](https://www.rust-lang.org/conduct.html) and outlines the standard of conduct which is both expected and enforced as part of this project.
+
+## Conduct
+
+**Contact**: [toby@nuclearfurnace.com](mailto:toby@nuclearfurnace.com)
+
+* We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.
+* Avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.
+* Please be kind and courteous. There's no need to be mean or rude.
+* Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer.
+* Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.
+* We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behaviour. We interpret the term "harassment" as including the definition in the <a href="http://citizencodeofconduct.org/">Citizen Code of Conduct</a>; if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups.
+* Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the repository Owners immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back.
+* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
+
+## Moderation
+
+These are the policies for upholding our community's standards of conduct. If you feel that a thread needs moderation, please use the contact information above, or mention @tobz or @LucioFranco in the thread.
+
+1. Remarks that violate this Code of Conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but never targeting another user, and never in a hateful manner.)
+2. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed.
+
+In the Rust community we strive to go the extra step to look out for each other. Don't just aim to be technically unimpeachable, try to be your best self. In particular, avoid flirting with offensive or sensitive issues, particularly if they're off-topic; this all too often leads to unnecessary fights, hurt feelings, and damaged trust; worse, it can drive people away from the community entirely.
+
+And if someone takes issue with something you said or did, resist the urge to be defensive. Just stop doing what it was they complained about and apologize. Even if you feel you were misinterpreted or unfairly accused, chances are good there was something you could've communicated better — remember that it's your responsibility to make your fellow Rustaceans comfortable. Everyone wants to get along and we are all here first and foremost because we want to talk about cool technology. You will find that people will be eager to assume good intent and forgive as long as you earn their trust.

metrics-exporter-log/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "metrics-exporter-log"
+version = "0.1.0"
+authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
+edition = "2018"
+
+license = "MIT"
+
+description = "metric exporter for outputting to logs"
+
+homepage = "https://github.com/metrics-rs/metrics"
+repository = "https://github.com/metrics-rs/metrics-exporter-log"
+documentation = "https://docs.rs/metrics-exporter-log"
+
+[dependencies]
+metrics-core = { path = "../metrics-core", version = "^0.2" }
+metrics = { path = "../metrics", version = "^0.9" }
+log = "^0.4"
+futures = "^0.1"
+tokio-timer = "^0.2"

metrics-exporter-log/README.md

@@ -0,0 +1,18 @@
+# metrics-exporter-log
+
+[![conduct-badge][]][conduct] [![downloads-badge][] ![release-badge][]][crate] [![docs-badge][]][docs] [![license-badge][]](#license)
+
+[conduct-badge]: https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg
+[downloads-badge]: https://img.shields.io/crates/d/metrics-exporter-log.svg
+[release-badge]: https://img.shields.io/crates/v/metrics-exporter-log.svg
+[license-badge]: https://img.shields.io/crates/l/metrics-exporter-log.svg
+[docs-badge]: https://docs.rs/metrics-exporter-log/badge.svg
+[conduct]: https://github.com/metrics-rs/metrics-exporter-log/blob/master/CODE_OF_CONDUCT.md
+[crate]: https://crates.io/crates/metrics-exporter-log
+[docs]: https://docs.rs/metrics-exporter-log
+
+__metrics-exporter-log__ is a metric exporter that outputs metrics in a textual format via the `log` crate.
+
+## code of conduct
+
+**NOTE**: All conversations and contributions to this project shall adhere to the [Code of Conduct][conduct].

metrics-exporter-log/src/lib.rs

@@ -0,0 +1,88 @@
+//! Exports metrics via the `log` crate.
+//!
+//! This exporter can utilize recorders that are able to be converted to a textual representation
+//! via [`Into`].  It will emit that output by logging via the `log` crate at the specified
+//! level.
+//!
+//! # Run Modes
+//! - `run` can be used to block the current thread, taking snapshots and exporting them on an
+//! interval
+//! - `turn` can be used to take a single snapshot and log it
+//! - `into_future` will return a [`Future`] that when driven will take a snapshot on the 
+//! configured interval and log it
+#[macro_use]
+extern crate log;
+
+use std::thread;
+use std::time::Duration;
+use metrics::Controller;
+use metrics_core::MetricsRecorder;
+use log::Level;
+use futures::prelude::*;
+use tokio_timer::Interval;
+
+/// Exports metrics by converting them to a textual representation and logging them.
+pub struct LogExporter<R> {
+    controller: Controller,
+    recorder: R,
+    level: Level,
+}
+
+impl<R> LogExporter<R>
+where
+    R: MetricsRecorder + Clone + Into<String>
+{
+    /// Creates a new [`LogExporter`] that logs at the configurable level.
+    ///
+    /// Recorders expose their output by being converted into strings.
+    pub fn new(controller: Controller, recorder: R, level: Level) -> Self {
+        LogExporter {
+            controller,
+            recorder,
+            level,
+        }
+    }
+
+    /// Runs this exporter on the current thread, logging output on the given interval.
+    pub fn run(&mut self, interval: Duration) {
+        loop {
+            thread::sleep(interval);
+
+            self.turn();
+        }
+    }
+
+    /// Run this exporter, logging output only once.
+    pub fn turn(&self) {
+        run_once(&self.controller, self.recorder.clone(), self.level);
+    }
+
+    /// Converts this exporter into a future which logs output on the given interval.
+    pub fn into_future(self, interval: Duration) -> impl Future<Item = (), Error = ()> {
+        let controller = self.controller;
+        let recorder = self.recorder;
+        let level = self.level;
+
+        Interval::new_interval(interval)
+            .map_err(|_| ())
+            .for_each(move |_| {
+                let recorder = recorder.clone();
+                run_once(&controller, recorder, level);
+                Ok(())
+            })
+    }
+}
+
+fn run_once<R>(controller: &Controller, mut recorder: R, level: Level)
+where
+    R: MetricsRecorder + Into<String>
+{
+    match controller.get_snapshot() {
+        Ok(snapshot) => {
+            snapshot.record(&mut recorder);
+            let output = recorder.into();
+            log!(level, "{}", output);
+        },
+        Err(e) => log!(Level::Error, "failed to capture snapshot: {}", e),
+    }
+}