class Prometheus::Client::Summary
Summary
is an accumulator for samples. It captures Numeric data and provides the total count and sum of observations.
Public Instance Methods
get(labels: {})
click to toggle source
Returns a hash with “sum” and “count” as keys
# File lib/prometheus/client/summary.rb, line 25 def get(labels: {}) base_label_set = label_set_for(labels) internal_counters = ["count", "sum"] @store.synchronize do internal_counters.each_with_object({}) do |counter, acc| acc[counter] = @store.get(labels: base_label_set.merge(quantile: counter)) end end end
observe(value, labels: {})
click to toggle source
Records a given value.
# File lib/prometheus/client/summary.rb, line 15 def observe(value, labels: {}) base_label_set = label_set_for(labels) @store.synchronize do @store.increment(labels: base_label_set.merge(quantile: "count"), by: 1) @store.increment(labels: base_label_set.merge(quantile: "sum"), by: value) end end
type()
click to toggle source
# File lib/prometheus/client/summary.rb, line 10 def type :summary end
values()
click to toggle source
Returns all label sets with their values expressed as hashes with their sum/count
# File lib/prometheus/client/summary.rb, line 38 def values v = @store.all_values v.each_with_object({}) do |(label_set, v), acc| actual_label_set = label_set.reject{|l| l == :quantile } acc[actual_label_set] ||= { "count" => 0.0, "sum" => 0.0 } acc[actual_label_set][label_set[:quantile]] = v end end
Private Instance Methods
reserved_labels()
click to toggle source
# File lib/prometheus/client/summary.rb, line 50 def reserved_labels [:quantile] end