metriks 0.8.4 → 0.9.0

data/README.md

@@ -283,6 +283,36 @@ since the process started.
 
 How to get metrics out of the process.
 
+## Graphite Reporter
+
+Sends metrics to Graphite every 60 seconds.
+
+```ruby
+  reporter = Metriks::Reporter::Graphite.new 'localhost', 3004
+  reporter.start
+```
+
+
+## Logger Reporter
+
+Send metrics to a logger every 60 seconds.
+
+```
+  reporter = Metriks::Reporter::Logger.new(:logger => Logger.new('log/metrics.log'))
+  reporter.start
+```
+
+
+## Librato Metrics Reporter
+
+Send metrics to Librato Metrics every 60 seconds.
+
+```
+  reporter = Metriks::Reporter::LibratoMetrics.new('email', 'token')
+  reporter.start
+```
+
+
 ## Proc Title Reporter
 
 Provides a simple way to get up-to-date statistics from a process by
@@ -290,11 +320,9 @@ updating the proctitle every 5 seconds (default).
 
 ```ruby
   reporter = Metriks::Reporter::ProcTitle.new :interval => 5
-
   reporter.add 'reqs', 'sec' do
     Metriks.meter('rack.requests').one_minute_rate
   end
-
   reporter.start
 ```
 
@@ -312,9 +340,7 @@ An incomplete list of things I would like to see added:
 * Rack middleware to measure utilization, throughput and worker time
 * Basic reporters:
   * Rack endpoint returning JSON
-  * Logger reporter to output metrics on a time interval
   * [Statsd](https://github.com/etsy/statsd) reporter
-  * [Librato Metrics](http://metrics.librato.com) reporter
 * Metaprogramming instrumentation hooks like [Shopify's statsd-instrument](https://github.com/Shopify/statsd-instrument)
 
 

data/lib/metriks/exponentially_decaying_sample.rb

@@ -72,10 +72,9 @@ module Metriks
         @mutex.synchronize do
           old_start_time = @start_time
           @start_time = Time.now
-          keys = @values.keys
-          keys.each do |key|
+          @values.keys.each do |key|
             value = @values.delete(key)
-            @values[key* Math.exp(-@alpha * (@start_time - old_start_time))] = value
+            @values[key * Math.exp(-@alpha * (@start_time - old_start_time))] = value
           end
         end
       end

data/lib/metriks/reporter/graphite.rb

@@ -0,0 +1,97 @@
+
+module Metriks::Reporter
+  class Graphite
+    def initialize(host, port, options = {})
+      @host      = host
+      @port      = port
+      @prefix    = options[:prefix]
+      @registry  = options[:registry] || Metriks::Registry.default
+      @interval  = options[:interval] || 60
+      @on_errror = options[:on_error] || proc { |ex| }
+    end
+
+    def socket
+      @socket = nil if @socket.closed?
+      @socket ||= TCPSocket.new(host, port)
+    end
+
+    def start
+      @thread ||= Thread.new do
+        loop do
+          sleep @interval
+
+          Thread.new do
+            begin
+              write
+            rescue Exception => ex
+              @on_error[ex] rescue nil
+            end
+          end
+        end
+      end
+    end
+
+    def stop
+      @thread.kill if @thread
+      @thread = nil
+    end
+
+    def write
+      @registry.each do |name, metric|
+        case metric
+        when Metriks::Meter
+          write_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate
+          ]
+        when Metriks::Counter
+          write_metric name, metric, [
+            :count
+          ]
+        when Metriks::UtilizationTimer
+          write_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev,
+            :one_minute_utilization, :five_minute_utilization,
+            :fifteen_minute_utilization, :mean_utilization,
+          ], [
+            :median, :get_95th_percentile
+          ]
+        when Metriks::Timer
+          write_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
+        end
+      end
+    end
+
+    def write_metric(base_name, metric, keys, snapshot_keys = [])
+      time = Time.now.to_i
+
+      base_name = base_name.to_s.gsub(/ +/, '_')
+      if @prefix
+        base_name = "#{@prefix}.#{base_name}"
+      end
+
+      keys.flatten.each do |key|
+        name = key.to_s.gsub(/^get_/, '')
+        value = metric.send(key)
+        socket.write("#{base_name}.#{name} #{value} #{time}\n")
+      end
+
+      unless snapshot_keys.empty?
+        snapshot = metric.snapshot
+        snapshot_keys.flatten.each do |key|
+          name = key.to_s.gsub(/^get_/, '')
+          value = snapshot.send(key)
+          socket.write("#{base_name}.#{name} #{value} #{time}\n")
+        end
+      end
+    end
+  end
+end

data/lib/metriks/reporter/librato_metrics.rb

@@ -0,0 +1,140 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'yajl'
+require 'yajl/json_gem'
+
+module Metriks::Reporter
+  class LibratoMetrics
+    def self.connection
+      @connection ||= Faraday::Connection.new('https://metrics-api.librato.com') do |b|
+        b.use FaradayMiddleware::EncodeJson
+        b.adapter Faraday.default_adapter
+        b.use Faraday::Response::RaiseError
+        b.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+      end.tap do |c|
+        c.headers[:content_type] = 'application/json'
+        c.headers[:user_agent] = "Metriks/#{Metriks::VERSION} Faraday/#{Faraday::VERSION}"
+      end
+    end
+
+
+    def initialize(email, token, options = {})
+      @email     = email
+      @token     = token
+      @prefix    = options[:prefix]
+      @registry  = options[:registry] || Metriks::Registry.default
+      @interval  = options[:interval] || 60
+      @on_errror = options[:on_error] || proc { |ex| }
+      @source    = options[:source]
+    end
+
+    def start
+      @thread ||= Thread.new do
+        loop do
+          sleep @interval
+
+          Thread.new do
+            begin
+              write
+            rescue Exception => ex
+              @on_error[ex] rescue nil
+            end
+          end
+        end
+      end
+    end
+
+    def stop
+      @thread.kill if @thread
+      @thread = nil
+    end
+
+    def write
+      gauges = []
+      @registry.each do |name, metric|
+        gauges << case metric
+        when Metriks::Meter
+          prepare_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate
+          ]
+        when Metriks::Counter
+          prepare_metric name, metric, [
+            :count
+          ]
+        when Metriks::UtilizationTimer
+          prepare_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev,
+            :one_minute_utilization, :five_minute_utilization,
+            :fifteen_minute_utilization, :mean_utilization,
+          ], [
+            :median, :get_95th_percentile
+          ]
+        when Metriks::Timer
+          prepare_metric name, metric, [
+            :count, :one_minute_rate, :five_minute_rate,
+            :fifteen_minute_rate, :mean_rate,
+            :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
+        end
+      end
+
+      submit(:gauges => gauges.flatten)
+    end
+
+    def connection
+      @connection ||= self.class.connection.dup.tap do |c|
+        c.basic_auth @email, @token
+      end
+    end
+
+    def submit(body)
+      connection.post '/v1/metrics' do |req|
+        req.body = body
+      end
+    end
+
+    def prepare_metric(base_name, metric, keys, snapshot_keys = [])
+      results = []
+      time = Time.now.to_i
+
+      base_name = base_name.to_s.gsub(/ +/, '_')
+      if @prefix
+        base_name = "#{@prefix}.#{base_name}"
+      end
+
+      keys.flatten.each do |key|
+        name = key.to_s.gsub(/^get_/, '')
+        value = metric.send(key)
+
+        results << {
+          :name => "#{base_name}.#{name}",
+          :source => @source,
+          :time => time,
+          :value => value
+        }
+      end
+
+      unless snapshot_keys.empty?
+        snapshot = metric.snapshot
+        snapshot_keys.flatten.each do |key|
+          name = key.to_s.gsub(/^get_/, '')
+          value = snapshot.send(key)
+
+          results << {
+            :name => "#{base_name}.#{name}",
+            :source => @source,
+            :time => time,
+            :value => value
+          }
+        end
+      end
+
+      results
+    end
+  end
+end

data/lib/metriks.rb

@@ -1,6 +1,6 @@
 
 module Metriks
-  VERSION = '0.8.4'
+  VERSION = '0.9.0'
 
   def self.get(name)
     Metriks::Registry.default.get(name)

data/metriks.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'metriks'
-  s.version           = '0.8.4'
-  s.date              = '2012-02-27'
+  s.version           = '0.9.0'
+  s.date              = '2012-03-03'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -26,15 +26,12 @@ Gem::Specification.new do |s|
   ## a custom homepage, consider using your GitHub URL or the like.
   s.authors  = ["Eric Lindvall"]
   s.email    = 'eric@sevenscale.com'
-  s.homepage = 'https://github.com/eric/metriks_client'
+  s.homepage = 'https://github.com/eric/metriks'
 
   ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
   ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
   s.require_paths = %w[lib]
 
-  ## If your gem includes any executables, list them here.
-  # s.executables = ["name"]
-
   ## Specify any RDoc options here. You'll want to add your README and
   ## LICENSE files to the extra_rdoc_files list.
   s.rdoc_options = ["--charset=UTF-8"]
@@ -45,10 +42,14 @@ Gem::Specification.new do |s|
   s.add_dependency('atomic', ["~> 1.0"])
   s.add_dependency('hitimes', [ "~> 1.1"])
   s.add_dependency('rbtree', [ "~> 0.3" ])
+  s.add_dependency('faraday', ['~> 0.7.0'])
+  s.add_dependency('faraday_middleware', ['~> 0.8.4'])
+  s.add_dependency('yajl-ruby')
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
   s.add_development_dependency('tomdoc', ["~> 0.2"])
+  s.add_development_dependency('mocha', ['~> 0.10'])
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -67,6 +68,8 @@ Gem::Specification.new do |s|
     lib/metriks/histogram.rb
     lib/metriks/meter.rb
     lib/metriks/registry.rb
+    lib/metriks/reporter/graphite.rb
+    lib/metriks/reporter/librato_metrics.rb
     lib/metriks/reporter/logger.rb
     lib/metriks/reporter/proc_title.rb
     lib/metriks/simple_moving_average.rb
@@ -76,7 +79,9 @@ Gem::Specification.new do |s|
     lib/metriks/utilization_timer.rb
     metriks.gemspec
     test/counter_test.rb
+    test/graphite_reporter_test.rb
     test/histogram_test.rb
+    test/librato_metrics_reporter_test.rb
     test/logger_reporter_test.rb
     test/meter_test.rb
     test/metriks_test.rb

data/test/graphite_reporter_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+require 'metriks/reporter/graphite'
+
+class GraphiteReporterTest < Test::Unit::TestCase
+  def setup
+    @registry = Metriks::Registry.new
+    @reporter = Metriks::Reporter::Graphite.new('localhost', 3333, :registry => @registry)
+    @stringio = StringIO.new
+
+    @reporter.stubs(:socket).returns(@stringio)
+  end
+
+  def teardown
+    @reporter.stop
+    @registry.stop
+  end
+
+  def test_write
+    @registry.meter('meter.testing').mark
+    @registry.counter('counter.testing').increment
+    @registry.timer('timer.testing').update(1.5)
+    @registry.utilization_timer('utilization_timer.testing').update(1.5)
+
+    @reporter.write
+
+    assert_match /timer.testing.median \d/, @stringio.string
+  end
+end

data/test/librato_metrics_reporter_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+require 'metriks/reporter/librato_metrics'
+
+class LibratoMetricsReporterTest < Test::Unit::TestCase
+  def setup
+    @registry = Metriks::Registry.new
+    @reporter = Metriks::Reporter::LibratoMetrics.new('user', 'password', :registry => @registry)
+
+    @reporter.connection.builder.tap do |c|
+      c.swap 1, Faraday::Adapter::Test do |stub|
+        stub.post '/v1/metrics' do |env|
+          [ 200, {}, '' ]
+        end
+      end
+    end
+  end
+
+  def teardown
+    @reporter.stop
+    @registry.stop
+  end
+
+  def test_write
+    @registry.meter('meter.testing').mark
+    @registry.counter('counter.testing').increment
+    @registry.timer('timer.testing').update(1.5)
+    @registry.utilization_timer('utilization_timer.testing').update(1.5)
+
+    @reporter.write
+  end
+end

data/test/test_helper.rb

@@ -2,6 +2,7 @@ require 'test/unit'
 require 'pp'
 
 require 'turn'
+require 'mocha'
 
 require 'metriks'
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
-  - 4
-  version: 0.8.4
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Eric Lindvall
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-27 00:00:00 -08:00
+date: 2012-03-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,9 +57,49 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: tomdoc
+  name: faraday
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 4
+        version: 0.8.4
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: tomdoc
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -68,7 +108,20 @@ dependencies:
         - 2
         version: "0.2"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        version: "0.10"
+  type: :development
+  version_requirements: *id008
 description: An experimental metrics client.
 email: eric@sevenscale.com
 executables: []
@@ -91,6 +144,8 @@ files:
 - lib/metriks/histogram.rb
 - lib/metriks/meter.rb
 - lib/metriks/registry.rb
+- lib/metriks/reporter/graphite.rb
+- lib/metriks/reporter/librato_metrics.rb
 - lib/metriks/reporter/logger.rb
 - lib/metriks/reporter/proc_title.rb
 - lib/metriks/simple_moving_average.rb
@@ -100,7 +155,9 @@ files:
 - lib/metriks/utilization_timer.rb
 - metriks.gemspec
 - test/counter_test.rb
+- test/graphite_reporter_test.rb
 - test/histogram_test.rb
+- test/librato_metrics_reporter_test.rb
 - test/logger_reporter_test.rb
 - test/meter_test.rb
 - test/metriks_test.rb
@@ -110,7 +167,7 @@ files:
 - test/timer_test.rb
 - test/utilization_timer_test.rb
 has_rdoc: true
-homepage: https://github.com/eric/metriks_client
+homepage: https://github.com/eric/metriks
 licenses: []
 
 post_install_message: 
@@ -141,7 +198,9 @@ specification_version: 2
 summary: An experimental metrics client
 test_files: 
 - test/counter_test.rb
+- test/graphite_reporter_test.rb
 - test/histogram_test.rb
+- test/librato_metrics_reporter_test.rb
 - test/logger_reporter_test.rb
 - test/meter_test.rb
 - test/metriks_test.rb