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 30
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
init_label_set(labels) click to toggle source
# File lib/prometheus/client/summary.rb, line 53
def init_label_set(labels)
  base_label_set = label_set_for(labels)

  @store.synchronize do
    @store.set(labels: base_label_set.merge(quantile: "count"), val: 0)
    @store.set(labels: base_label_set.merge(quantile: "sum"), val: 0)
  end
end
observe(value, labels: {}) click to toggle source

Records a given value. The recorded value is usually positive or zero. A negative value is accepted but prevents current versions of Prometheus from properly detecting counter resets in the sum of observations. See prometheus.io/docs/practices/histograms/#count-and-sum-of-observations for details.

# File lib/prometheus/client/summary.rb, line 20
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 43
def values
  values = @store.all_values

  values.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 64
def reserved_labels
  [:quantile]
end