prometheus-client 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTQ3NjhkOGY4ZjA3Zjg0MDZiNWIyMjc1MDc2YmZmMjI5Y2IxMGIxYg==
+  data.tar.gz: !binary |-
+    ZjBhYjc4OTA2YWIxNzdjYmY5YjNjYTYwM2I2ZDBiMjJiNTc1NTEwOA==
+SHA512:
+  metadata.gz: !binary |-
+    MTFlNDlkZDZhNjA1ZGE4M2EzN2Q2NTQ2M2M3N2E5NGZkOWFmNjg0YzEyZmQy
+    NGRiNDgyNTVhMDU1ODkzMmUzYjBhN2E1MjNkNDc4M2ExMjVjY2ZjMmVkMWU5
+    MDZmMThkMjE4ZGE1MzNiZDcwMWUxMjU3N2EzOGJmNmRiMWJkZTI=
+  data.tar.gz: !binary |-
+    YWE3ZWI4MmU4MjUyOTkyMjk3MWRkMzNkYWIxZTc4MDUxMWQ0OTk0NzIxZTNl
+    OTMzNGIxNTkxOTgyNDc3ODczM2E2ODM0YjM2MTFhYTIzZjdjOTRhMDI0N2Yy
+    ODkzNTQyYTg4MjcwMmM4OTdmNDcyNzgzOTZkYmNlMGFiOTQ4MzM=

data/README.md

@@ -0,0 +1,52 @@
+# Prometheus Ruby Client
+
+## Usage
+
+```ruby
+require 'prometheus/client'
+
+# returns a default registry
+prometheus = Prometheus::Client.registry
+
+# create a new counter metric
+http_requests = Prometheus::Client::Counter.new
+
+# register the metric
+prometheus.register(:http_requests, 'A counter of the total number of HTTP requests made', http_requests)
+
+# start using the counter
+http_requests.increment
+```
+
+## Metrics
+
+The following metric types are currently supported.
+
+### Counter
+
+A Counter is a metric that exposes merely a sum or tally of things.
+
+### Gauge
+
+A Gauge is a metric that exposes merely an instantaneous value or some
+snapshot thereof.
+
+## Todo
+
+  * add histogram support
+  * add push support to a vanilla prometheus exporter
+  * add tests for Rack middlewares
+  * use a more performant JSON library
+
+## Tests
+
+[![Build Status][1]](http://travis-ci.org/prometheus/client_ruby)
+
+Install necessary development gems with `bundle install` and run tests with
+rspec:
+
+```bash
+rspec
+```
+
+[1]: https://secure.travis-ci.org/prometheus/client_ruby.png?branch=master

data/lib/prometheus.rb

@@ -0,0 +1,2 @@
+module Prometheus
+end

data/lib/prometheus/client.rb

@@ -0,0 +1,12 @@
+require 'prometheus/client/registry'
+
+module Prometheus
+  module Client
+
+    # Returns a default registry object
+    def self.registry
+      @@registry ||= Registry.new
+    end
+
+  end
+end

data/lib/prometheus/client/container.rb

@@ -0,0 +1,26 @@
+require 'prometheus/client/label_set'
+
+module Prometheus
+  module Client
+    # Metric Container
+    class Container
+      attr_reader :name, :docstring, :metric, :base_labels
+
+      def initialize(name, docstring, metric, base_labels)
+        @name = name
+        @docstring = docstring
+        @metric = metric
+        @base_labels = LabelSet.new(base_labels)
+      end
+
+      def to_json(*json)
+        {
+          'baseLabels' => base_labels.merge(:name => name),
+          'docstring'  => docstring,
+          'metric'     => metric
+        }.to_json(*json)
+      end
+
+    end
+  end
+end

data/lib/prometheus/client/counter.rb

@@ -0,0 +1,24 @@
+require 'prometheus/client/metric'
+
+module Prometheus
+  module Client
+    class Counter < Metric
+      def default
+        0
+      end
+
+      def type
+        :counter
+      end
+
+      def increment(labels = {}, by = 1)
+        label_set = label_set_for(labels)
+        synchronize { @values[label_set] += by }
+      end
+
+      def decrement(labels = {}, by = 1)
+        increment(labels, -by)
+      end
+    end
+  end
+end

data/lib/prometheus/client/gauge.rb

@@ -0,0 +1,11 @@
+require 'prometheus/client/metric'
+
+module Prometheus
+  module Client
+    class Gauge < Metric
+      def type
+        :gauge
+      end
+    end
+  end
+end

data/lib/prometheus/client/histogram.rb

@@ -0,0 +1,19 @@
+require 'prometheus/client/metric'
+
+module Prometheus
+  module Client
+    class Histogram < Metric
+      def type
+        :histogram
+      end
+
+      def add(labels, timing)
+        raise NotImplementedError
+      end
+
+      def measure(labels, &block)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/prometheus/client/histogram/bucket.rb

@@ -0,0 +1,19 @@
+module Prometheus
+  module Client
+    class Histogram
+      class Bucket
+        attr_reader :observations
+
+        def initialize
+          @observations = 0
+          @timings = []
+        end
+
+        def add(timing)
+          # TODO: mutex
+          @timmings << timing
+        end
+      end
+    end
+  end
+end

data/lib/prometheus/client/label_set.rb

@@ -0,0 +1,44 @@
+module Prometheus
+  module Client
+    # LabelSet is a pseudo class used to ensure given labels are semantically
+    # correct.
+    class LabelSet
+      # TODO: we might allow setting :instance in the future
+      RESERVED_LABELS = [:name, :job, :instance]
+
+      class LabelSetError        < StandardError; end
+      class InvalidLabelSetError < LabelSetError; end
+      class InvalidLabelError    < LabelSetError; end
+      class ReservedLabelError   < LabelSetError; end
+
+      # A list of validated label sets
+      @@validated = {}
+
+      def self.new(labels)
+        validate(labels)
+        labels
+      end
+
+    protected
+
+      def self.validate(labels)
+        @@validated[labels.hash] ||= begin
+          labels.keys.each do |key|
+            unless Symbol === key
+              raise InvalidLabelError, "label name #{key} is not a symbol"
+            end
+
+            if RESERVED_LABELS.include?(key)
+              raise ReservedLabelError, "labels may not contain reserved #{key} label"
+            end
+          end
+
+          true
+        end
+      rescue NoMethodError
+        raise InvalidLabelSetError, "#{labels} is not a valid label set"
+      end
+
+    end
+  end
+end

data/lib/prometheus/client/metric.rb

@@ -0,0 +1,59 @@
+require 'thread'
+require 'prometheus/client/label_set'
+
+module Prometheus
+  module Client
+    # Metric
+    class Metric
+      def initialize
+        @mutex = Mutex.new
+        @values = Hash.new(default)
+      end
+
+      # Default value
+      def default
+        nil
+      end
+
+      # Returns the metric type
+      def type
+        raise NotImplementedError
+      end
+
+      # Returns all values
+      def value
+        @values.map do |labels, value|
+          { :labels => labels, :value => value }
+        end
+      end
+
+      # Returns the value for the given label set
+      def get(labels = {})
+        @values[label_set_for(labels)]
+      end
+
+      # Sets the value for the given label set
+      def set(labels, value)
+        @values[label_set_for(labels)] = value
+      end
+
+      # Generates JSON representation
+      def to_json(*json)
+        {
+          'type' => type,
+          'value' => value
+        }.to_json(*json)
+      end
+
+    protected
+
+      def label_set_for(labels)
+        LabelSet.new(labels)
+      end
+
+      def synchronize(&block)
+        @mutex.synchronize(&block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'prometheus/client'
+
+module Prometheus
+  module Client
+    module Rack
+      class Collector
+        attr_reader :app, :registry
+
+        def initialize(app, options = {})
+          @app = app
+          @registry = options[:registry] || Client.registry
+
+          init_metrics
+        end
+
+        def call(env) # :nodoc:
+          start = Time.now
+          @app.call(env)
+        ensure
+          @requests.increment
+          @requests_duration.increment({}, ((Time.now - start) * 1_000_000).to_i)
+        end
+
+      protected
+
+        def init_metrics
+          @requests = @registry.counter(:http_requests_total, 'A counter of the total number of HTTP requests made')
+          @requests_duration = @registry.counter(:http_request_durations_total_microseconds, 'The total amount of time Rack has spent answering HTTP requests (microseconds).')
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'prometheus/client'
+
+module Prometheus
+  module Client
+    module Rack
+      class Exporter
+        attr_reader :app, :registry, :path
+
+        def initialize(app, options = {})
+          @app = app
+          @registry = options[:registry] || Client.registry
+          @path = options[:path] || '/metrics.json'
+        end
+
+        def call(env)
+          if env['PATH_INFO'] == @path
+            metrics_response
+          else
+            @app.call(env)
+          end
+        end
+
+      protected
+
+        def metrics_response
+          json = @registry.to_json
+          headers = {
+            'Content-Type' => 'application/json',
+            'Content-Length' => json.size.to_s
+          }
+
+          [200, headers, [json]]
+        end
+
+      end
+    end
+  end
+end

data/lib/prometheus/client/registry.rb

@@ -0,0 +1,56 @@
+require 'json'
+require 'thread'
+
+require 'prometheus/client/container'
+require 'prometheus/client/counter'
+require 'prometheus/client/gauge'
+
+module Prometheus
+  module Client
+    # Registry
+    #
+    #
+    class Registry
+      class AlreadyRegisteredError < StandardError; end
+
+      def initialize()
+        @containers = {}
+        @mutex = Mutex.new
+      end
+
+      def register(name, docstring, metric, base_labels = {})
+        container = Container.new(name, docstring, metric, base_labels)
+
+        @mutex.synchronize do
+          if exist?(name)
+            raise AlreadyRegisteredError, "#{name} has already been registered"
+          else
+            @containers[name] = container
+          end
+        end
+
+        container
+      end
+
+      def counter(name, docstring, base_labels = {})
+        register(name, docstring, Counter.new, base_labels).metric
+      end
+
+      def gauge(name, docstring, base_labels = {})
+        register(name, docstring, Gauge.new, base_labels).metric
+      end
+
+      def exist?(name)
+        @containers.has_key?(name)
+      end
+
+      def get(name)
+        @containers[name]
+      end
+
+      def to_json(*json)
+        @containers.values.to_json(*json)
+      end
+    end
+  end
+end

data/lib/prometheus/client/version.rb

@@ -0,0 +1,5 @@
+module Prometheus
+  module Client
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: prometheus-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tobias Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- ts@soundcloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/prometheus/client/counter.rb
+- lib/prometheus/client/gauge.rb
+- lib/prometheus/client/histogram/bucket.rb
+- lib/prometheus/client/metric.rb
+- lib/prometheus/client/container.rb
+- lib/prometheus/client/registry.rb
+- lib/prometheus/client/rack/collector.rb
+- lib/prometheus/client/rack/exporter.rb
+- lib/prometheus/client/histogram.rb
+- lib/prometheus/client/version.rb
+- lib/prometheus/client/label_set.rb
+- lib/prometheus/client.rb
+- lib/prometheus.rb
+homepage: https://github.com/prometheus/client_ruby
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.2
+signing_key: 
+specification_version: 4
+summary: A suite of instrumentation metric primitives for Ruby that can be exposed
+  through a JSON web services interface.
+test_files: []