Contents

# encoding: UTF-8

require 'quantile'
require 'prometheus/client/metric'

module Prometheus
  module Client
    # Summary is an accumulator for samples. It captures Numeric data and
    # provides an efficient quantile calculation mechanism.
    class Summary < Metric
      extend Gem::Deprecate

      # Value represents the state of a Summary at a given point.
      class Value < Hash
        attr_accessor :sum, :total

        def initialize(name, labels, estimator)
          @sum = ValueClass.new(name, name + '_sum', labels, estimator.sum)
          @total = ValueClass.new(name, name + '_count', labels, estimator.observations)

          estimator.invariants.each do |invariant|
            self[invariant.quantile] = ValueClass.new(type, name, labels, estimator.query(invariant.quantile), nil)
          end
        end
      end

      def initialize(name, docstring, base_labels = {}, multiprocess_mode)
        super(name, docstring, base_labels)
      end

      def type
        :summary
      end

      # Records a given value.
      def observe(labels, value)
        label_set = label_set_for(labels)
        synchronize { @values[label_set].observe(value) }
      end
      alias add observe
      deprecate :add, :observe, 2016, 10

      # Returns the value for the given label set
      def get(labels = {})
        @validator.valid?(labels)

        synchronize do
          Value.new(@values[labels])
        end
      end

      # Returns all label sets with their values
      def values
        synchronize do
          @values.each_with_object({}) do |(labels, value), memo|
            memo[labels] = value
          end
        end
      end

      private

      def default(labels)
        Value.new(type, @name, labels, Quantile::Estimator.new)
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
prometheus-client-mmap-0.7.0.beta2	lib/prometheus/client/summary.rb