prometheus-client 0.6.0 → 0.7.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ca1c148a74709f3c2fbbba112f651babdf43fbe
-  data.tar.gz: e55c7b9be73218b6a252a5a624fc8a865d00d851
+  metadata.gz: c7df7b1114d199d5da7e201aa5a3d42898c5db9a
+  data.tar.gz: 5bea74f933571336d6dba20f9b5a28aa12321b52
 SHA512:
-  metadata.gz: 337ad7b5c4315463492d5120b4652bd0e4d58c1b2a53fa8be05c5f1d02c7b567133196e31e5b43899001f25fd896c7f60d4cccda717d1d8fede675aaa21276e0
-  data.tar.gz: fcbb6c9963f8f0e5c5c532209fecf8643fad16a8943b74fd601644972ff25bb30f8c0e0be02b307c0247fb7a83549d21a54fe1f75850df795000d7756c9092ab
+  metadata.gz: bdfb89648fb64ee9c9bbfaaf4d4158834b3cbdc79d562530fa61d4511f8e95b2e15f4e01c374fedeb985dbf1c69fa3d5748260d29eaf5e87ed784350e1613437
+  data.tar.gz: acb12ac03128cb6387930d6f4fb43997be306fa590cd9cad706c319f514509cc631e2103152d57294e68738a4a30f42e0c6102a21db4d6ca9335d1bca646bec5

data/README.md

@@ -35,7 +35,7 @@ http_requests.increment
 ### Rack middleware
 
 There are two [Rack][2] middlewares available, one to expose a metrics HTTP
-endpoint to be scraped by a prometheus server ([Exporter][9]) and one to trace all HTTP
+endpoint to be scraped by a Prometheus server ([Exporter][9]) and one to trace all HTTP
 requests ([Collector][10]).
 
 It's highly recommended to enable gzip compression for the metrics endpoint,
@@ -45,14 +45,14 @@ for example by including the `Rack::Deflater` middleware.
 # config.ru
 
 require 'rack'
-require 'prometheus/client/rack/collector'
-require 'prometheus/client/rack/exporter'
+require 'prometheus/middleware/collector'
+require 'prometheus/middleware/exporter'
 
-use Rack::Deflater, if: ->(env, status, headers, body) { body.any? && body[0].length > 512 }
-use Prometheus::Client::Rack::Collector
-use Prometheus::Client::Rack::Exporter
+use Rack::Deflater, if: ->(_, _, _, body) { body.any? && body[0].length > 512 }
+use Prometheus::Middleware::Collector
+use Prometheus::Middleware::Exporter
 
-run ->(env) { [200, {'Content-Type' => 'text/html'}, ['OK']] }
+run ->(_) { [200, {'Content-Type' => 'text/html'}, ['OK']] }
 ```
 
 Start the server and have a look at the metrics endpoint:
@@ -85,6 +85,10 @@ Prometheus::Client::Push.new(
 # If you want to replace any previously pushed metrics for a given instance,
 # use the #replace method.
 Prometheus::Client::Push.new('my-batch-job', 'instance').replace(prometheus)
+
+# If you want to delete all previously pushed metrics for a given instance,
+# use the #delete method.
+Prometheus::Client::Push.new('my-batch-job', 'instance').delete
 ```
 
 ## Metrics
@@ -137,7 +141,7 @@ histogram = Prometheus::Client::Histogram.new(:service_latency_seconds, '...')
 # record a value
 histogram.observe({ service: 'users' }, Benchmark.realtime { service.call(arg) })
 
-# retrieve the current quantile values
+# retrieve the current bucket values
 histogram.get({ service: 'users' })
 # => { 0.005 => 3, 0.01 => 15, 0.025 => 18, ..., 2.5 => 42, 5 => 42, 10 = >42 }
 ```
@@ -158,10 +162,6 @@ summary.get({ service: 'database' })
 # => { 0.5 => 0.1233122, 0.9 => 3.4323, 0.99 => 5.3428231 }
 ```
 
-## Todo
-
-  * add protobuf support
-
 ## Tests
 
 Install necessary development gems with `bundle install` and run tests with
@@ -173,11 +173,11 @@ rake
 
 [1]: https://github.com/prometheus/prometheus
 [2]: http://rack.github.io/
-[3]: https://secure.travis-ci.org/prometheus/client_ruby.png?branch=master
+[3]: https://secure.travis-ci.org/prometheus/client_ruby.svg?branch=master
 [4]: https://badge.fury.io/rb/prometheus-client.svg
 [5]: https://gemnasium.com/prometheus/client_ruby.svg
-[6]: https://codeclimate.com/github/prometheus/client_ruby.png
-[7]: https://coveralls.io/repos/prometheus/client_ruby/badge.png?branch=master
+[6]: https://codeclimate.com/github/prometheus/client_ruby.svg
+[7]: https://coveralls.io/repos/prometheus/client_ruby/badge.svg?branch=master
 [8]: https://github.com/prometheus/pushgateway
-[9]: lib/prometheus/client/rack/exporter.rb
-[10]: lib/prometheus/client/rack/collector.rb
+[9]: lib/prometheus/middleware/exporter.rb
+[10]: lib/prometheus/middleware/collector.rb

data/lib/prometheus/client/counter.rb

@@ -20,7 +20,7 @@ module Prometheus
       private
 
       def default
-        0
+        0.0
       end
     end
   end

data/lib/prometheus/client/gauge.rb

@@ -13,7 +13,11 @@ module Prometheus
 
       # Sets the value for the given label set
       def set(labels, value)
-        @values[label_set_for(labels)] = value
+        unless value.is_a?(Numeric)
+          raise ArgumentError, 'value must be a number'
+        end
+
+        @values[label_set_for(labels)] = value.to_f
       end
     end
   end

data/lib/prometheus/client/histogram.rb

@@ -14,10 +14,10 @@ module Prometheus
 
         def initialize(buckets)
           @sum = 0.0
-          @total = 0
+          @total = 0.0
 
           buckets.each do |bucket|
-            self[bucket] = 0
+            self[bucket] = 0.0
           end
         end
 

data/lib/prometheus/client/metric.rb

@@ -23,11 +23,6 @@ module Prometheus
         @base_labels = base_labels
       end
 
-      # Returns the metric type
-      def type
-        raise NotImplementedError
-      end
-
       # Returns the value for the given label set
       def get(labels = {})
         @validator.valid?(labels)

data/lib/prometheus/client/push.rb

@@ -16,6 +16,7 @@ module Prometheus
       PATH            = '/metrics/jobs/%s'.freeze
       INSTANCE_PATH   = '/metrics/jobs/%s/instances/%s'.freeze
       HEADER          = { 'Content-Type' => Formats::Text::CONTENT_TYPE }.freeze
+      SUPPORTED_SCHEMES = %w(http https).freeze
 
       attr_reader :job, :instance, :gateway, :path
 
@@ -26,6 +27,7 @@ module Prometheus
         @uri = parse(@gateway)
         @path = build_path(job, instance)
         @http = Net::HTTP.new(@uri.host, @uri.port)
+        @http.use_ssl = @uri.scheme == 'https'
       end
 
       def add(registry)
@@ -36,16 +38,20 @@ module Prometheus
         request('PUT', registry)
       end
 
+      def delete
+        @http.send_request('DELETE', path)
+      end
+
       private
 
       def parse(url)
         uri = URI.parse(url)
 
-        if uri.scheme == 'http'
-          uri
-        else
+        unless SUPPORTED_SCHEMES.include?(uri.scheme)
           raise ArgumentError, 'only HTTP gateway URLs are supported currently.'
         end
+
+        uri
       rescue URI::InvalidURIError => e
         raise ArgumentError, "#{url} is not a valid URL: #{e}"
       end

data/lib/prometheus/client/registry.rb

@@ -24,9 +24,8 @@ module Prometheus
         @mutex.synchronize do
           if exist?(name.to_sym)
             raise AlreadyRegisteredError, "#{name} has already been registered"
-          else
-            @metrics[name.to_sym] = metric
           end
+          @metrics[name.to_sym] = metric
         end
 
         metric

data/lib/prometheus/client/version.rb

@@ -2,6 +2,6 @@
 
 module Prometheus
   module Client
-    VERSION = '0.6.0'
+    VERSION = '0.7.0-rc.1'
   end
 end

data/lib/prometheus/middleware/collector.rb

@@ -0,0 +1,91 @@
+# encoding: UTF-8
+
+require 'prometheus/client'
+
+module Prometheus
+  module Middleware
+    # Collector is a Rack middleware that provides a sample implementation of a
+    # HTTP tracer.
+    #
+    # By default metrics are registered on the global registry. Set the
+    # `:registry` option to use a custom registry.
+    #
+    # The request counter metric is broken down by code, method and path by
+    # default. Set the `:counter_label_builder` option to use a custom label
+    # builder.
+    #
+    # The request duration metric is broken down by method and path by default.
+    # Set the `:duration_label_builder` option to use a custom label builder.
+    class Collector
+      attr_reader :app, :registry
+
+      def initialize(app, options = {})
+        @app = app
+        @registry = options[:registry] || Client.registry
+        @counter_lb = options[:counter_label_builder] || COUNTER_LB
+        @duration_lb = options[:duration_label_builder] || DURATION_LB
+
+        init_request_metrics
+        init_exception_metrics
+      end
+
+      def call(env) # :nodoc:
+        trace(env) { @app.call(env) }
+      end
+
+      protected
+
+      COUNTER_LB = proc do |env, code|
+        {
+          code:   code,
+          method: env['REQUEST_METHOD'].downcase,
+          path:   env['PATH_INFO'].to_s,
+        }
+      end
+
+      DURATION_LB = proc do |env, _|
+        {
+          method: env['REQUEST_METHOD'].downcase,
+          path:   env['PATH_INFO'].to_s,
+        }
+      end
+
+      def init_request_metrics
+        @requests = @registry.counter(
+          :http_server_requests_total,
+          'The total number of HTTP requests handled by the Rack application.',
+        )
+        @durations = @registry.histogram(
+          :http_server_request_duration_seconds,
+          'The HTTP response duration of the Rack application.',
+        )
+      end
+
+      def init_exception_metrics
+        @exceptions = @registry.counter(
+          :http_server_exceptions_total,
+          'The total number of exceptions raised by the Rack application.',
+        )
+      end
+
+      def trace(env)
+        start = Time.now
+        yield.tap do |response|
+          duration = [(Time.now - start).to_f, 0.0].max
+          record(env, response.first.to_s, duration)
+        end
+      rescue => exception
+        @exceptions.increment(exception: exception.class.name)
+        raise
+      end
+
+      def record(env, code, duration)
+        @requests.increment(@counter_lb.call(env, code))
+        @durations.observe(@duration_lb.call(env, code), duration)
+      rescue
+        # TODO: log unexpected exception during request recording
+        nil
+      end
+    end
+  end
+end

data/lib/prometheus/middleware/exporter.rb

@@ -0,0 +1,91 @@
+# encoding: UTF-8
+
+require 'prometheus/client'
+require 'prometheus/client/formats/text'
+
+module Prometheus
+  module Middleware
+    # Exporter is a Rack middleware that provides a sample implementation of a
+    # Prometheus HTTP exposition endpoint.
+    #
+    # By default it will export the state of the global registry and expose it
+    # under `/metrics`. Use the `:registry` and `:path` options to change the
+    # defaults.
+    class Exporter
+      attr_reader :app, :registry, :path
+
+      FORMATS  = [Client::Formats::Text].freeze
+      FALLBACK = Client::Formats::Text
+
+      def initialize(app, options = {})
+        @app = app
+        @registry = options[:registry] || Client.registry
+        @path = options[:path] || '/metrics'
+        @acceptable = build_dictionary(FORMATS, FALLBACK)
+      end
+
+      def call(env)
+        if env['PATH_INFO'] == @path
+          format = negotiate(env, @acceptable)
+          format ? respond_with(format) : not_acceptable(FORMATS)
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def negotiate(env, formats)
+        parse(env.fetch('HTTP_ACCEPT', '*/*')).each do |content_type, _|
+          return formats[content_type] if formats.key?(content_type)
+        end
+
+        nil
+      end
+
+      def parse(header)
+        header.split(/\s*,\s*/).map do |type|
+          attributes = type.split(/\s*;\s*/)
+          quality = extract_quality(attributes)
+
+          [attributes.join('; '), quality]
+        end.sort_by(&:last).reverse
+      end
+
+      def extract_quality(attributes, default = 1.0)
+        quality = default
+
+        attributes.delete_if do |attr|
+          quality = attr.split('q=').last.to_f if attr.start_with?('q=')
+        end
+
+        quality
+      end
+
+      def respond_with(format)
+        [
+          200,
+          { 'Content-Type' => format::CONTENT_TYPE },
+          [format.marshal(@registry)],
+        ]
+      end
+
+      def not_acceptable(formats)
+        types = formats.map { |format| format::MEDIA_TYPE }
+
+        [
+          406,
+          { 'Content-Type' => 'text/plain' },
+          ["Supported media types: #{types.join(', ')}"],
+        ]
+      end
+
+      def build_dictionary(formats, fallback)
+        formats.each_with_object('*/*' => fallback) do |format, memo|
+          memo[format::CONTENT_TYPE] = format
+          memo[format::MEDIA_TYPE] = format
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0.pre.rc.1
 platform: ruby
 authors:
 - Tobias Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quantile
@@ -41,11 +41,11 @@ files:
 - lib/prometheus/client/label_set_validator.rb
 - lib/prometheus/client/metric.rb
 - lib/prometheus/client/push.rb
-- lib/prometheus/client/rack/collector.rb
-- lib/prometheus/client/rack/exporter.rb
 - lib/prometheus/client/registry.rb
 - lib/prometheus/client/summary.rb
 - lib/prometheus/client/version.rb
+- lib/prometheus/middleware/collector.rb
+- lib/prometheus/middleware/exporter.rb
 homepage: https://github.com/prometheus/client_ruby
 licenses:
 - Apache 2.0
@@ -61,12 +61,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A suite of instrumentation metric primitivesthat can be exposed through a

data/lib/prometheus/client/rack/collector.rb

@@ -1,82 +0,0 @@
-# encoding: UTF-8
-
-require 'prometheus/client'
-
-module Prometheus
-  module Client
-    module Rack
-      # Collector is a Rack middleware that provides a sample implementation of
-      # a HTTP tracer. The default label builder can be modified to export a
-      # different set of labels per recorded metric.
-      class Collector
-        attr_reader :app, :registry
-
-        def initialize(app, options = {}, &label_builder)
-          @app = app
-          @registry = options[:registry] || Client.registry
-          @label_builder = label_builder || DEFAULT_LABEL_BUILDER
-
-          init_request_metrics
-          init_exception_metrics
-        end
-
-        def call(env) # :nodoc:
-          trace(env) { @app.call(env) }
-        end
-
-        protected
-
-        DEFAULT_LABEL_BUILDER = proc do |env|
-          {
-            method: env['REQUEST_METHOD'].downcase,
-            host:   env['HTTP_HOST'].to_s,
-            path:   env['PATH_INFO'].to_s,
-          }
-        end
-
-        def init_request_metrics
-          @requests = @registry.counter(
-            :http_requests_total,
-            'A counter of the total number of HTTP requests made.',
-          )
-          @durations = @registry.summary(
-            :http_request_duration_seconds,
-            'A histogram of the response latency.',
-          )
-        end
-
-        def init_exception_metrics
-          @exceptions = @registry.counter(
-            :http_exceptions_total,
-            'A counter of the total number of exceptions raised.',
-          )
-        end
-
-        def trace(env)
-          start = Time.now
-          yield.tap do |response|
-            duration = (Time.now - start).to_f
-            record(labels(env, response), duration)
-          end
-        rescue => exception
-          @exceptions.increment(exception: exception.class.name)
-          raise
-        end
-
-        def labels(env, response)
-          @label_builder.call(env).tap do |labels|
-            labels[:code] = response.first.to_s
-          end
-        end
-
-        def record(labels, duration)
-          @requests.increment(labels)
-          @durations.observe(labels, duration)
-        rescue
-          # TODO: log unexpected exception during request recording
-          nil
-        end
-      end
-    end
-  end
-end

data/lib/prometheus/client/rack/exporter.rb

@@ -1,91 +0,0 @@
-# encoding: UTF-8
-
-require 'prometheus/client'
-require 'prometheus/client/formats/text'
-
-module Prometheus
-  module Client
-    module Rack
-      # Exporter is a Rack middleware that provides a sample implementation of
-      # a Prometheus HTTP client API.
-      class Exporter
-        attr_reader :app, :registry, :path
-
-        FORMATS  = [Formats::Text].freeze
-        FALLBACK = Formats::Text
-
-        def initialize(app, options = {})
-          @app = app
-          @registry = options[:registry] || Client.registry
-          @path = options[:path] || '/metrics'
-          @acceptable = build_dictionary(FORMATS, FALLBACK)
-        end
-
-        def call(env)
-          if env['PATH_INFO'] == @path
-            format = negotiate(env['HTTP_ACCEPT'], @acceptable)
-            format ? respond_with(format) : not_acceptable(FORMATS)
-          else
-            @app.call(env)
-          end
-        end
-
-        private
-
-        def negotiate(accept, formats)
-          accept = '*/*' if accept.to_s.empty?
-
-          parse(accept).each do |content_type, _|
-            return formats[content_type] if formats.key?(content_type)
-          end
-
-          nil
-        end
-
-        def parse(header)
-          header.to_s.split(/\s*,\s*/).map do |type|
-            attributes = type.split(/\s*;\s*/)
-            quality = extract_quality(attributes)
-
-            [attributes.join('; '), quality]
-          end.sort_by(&:last).reverse
-        end
-
-        def extract_quality(attributes, default = 1.0)
-          quality = default
-
-          attributes.delete_if do |attr|
-            quality = attr.split('q=').last.to_f if attr.start_with?('q=')
-          end
-
-          quality
-        end
-
-        def respond_with(format)
-          [
-            200,
-            { 'Content-Type' => format::CONTENT_TYPE },
-            [format.marshal(@registry)],
-          ]
-        end
-
-        def not_acceptable(formats)
-          types = formats.map { |format| format::MEDIA_TYPE }
-
-          [
-            406,
-            { 'Content-Type' => 'text/plain' },
-            ["Supported media types: #{types.join(', ')}"],
-          ]
-        end
-
-        def build_dictionary(formats, fallback)
-          formats.each_with_object('*/*' => fallback) do |format, memo|
-            memo[format::CONTENT_TYPE] = format
-            memo[format::MEDIA_TYPE] = format
-          end
-        end
-      end
-    end
-  end
-end