statue 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7423b7af642844b2743653ad8e98d4e07e49de3f
-  data.tar.gz: 8d6c9aa58322ab48e39322079def0658a508aeb5
+  metadata.gz: aaaa801fa23349d6323a19dae5bd071644310838
+  data.tar.gz: 8ad955fe46e3bdb66f6fd5e38ef0019637601e6e
 SHA512:
-  metadata.gz: f53624b253cc74dd7f10c44feb52ddb00dd81b37b21fd80fdc98dd990c5f52edcf2c3afe55dd82da904d8370682b7ed82ad66f98359d2b1729e6e7996bc62ce5
-  data.tar.gz: 3011d204d3fb77793a06597c73286518660e36ef60a2f000165755f54e40c9744fe7aac7f114ab7a8a0fd526dbf03bcfb6cddebc8c387a856efa16863761514c
+  metadata.gz: 15786cf65ccb148c747a4e7852f5fbde2a3a93900e27d3a9ee534964b4ae52a48b7c1ffb438d72c14f4be47d329476154be6ebf50d2447d38d94ec135315637d
+  data.tar.gz: aeb292041f9827f72c880a61c88bac5cd53a322f52ccefe7e1f91c5bc857a416845c575617f1db6f6753c5cacb758749d8062e010bbcad11952e5df2e247ce1f

data/README.md

@@ -37,11 +37,31 @@ Statue.backend = Statue::LoggerBackend.new(Rails.logger)
 
 ## Usage
 
+### Common meassurments
+
 `Statue.report_increment('metric.name')` -> send to Statsd an increment for the counter `metric.name`
 
-`Statue.report_duration('metric.name') { some_operation } # => some_operation_result` -> send to Statsd the measure for the block duration in `metric.name`
+`Statue.report_duration('metric.name') { some_operation } # => some_operation_result` -> send to Statsd the
+measure for the block duration in `metric.name`
+
+`Statue.report_success_or_failure('metric.name') { some_operation } # => some_operation_result` -> checks the
+result of the block, if its a `truthy` value, then increments `metric.name.success`, else it increments
+`metric.name.failure`.
+
+### Stopwatch
+
+The stopwatch provides an easy way to track the duration of a long process with multiple phases.
 
-`Statue.report_success_or_failure('metric.name') { some_operation } # => some_operation_result` -> checks the result of the block, if its a `truthy` value, then increments `metric.name.success`, else it increments `metric.name.failure`.
+```ruby
+stopwatch = Statue.stopwatch("metric") # => Starts tracking time
+
+while something do
+  do_something
+  stopwatch.partial # => reports duration from last partial until now as: "metric.runtime.partial"
+end
+
+stopwatch.stop # => reports duration from start until now as: "metric.runtime.total"
+```
 
 ### Rack Integration
 

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/lib/statue/stopwatch.rb

@@ -0,0 +1,39 @@
+module Statue
+  class Stopwatch
+
+    def initialize(name:, now: clock_now, reporter: Statue)
+      @reporter = reporter
+      @name     = name
+      @start    = @partial = now
+    end
+
+    def partial(suffix = nil, now: clock_now, **options)
+      previous, @partial = @partial, now
+
+      @reporter.report_duration(metric_name(suffix || "runtime.partial"), @partial - previous, **options)
+    end
+
+    def stop(suffix = nil, now: clock_now, report_partial: false, **options)
+      partial(report_partial.is_a?(String) ? report_partial : nil, now: now, **options) if report_partial
+
+      previous, @start = @start, now
+
+      @reporter.report_duration(metric_name(suffix || "runtime.total"), @start - previous, **options)
+    end
+
+    def reset(now: clock_now)
+      @start = @partial = now
+    end
+
+    private
+
+    def metric_name(suffix)
+      "#{@name}.#{suffix}"
+    end
+
+    def clock_now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+  end
+end

data/lib/statue/version.rb

@@ -1,3 +1,3 @@
 module Statue
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/statue.rb

@@ -2,6 +2,7 @@ require 'statue/version'
 
 require 'statue/backends'
 require 'statue/metric'
+require 'statue/stopwatch'
 
 module Statue
   extend self
@@ -38,6 +39,10 @@ module Statue
     raise
   end
 
+  def stopwatch(metric_name)
+    Stopwatch.new(name: metric_name, reporter: self)
+  end
+
   def backend
     @backend ||= UDPBackend.new
   end

data/test/stopwatch_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+describe Statue::Stopwatch do
+  after do
+    Statue.backend.captures.clear
+  end
+
+  describe "#partial" do
+    it "reports the duration between start and the partial call" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch", now: 0)
+      stopwatch.partial(now: 42)
+
+      assert_equal 1, Statue.backend.captures.size
+      assert_equal "my_watch.runtime.partial:42|ms", Statue.backend.captures.first.to_s
+    end
+
+    it "can report multiple partials" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch", now: 0)
+      (1..20).each { |now| stopwatch.partial(now: now) }
+
+      assert_equal 20, Statue.backend.captures.size
+      Statue.backend.captures.each do |metric|
+        assert_equal "my_watch.runtime.partial:1|ms", metric.to_s
+      end
+    end
+
+    it "tracks time correctly" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch")
+      stopwatch.partial
+
+      assert Statue.backend.captures.first.value > 0, "partial metric time should be greater than zero"
+    end
+  end
+
+  describe "#stop" do
+    it "reports the duration between start and the stop call" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch", now: 0)
+      stopwatch.stop(now: 42)
+
+      assert_equal 1, Statue.backend.captures.size
+      assert_equal "my_watch.runtime.total:42|ms", Statue.backend.captures.first.to_s
+    end
+
+    it "is not affected by partials" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch", now: 0)
+      (1..20).each { |now| stopwatch.partial(now: now) }
+      stopwatch.stop(now: 21)
+
+      assert_equal 21, Statue.backend.captures.size
+      *partials, total = Statue.backend.captures
+      assert_equal "my_watch.runtime.total:21|ms", total.to_s
+    end
+
+    it "can send the last partial duration" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch", now: 0)
+      (1..20).each { |now| stopwatch.partial(now: now) }
+      stopwatch.stop(now: 21, report_partial: true)
+
+      assert_equal 22, Statue.backend.captures.size
+      *partials, total = Statue.backend.captures
+      assert_equal "my_watch.runtime.total:21|ms", total.to_s
+      partials.each do |metric|
+        assert_equal "my_watch.runtime.partial:1|ms", metric.to_s
+      end
+    end
+
+    it "can send the last partial duration with a special name" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch", now: 0)
+      (1..20).each { |now| stopwatch.partial(now: now) }
+      stopwatch.stop(now: 21, report_partial: "runtime.final_lap")
+
+      assert_equal 22, Statue.backend.captures.size
+      *partials, special_partial, total = Statue.backend.captures
+      assert_equal "my_watch.runtime.final_lap:1|ms", special_partial.to_s
+    end
+
+    it "tracks time correctly" do
+      stopwatch = Statue::Stopwatch.new(name: "my_watch")
+      stopwatch.stop
+
+      assert Statue.backend.captures.first.value > 0, "partial metric time should be greater than zero"
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statue
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Juan Barreneche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,7 +55,8 @@ dependencies:
 description: Track application metrics to Statsie
 email:
 - devs@restorando.com
-executables: []
+executables:
+- rake
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,6 +66,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rake
 - lib/statue.rb
 - lib/statue/backends.rb
 - lib/statue/backends/capture.rb
@@ -73,9 +75,11 @@ files:
 - lib/statue/backends/udp.rb
 - lib/statue/metric.rb
 - lib/statue/rack_statistics.rb
+- lib/statue/stopwatch.rb
 - lib/statue/version.rb
 - statue.gemspec
 - test/statue_test.rb
+- test/stopwatch_test.rb
 - test/test_helper.rb
 homepage: ''
 licenses:
@@ -97,10 +101,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Easily track application metrics into Statsie
 test_files:
 - test/statue_test.rb
+- test/stopwatch_test.rb
 - test/test_helper.rb