zecfoundation
/
metrics
mirror of https://github.com/ZcashFoundation/metrics.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

commit metrics-recorder-text v0.1.0

This commit is contained in:
Toby Lawrence 2019-04-23 20:54:45 -04:00
parent fdf816e9b3
commit 6317906b96
5 changed files with 327 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
metrics-recorder-text/.gitignore vendored Normal file
View File

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

27
metrics-recorder-text/CODE_OF_CONDUCT.md Normal file
View File

@ -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.

18
metrics-recorder-text/Cargo.toml Normal file
View File

@ -0,0 +1,18 @@
[package]
name = "metrics-recorder-text"
version = "0.1.0"
authors = ["Toby Lawrence <toby@nuclearfurnace.com>"]
edition = "2018"
license = "MIT"
description = "metric recorder for hierarchical, text-based output"
homepage = "https://github.com/metrics-rs/metrics"
repository = "https://github.com/metrics-rs/metrics-recorder-text"
documentation = "https://docs.rs/metrics-recorder-text"
[dependencies]
metrics-core = { path = "../metrics-core", version = "^0.2" }
metrics-util = { path = "../metrics-util", version = "^0.1" }
hdrhistogram = "^6.1"

18
metrics-recorder-text/README.md Normal file
View File

@ -0,0 +1,18 @@
# metrics-recorder-text
[![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-recorder-text.svg
[release-badge]: https://img.shields.io/crates/v/metrics-recorder-text.svg
[license-badge]: https://img.shields.io/crates/l/metrics-recorder-text.svg
[docs-badge]: https://docs.rs/metrics-recorder-text/badge.svg
[conduct]: https://github.com/metrics-rs/metrics-recorder-text/blob/master/CODE_OF_CONDUCT.md
[crate]: https://crates.io/crates/metrics-recorder-text
[docs]: https://docs.rs/metrics-recorder-text
__metrics-recorder-text__ is a metric recorder that outputs a hierarchical, text-based format.
## code of conduct
**NOTE**: All conversations and contributions to this project shall adhere to the [Code of Conduct][conduct].

261
metrics-recorder-text/src/lib.rs Normal file
View File

@ -0,0 +1,261 @@
//! Records metrics in a hierarchical, text-based format.
//!
//! Metric scopes are used to provide the hierarchy and indentation of metrics. As an example, for
//! a snapshot with two metrics — `server.msgs_received` and `server.msgs_sent` — we would
//! expect to see this output:
//!
//! ```c
//! root:
//! server:
//! msgs_received: 42
//! msgs_sent: 13
//! ```
//!
//! If we added another metric — `configuration_reloads` — we would expect to see:
//!
//! ```c
//! root:
//! configuration_reloads: 2
//! server:
//! msgs_received: 42
//! msgs_sent: 13
//! ```
//!
//! Metrics are sorted alphabetically.
//!
//! ## Histograms
//!
//! Histograms are rendered with a configurable set of quantiles that are provided when creating an
//! instance of `TextRecorder`. They are formatted using human-readable labels when displayed to
//! the user. For example, 0.0 is rendered as "min", 1.0 as "max", and anything in between using
//! the common "pXXX" format i.e. a quantile of 0.5 or percentile of 50 would be p50, a quantile of
//! 0.999 or percentile of 99.9 would be p999, and so on.
//!
//! All histograms have the sample count of the histogram provided in the output.
//!
//! ```c
//! root:
//! connect_time count: 15
//! connect_time min: 1334
//! connect_time p50: 1934
//! connect_time p99: 5330
//! connect_time max: 139389
//! ```
//!
use std::collections::{HashMap, VecDeque};
use std::fmt::Display;
use hdrhistogram::Histogram;
use metrics_core::MetricsRecorder;
use metrics_util::{Quantile, parse_quantiles};
/// Records metrics in a hierarchical, text-based format.
pub struct TextRecorder {
structure: MetricsTree,
quantiles: Vec<Quantile>,
}
impl TextRecorder {
/// Creates a new [`TextRecorder`] with a default set of quantiles.
///
/// Configures the recorder with these default quantiles: 0.0, 0.5, 0.9, 0.95, 0.99, 0.999, and
/// 1.0. If you want to customize the quantiles used, you can call
/// [`TextRecorder::with_quantiles`].
pub fn new() -> Self {
Self::with_quantiles(&[0.0, 0.5, 0.9, 0.95, 0.99, 0.999, 1.0])
}
/// Creates a new [`TextRecorder`] with the given set of quantiles.
pub fn with_quantiles(quantiles: &[f64]) -> Self {
let actual_quantiles = parse_quantiles(quantiles);
Self {
structure: MetricsTree::with_level(0),
quantiles: actual_quantiles,
}
}
}
impl MetricsRecorder for TextRecorder {
fn record_counter<K: AsRef<str>>(&mut self, key: K, value: u64) {
let (name_parts, name) = name_to_parts(key.as_ref());
let mut values = single_value_to_values(name, value);
self.structure.insert(name_parts, &mut values);
}
fn record_gauge<K: AsRef<str>>(&mut self, key: K, value: i64) {
let (name_parts, name) = name_to_parts(key.as_ref());
let mut values = single_value_to_values(name, value);
self.structure.insert(name_parts, &mut values);
}
fn record_histogram<K: AsRef<str>>(&mut self, key: K, values: &[u64]) {
let mut h = Histogram::new(3).expect("failed to create histogram");
for value in values {
h.record(*value).expect("failed to record histogram value");
}
let (name_parts, name) = name_to_parts(key.as_ref());
let mut values = hist_to_values(name, h, &self.quantiles);
self.structure.insert(name_parts, &mut values);
}
}
impl Clone for TextRecorder {
fn clone(&self) -> Self {
Self {
structure: MetricsTree::with_level(0),
quantiles: self.quantiles.clone(),
}
}
}
#[derive(Default)]
struct MetricsTree {
level: usize,
current: Vec<String>,
next: HashMap<String, MetricsTree>,
}
impl MetricsTree {
pub fn with_level(level: usize) -> Self {
MetricsTree {
level,
current: Vec::new(),
next: HashMap::new(),
}
}
pub fn insert(&mut self, mut name_parts: VecDeque<String>, values: &mut Vec<String>) {
match name_parts.len() {
0 => {
let indent = " ".repeat(self.level + 1);
let mut indented = values
.iter()
.map(move |x| format!("{}{}", indent, x))
.collect::<Vec<_>>();
self.current.append(&mut indented);
}
_ => {
let name = name_parts
.pop_front()
.expect("failed to get next name component");
let current_level = self.level;
let inner = self
.next
.entry(name)
.or_insert_with(move || MetricsTree::with_level(current_level + 1));
inner.insert(name_parts, values);
}
}
}
pub fn into_output(self) -> String {
let indent = " ".repeat(self.level + 1);
let mut output = String::new();
if self.level == 0 {
output.push_str("\nroot:\n");
}
let mut sorted = self
.current
.into_iter()
.map(SortEntry::Inline)
.chain(self.next.into_iter().map(|(k, v)| SortEntry::Nested(k, v)))
.collect::<Vec<_>>();
sorted.sort();
for entry in sorted {
match entry {
SortEntry::Inline(s) => {
output.push_str(s.as_str());
output.push_str("\n");
}
SortEntry::Nested(s, inner) => {
output.push_str(indent.as_str());
output.push_str(s.as_str());
output.push_str(":\n");
let layer_output = inner.into_output();
output.push_str(layer_output.as_str());
}
}
}
output
}
}
impl Into<String> for TextRecorder {
fn into(self) -> String {
self.structure.into_output()
}
}
enum SortEntry {
Inline(String),
Nested(String, MetricsTree),
}
impl SortEntry {
fn name(&self) -> &String {
match self {
SortEntry::Inline(s) => s,
SortEntry::Nested(s, _) => s,
}
}
}
impl PartialEq for SortEntry {
fn eq(&self, other: &SortEntry) -> bool {
self.name() == other.name()
}
}
impl Eq for SortEntry {}
impl std::cmp::PartialOrd for SortEntry {
fn partial_cmp(&self, other: &SortEntry) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl std::cmp::Ord for SortEntry {
fn cmp(&self, other: &SortEntry) -> std::cmp::Ordering {
self.name().cmp(other.name())
}
}
fn name_to_parts(name: &str) -> (VecDeque<String>, String) {
let mut parts = name
.split('.')
.map(ToOwned::to_owned)
.collect::<VecDeque<_>>();
let name = parts.pop_back().expect("name didn't have a single part");
(parts, name)
}
fn single_value_to_values<T>(name: String, value: T) -> Vec<String>
where
T: Display,
{
let fvalue = format!("{}: {}", name, value);
vec![fvalue]
}
fn hist_to_values(name: String, hist: Histogram<u64>, quantiles: &[Quantile]) -> Vec<String> {
let mut values = Vec::new();
values.push(format!("{} count: {}", name, hist.len()));
for quantile in quantiles {
let value = hist.value_at_quantile(quantile.value());
values.push(format!(
"{} {}: {}",
name,
quantile.label(),
value,
));
}
values
}