From 622a1770df1baa13c02f155cde3301306c8f8be0 Mon Sep 17 00:00:00 2001 From: Nat Lasseter Date: Mon, 16 Nov 2020 12:22:57 +0000 Subject: Add histogram and summary support --- Readme.textile | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'Readme.textile') diff --git a/Readme.textile b/Readme.textile index 23ba4da..320a094 100644 --- a/Readme.textile +++ b/Readme.textile @@ -65,6 +65,20 @@ Each raider consists of: #* @labels@: A hash containing the metric labels #* @timestamp@: The timestamp when the metric was collected, defaults to the time @report!@ was called. +For gauges and counters, the value is simply the vale of the metric. + +For histograms, the value is a hash containing: + +* @buckets@: A hash mapping the upper bound to the number of observations in the bucket +* @count@: The total number of observations +* @sum@: The sum of all observations + +For summaries, the value is a hash containing: + +* @quantiles@: A hash mapping the quantile to the value +* @count@: The total number of observations +* @sum@: The sum of all observations + h4. Example bc.. class Test -- cgit v1.2.1