prometheus-client 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4982abb8d54bb0d71b55f1820ab738239646a2c2
-  data.tar.gz: 6535ba6438d7a0dc66fdec16ff5cce28d7bf90c3
+SHA256:
+  metadata.gz: e787d59357d442dc552623f434f3dd3d6ea9a842c249f96e8e3a9a9bed0bc9df
+  data.tar.gz: 2c53a0fcee4b3d1a6dc652c70c7cd3509833a6916368a33e20455d4b2b30a053
 SHA512:
-  metadata.gz: 5361cb3d81d33e73ab5a8a51285144f4a066a49e2c21fe74b485eaacb21147a92d1415a38177e465e6a6dcfe25164c5929d5da19738f4c9a3c0f793625a57d52
-  data.tar.gz: 11bf06c99b2c2618cfaaa0e4c4ddc19092d86252d6bb345c20392c0b17cfbba6c777f6e04445d82b5c3608057bcdf11760e3b4b28335ddb1ae69d69344e587e6
+  metadata.gz: b0abb64e501ba4e5d8e6e02e18e5d87ac22052d0f89fbca38c5baccc86b2dfc4a85a3d8a93c6bbe80b9ab9f1f06fadf8306cefc4d395414b3497f75e26128919
+  data.tar.gz: 816e8b3cb74368dfa5fc00db630d0a7b39830634459c174a72f268f546dc904fe8b86540435f1a78e65d51c6eb5d0d1f31e60d4d7f3a2d6745e3d665c498dddc

data/README.md

@@ -48,7 +48,7 @@ require 'rack'
 require 'prometheus/middleware/collector'
 require 'prometheus/middleware/exporter'
 
-use Rack::Deflater, if: ->(_, _, _, body) { body.any? && body[0].length > 512 }
+use Rack::Deflater
 use Prometheus::Middleware::Collector
 use Prometheus::Middleware::Exporter
 
@@ -66,29 +66,30 @@ integrated [example application](examples/rack/README.md).
 The Ruby client can also be used to push its collected metrics to a
 [Pushgateway][8]. This comes in handy with batch jobs or in other scenarios
 where it's not possible or feasible to let a Prometheus server scrape a Ruby
-process.
+process. TLS and basic access authentication are supported.
+
+**Attention**: The implementation still uses the legacy API of the pushgateway.
 
 ```ruby
 require 'prometheus/client'
 require 'prometheus/client/push'
 
-prometheus = Prometheus::Client.registry
+registry = Prometheus::Client.registry
 # ... register some metrics, set/increment/observe/etc. their values
 
 # push the registry state to the default gateway
-Prometheus::Client::Push.new('my-batch-job').add(prometheus)
+Prometheus::Client::Push.new('my-batch-job').add(registry)
 
-# optional: specify the instance name (instead of IP) and gateway
-Prometheus::Client::Push.new(
-  'my-job', 'instance-name', 'http://example.domain:1234').add(prometheus)
+# optional: specify the instance name (instead of IP) and gateway.
+Prometheus::Client::Push.new('my-batch-job', 'foobar', 'https://example.domain:1234').add(registry)
 
 # 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)
+Prometheus::Client::Push.new('my-batch-job').replace(registry)
 
 # 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
+Prometheus::Client::Push.new('my-batch-job').delete
 ```
 
 ## Metrics
@@ -127,6 +128,14 @@ gauge.set({ room: 'kitchen' }, 21.534)
 # retrieve the current value for a given label set
 gauge.get({ room: 'kitchen' })
 # => 21.534
+
+# increment the value (default is 1)
+gauge.increment({ room: 'kitchen' })
+# => 22.534
+
+# decrement the value by a given value
+gauge.decrement({ room: 'kitchen' }, 5)
+# => 17.534
 ```
 
 ### Histogram

data/lib/prometheus/client/gauge.rb

@@ -19,6 +19,26 @@ module Prometheus
 
         @values[label_set_for(labels)] = value.to_f
       end
+
+      # Increments Gauge value by 1 or adds the given value to the Gauge.
+      # (The value can be negative, resulting in a decrease of the Gauge.)
+      def increment(labels = {}, by = 1)
+        label_set = label_set_for(labels)
+        synchronize do
+          @values[label_set] ||= 0
+          @values[label_set] += by
+        end
+      end
+
+      # Decrements Gauge value by 1 or subtracts the given value from the Gauge.
+      # (The value can be negative, resulting in a increase of the Gauge.)
+      def decrement(labels = {}, by = 1)
+        label_set = label_set_for(labels)
+        synchronize do
+          @values[label_set] ||= 0
+          @values[label_set] -= by
+        end
+      end
     end
   end
 end

data/lib/prometheus/client/push.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 
+require 'thread'
 require 'net/http'
 require 'uri'
 
@@ -15,31 +16,38 @@ module Prometheus
       DEFAULT_GATEWAY = 'http://localhost:9091'.freeze
       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
 
       def initialize(job, instance = nil, gateway = nil)
+        @mutex = Mutex.new
         @job = job
         @instance = instance
         @gateway = gateway || DEFAULT_GATEWAY
-        @uri = parse(@gateway)
         @path = build_path(job, instance)
+        @uri = parse("#{@gateway}#{@path}")
+
         @http = Net::HTTP.new(@uri.host, @uri.port)
-        @http.use_ssl = @uri.scheme == 'https'
+        @http.use_ssl = (@uri.scheme == 'https')
       end
 
       def add(registry)
-        request('POST', registry)
+        synchronize do
+          request(Net::HTTP::Post, registry)
+        end
       end
 
       def replace(registry)
-        request('PUT', registry)
+        synchronize do
+          request(Net::HTTP::Put, registry)
+        end
       end
 
       def delete
-        @http.send_request('DELETE', path)
+        synchronize do
+          request(Net::HTTP::Delete)
+        end
       end
 
       private
@@ -64,10 +72,17 @@ module Prometheus
         end
       end
 
-      def request(method, registry)
-        data = Formats::Text.marshal(registry)
+      def request(req_class, registry = nil)
+        req = req_class.new(@uri)
+        req.content_type = Formats::Text::CONTENT_TYPE
+        req.basic_auth(@uri.user, @uri.password) if @uri.user
+        req.body = Formats::Text.marshal(registry) if registry
+
+        @http.request(req)
+      end
 
-        @http.send_request(method, path, data, HEADER)
+      def synchronize
+        @mutex.synchronize { yield }
       end
     end
   end

data/lib/prometheus/client/registry.rb

@@ -31,6 +31,12 @@ module Prometheus
         metric
       end
 
+      def unregister(name)
+        @mutex.synchronize do
+          @metrics.delete(name.to_sym)
+        end
+      end
+
       def counter(name, docstring, base_labels = {})
         register(Counter.new(name, docstring, base_labels))
       end

data/lib/prometheus/client/version.rb

@@ -2,6 +2,6 @@
 
 module Prometheus
   module Client
-    VERSION = '0.7.1'
+    VERSION = '0.8.0'
   end
 end

data/lib/prometheus/middleware/collector.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 
+require 'benchmark'
 require 'prometheus/client'
 
 module Prometheus
@@ -10,6 +11,9 @@ module Prometheus
     # By default metrics are registered on the global registry. Set the
     # `:registry` option to use a custom registry.
     #
+    # By default metrics all have the prefix "http_server". Set to something
+    # else if you like.
+    #
     # 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.
@@ -22,6 +26,7 @@ module Prometheus
       def initialize(app, options = {})
         @app = app
         @registry = options[:registry] || Client.registry
+        @metrics_prefix = options[:metrics_prefix] || 'http_server'
         @counter_lb = options[:counter_label_builder] || COUNTER_LB
         @duration_lb = options[:duration_label_builder] || DURATION_LB
 
@@ -35,45 +40,50 @@ module Prometheus
 
       protected
 
+      aggregation = lambda do |str|
+        str
+          .gsub(%r{/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(/|$)}, '/:uuid\\1')
+          .gsub(%r{/\d+(/|$)}, '/:id\\1')
+      end
+
       COUNTER_LB = proc do |env, code|
         {
           code:   code,
           method: env['REQUEST_METHOD'].downcase,
-          path:   env['PATH_INFO'].to_s,
+          path:   aggregation.call(env['PATH_INFO']),
         }
       end
 
       DURATION_LB = proc do |env, _|
         {
           method: env['REQUEST_METHOD'].downcase,
-          path:   env['PATH_INFO'].to_s,
+          path:   aggregation.call(env['PATH_INFO']),
         }
       end
 
       def init_request_metrics
         @requests = @registry.counter(
-          :http_server_requests_total,
+          :"#{@metrics_prefix}_requests_total",
           'The total number of HTTP requests handled by the Rack application.',
         )
         @durations = @registry.histogram(
-          :http_server_request_duration_seconds,
+          :"#{@metrics_prefix}_request_duration_seconds",
           'The HTTP response duration of the Rack application.',
         )
       end
 
       def init_exception_metrics
         @exceptions = @registry.counter(
-          :http_server_exceptions_total,
+          :"#{@metrics_prefix}_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
+        response = nil
+        duration = Benchmark.realtime { response = yield }
+        record(env, response.first.to_s, duration)
+        return response
       rescue => exception
         @exceptions.increment(exception: exception.class.name)
         raise

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Tobias Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quantile
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 description: 
 email:
 - ts@soundcloud.com
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A suite of instrumentation metric primitivesthat can be exposed through a