metriks 0.9.9.4 → 0.9.9.5

data/README.md

@@ -56,6 +56,45 @@ Return the current value of the counter.
   puts "counter: #{counter.count}"
 ```
 
+## Gauges
+
+A gauge is an instantaneous measurement of a value.
+
+It takes a callback to measure the value in form of a block or a callable
+object.
+
+**WARNING:** The code in the callback is executed every time the `#value`
+method is called on the gauge. Most of the time this will be done by a
+metriks reporter that is running in a separate thread.
+
+``` ruby
+  # Callback as block
+  gauge = Metriks.gauge('queue.size') { queue.size }
+
+  # Callback as object responding to #call
+  callable = proc { queue.size }
+  gauge = Metriks.gauge('queue.size', callable)
+```
+
+### set(val)
+
+Set the current value.
+
+``` ruby
+  gauge = Metriks.gauge('queue_size')
+  gauge.set(queue.size)
+```
+
+### value()
+
+Returns the value returned by the callback (if one is defined), returns the
+value set via `#set` (or the default of 0) otherwise.
+
+``` ruby
+  gauge = Metriks.gauge('queue_size')
+  puts "queue size: #{gauge.value}"
+```
+
 ## Meters
 
 A meter that measures the mean throughput and the one-, five-, and
@@ -334,6 +373,10 @@ will display:
 501      17015 26.0  1.9 416976 246956 ?       Ss   18:54  11:43 thin reqs: 273.3/sec
 ```
 
+## Sematext Metrics Reporter
+
+[metriks-sematext](https://github.com/sematext/metriks-sematext) gem provides reporter for sending metrics to [SPM](http://sematext.com/spm/index.html).
+
 # Application Server Configuration
 
 Depending on how your application server operates, you may need to configure how reporters are created. Please look at [Troubleshooting](https://github.com/eric/metriks/wiki/Troubleshooting) for more information.

data/lib/metriks.rb

@@ -1,6 +1,6 @@
 
 module Metriks
-  VERSION = '0.9.9.4'
+  VERSION = '0.9.9.5'
 
   def self.get(name)
     Metriks::Registry.default.get(name)
@@ -10,6 +10,10 @@ module Metriks
     Metriks::Registry.default.counter(name)
   end
 
+  def self.gauge(name, callable = nil, &block)
+    Metriks::Registry.default.gauge(name, callable, &block)
+  end
+
   def self.timer(name)
     Metriks::Registry.default.timer(name)
   end

data/lib/metriks/gauge.rb

@@ -0,0 +1,27 @@
+require 'atomic'
+
+module Metriks
+  class Gauge
+    # Public: Initialize a new Gauge.
+    def initialize(callable = nil, &block)
+      @gauge = Atomic.new(nil)
+      @callback = callable || block
+    end
+
+    # Public: Set a new value.
+    #
+    # val - The new value.
+    #
+    # Returns nothing.
+    def set(val)
+      @gauge.value = val
+    end
+
+    # Public: The current value.
+    #
+    # Returns the gauge value.
+    def value
+      @callback ? @callback.call : @gauge.value
+    end
+  end
+end

data/lib/metriks/registry.rb

@@ -2,6 +2,7 @@ require 'metriks/counter'
 require 'metriks/timer'
 require 'metriks/utilization_timer'
 require 'metriks/meter'
+require 'metriks/gauge'
 
 module Metriks
   # Public: A collection of metrics
@@ -67,11 +68,26 @@ module Metriks
     #
     #   registry.counter('method.calls')
     #
-    # Returns the Metricks::Counter identified by the name.
+    # Returns the Metriks::Counter identified by the name.
     def counter(name)
       add_or_get(name, Metriks::Counter)
     end
 
+    # Public: Fetch or create a new gauge metric.
+    #
+    # name - The String name of the metric to define or fetch
+    #
+    # Examples
+    #
+    #   registry.gauge('disk_space.used') { 1 }
+    #
+    # Returns the Metriks::Gauge identified by the name.
+    def gauge(name, callable = nil, &block)
+      add_or_get(name, Metriks::Gauge) do
+        Metriks::Gauge.new(callable, &block)
+      end
+    end
+
     # Public: Fetch or create a new meter metric. Meters are a counter that
     # tracks throughput along with the count.
     #
@@ -81,7 +97,7 @@ module Metriks
     #
     #   registry.meter('resque.calls')
     #
-    # Returns the Metricks::Meter identified by the name.
+    # Returns the Metriks::Meter identified by the name.
     def meter(name)
       add_or_get(name, Metriks::Meter)
     end
@@ -96,7 +112,7 @@ module Metriks
     #
     #   registry.timer('resque.worker')
     #
-    # Returns the Metricks::Timer identified by the name.
+    # Returns the Metriks::Timer identified by the name.
     def timer(name)
       add_or_get(name, Metriks::Timer)
     end
@@ -115,7 +131,7 @@ module Metriks
     #
     #   registry.utilization_timer('rack.utilization')
     #
-    # Returns the Metricks::UtilizationTimer identified by the name.
+    # Returns the Metriks::UtilizationTimer identified by the name.
     def utilization_timer(name)
       add_or_get(name, Metriks::UtilizationTimer)
     end
@@ -130,7 +146,7 @@ module Metriks
     #
     #   registry.histogram('backlog.wait')
     #
-    # Returns the Metricks::Histogram identified by the name.
+    # Returns the Metriks::Histogram identified by the name.
     def histogram(name)
       add_or_get(name, Metriks::Histogram) do
         Metriks::Histogram.new_exponentially_decaying
@@ -188,4 +204,4 @@ module Metriks
       end
     end
   end
-end
+end

data/lib/metriks/reporter/graphite.rb

@@ -58,6 +58,10 @@ module Metriks::Reporter
           write_metric name, metric, [
             :count
           ]
+        when Metriks::Gauge
+          write_metric name, metric, [
+            :value
+          ]
         when Metriks::UtilizationTimer
           write_metric name, metric, [
             :count, :one_minute_rate, :five_minute_rate,

data/lib/metriks/reporter/librato_metrics.rb

@@ -56,6 +56,10 @@ module Metriks::Reporter
           prepare_metric name, metric, [
             :count
           ]
+        when Metriks::Gauge
+          prepare_metric name, metric, [
+            :value
+          ]
         when Metriks::UtilizationTimer
           prepare_metric name, metric, [
             :count, :one_minute_rate, :five_minute_rate,

data/lib/metriks/reporter/logger.rb

@@ -59,6 +59,10 @@ module Metriks::Reporter
           log_metric name, 'counter', metric, [
             :count
           ]
+        when Metriks::Gauge
+          log_metric name, 'gauge', metric, [
+            :value
+          ]
         when Metriks::UtilizationTimer
           log_metric name, 'utilization_timer', metric, [
             :count, :one_minute_rate, :five_minute_rate,

data/lib/metriks/reporter/riemann.rb

@@ -8,7 +8,7 @@ module Metriks::Reporter
         :host => options[:host],
         :port => options[:port]
       )
-      @registry = options[:registry] || Metrics::Registry.default
+      @registry = options[:registry] || Metriks::Registry.default
       @interval = options[:interval] || 60
       @on_error = options[:on_error] || proc { |ex| }
       
@@ -63,6 +63,10 @@ module Metriks::Reporter
           send_metric name, 'counter', metric, [
             :count
           ]
+        when Metriks::Gauge
+          send_metric name, 'gauge', metric, [
+            :value
+          ]
         when Metriks::UtilizationTimer
           send_metric name, 'utilization_timer', metric, [
             :count, :one_minute_rate, :five_minute_rate,

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.9.9.4'
-  s.date              = '2013-02-22'
+  s.version           = '0.9.9.5'
+  s.date              = '2013-07-05'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -62,6 +62,7 @@ Gem::Specification.new do |s|
     lib/metriks/counter.rb
     lib/metriks/ewma.rb
     lib/metriks/exponentially_decaying_sample.rb
+    lib/metriks/gauge.rb
     lib/metriks/histogram.rb
     lib/metriks/meter.rb
     lib/metriks/registry.rb
@@ -78,6 +79,7 @@ Gem::Specification.new do |s|
     lib/metriks/utilization_timer.rb
     metriks.gemspec
     test/counter_test.rb
+    test/gauge_test.rb
     test/graphite_reporter_test.rb
     test/histogram_test.rb
     test/librato_metrics_reporter_test.rb

data/test/gauge_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+require 'metriks/gauge'
+
+class GaugeTest < Test::Unit::TestCase
+  def test_gauge
+    gauge = Metriks::Gauge.new
+
+    3.times do |i|
+      gauge.set(i + 1)
+    end
+
+    assert_equal 3, gauge.value
+
+    gauge.set(1)
+
+    assert_equal 1, gauge.value
+  end
+
+  def test_gauge_default
+    gauge = Metriks::Gauge.new
+    assert_equal nil, gauge.value
+  end
+
+  def test_gauge_callback_via_block
+    gauge = Metriks::Gauge.new { 56 }
+
+    assert_equal 56, gauge.value
+  end
+
+  def test_gauge_callback_via_callable_object
+    callable = Class.new(Struct.new(:value)) {
+      def call
+        value
+      end
+    }
+
+    gauge = Metriks::Gauge.new(callable.new(987))
+
+    assert_equal 987, gauge.value
+
+    gauge = Metriks::Gauge.new(proc { 123 })
+
+    assert_equal 123, gauge.value
+  end
+end

data/test/graphite_reporter_test.rb

@@ -29,9 +29,13 @@ class GraphiteReporterTest < Test::Unit::TestCase
     @registry.timer('timer.testing').update(1.5)
     @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
+    @registry.gauge('gauge.testing').set(123)
+    @registry.gauge('gauge.testing.block') { 456 }
 
     @reporter.write
 
     assert_match /timer.testing.median \d/, @stringio.string
+    assert_match /gauge.testing.value 123/, @stringio.string
+    assert_match /gauge.testing.block.value 456/, @stringio.string
   end
-end
+end

data/test/librato_metrics_reporter_test.rb

@@ -26,9 +26,10 @@ class LibratoMetricsReporterTest < Test::Unit::TestCase
     @registry.timer('timer.testing').update(1.5)
     @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
+    @registry.gauge('gauge.testing') { 123 }
 
     @reporter.expects(:submit)
 
     @reporter.write
   end
-end
+end

data/test/logger_reporter_test.rb

@@ -23,6 +23,7 @@ class LoggerReporterTest < Test::Unit::TestCase
     @registry.timer('timer.testing').update(1.5)
     @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
+    @registry.gauge('gauge.testing').set(123)
   end
 
   def teardown
@@ -35,6 +36,7 @@ class LoggerReporterTest < Test::Unit::TestCase
 
     assert_match /time=\d/, @stringio.string
     assert_match /median=\d/, @stringio.string
+    assert_match /value=123/, @stringio.string
   end
 
   def test_flush
@@ -42,5 +44,6 @@ class LoggerReporterTest < Test::Unit::TestCase
 
     assert_match /time=\d/, @stringio.string
     assert_match /median=\d/, @stringio.string
+    assert_match /value=123/, @stringio.string
   end
-end
+end

data/test/riemann_reporter_test.rb

@@ -36,6 +36,7 @@ class RiemannReporterTest < Test::Unit::TestCase
     @registry.timer('timer.testing').update(1.5)
     @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
+    @registry.gauge('gauge.testing') { 123 }
 
     @reporter.client.expects(:<<).at_least_once
     @reporter.client.expects(:<<).with(
@@ -74,6 +75,14 @@ class RiemannReporterTest < Test::Unit::TestCase
       :ttl => 90
     )
 
+    @reporter.client.expects(:<<).with(
+      :host => "h",
+      :service => "gauge.testing value",
+      :metric => 123,
+      :tags => ["gauge"],
+      :ttl => 90
+    )
+
     @reporter.write
   end
 end

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 9
   - 9
-  - 4
-  version: 0.9.9.4
+  - 5
+  version: 0.9.9.5
 platform: ruby
 authors: 
 - Eric Lindvall
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-22 00:00:00 -08:00
+date: 2013-07-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,6 +90,7 @@ files:
 - lib/metriks/counter.rb
 - lib/metriks/ewma.rb
 - lib/metriks/exponentially_decaying_sample.rb
+- lib/metriks/gauge.rb
 - lib/metriks/histogram.rb
 - lib/metriks/meter.rb
 - lib/metriks/registry.rb
@@ -106,6 +107,7 @@ files:
 - lib/metriks/utilization_timer.rb
 - metriks.gemspec
 - test/counter_test.rb
+- test/gauge_test.rb
 - test/graphite_reporter_test.rb
 - test/histogram_test.rb
 - test/librato_metrics_reporter_test.rb
@@ -151,6 +153,7 @@ specification_version: 2
 summary: An experimental metrics client
 test_files: 
 - test/counter_test.rb
+- test/gauge_test.rb
 - test/graphite_reporter_test.rb
 - test/histogram_test.rb
 - test/librato_metrics_reporter_test.rb