statue 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1fa0a08733f36d16fb2077a11502e4baf8673e0
+  data.tar.gz: f7dc8e88e84566bce9a115f8258432cba6e27323
+SHA512:
+  metadata.gz: 9210bfd9f5062a4e8d0d342b2f5128805646c74f73851a1f0828fdb5e30177250ba84580b749ab7e0ca5e9fec3efa64f93fb7b83a327e2cdb7cc30ae74d426bc
+  data.tar.gz: 6660261b0e9b82b2aa1e378d8ad09c436b811c239acc320e3a5142cc2c7524249d3256f71b0c7903facf8eb0bb6f58d5172cdadeb9063620706e6bbad306db6e

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/Gemfile.lock
+/tmp/
+*.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in statue.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Juan Barreneche
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Statue
+
+    / ___)(_  _)/ _\(_  _)/ )( \(  __)
+    \___ \  )( /    \ )(  ) \/ ( ) _)
+    (____/ (__)\_/\_/(__) \____/(____)
+Rock solid metrics report...
+
+Easily track application metrics into [Statsite](https://github.com/armon/statsite) (Statsd compatible).
+
+## Configuration
+
+The library has different backends, one to be used for production environment (ie. actually
+ sending metrics using the Statsd protocol), and the others for testing or developing.
+
+The available backends are:
+
+`Statue::UDPBackend` -> this is the one that actually sends metrics to the Statsd.
+
+eg.
+```ruby
+Statue.backend = Statue::UDPBackend.new(statsd_host, statsd_port)
+```
+
+`Statue::NullBackend`, this backend discards all metrics (useful for test environment, if you
+aren't interested in testing which metrics are sent).
+
+`Statue::CaptureBackend`, this backend collects all metrics (useful for test environment, if you
+arent interested in testing which metrics are sent). You can check the metrics with `Statue.backend.captures`
+and reset this array with `Statue.backend.captures.clear` or by setting a new instance before each test.
+
+`Statue::LoggerBackend`, this backend logs the received metrics to a logger (useful for development purposes)
+
+eg.
+```ruby
+Statue.backend = Statue::LoggerBackend.new(Rails.logger)
+```
+
+## Usage
+
+`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_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`.
+
+### Rack Integration
+
+We provide a middleware to track basic request metrics, see: Statue::RackStatistics
+
+## Contributing
+
+1. Fork it ( https://github.com/restorando/statue/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+

data/lib/statue/backends/capture.rb

@@ -0,0 +1,15 @@
+module Statue
+  class CaptureBackend
+    attr_reader :captures
+
+    def initialize
+      @captures = []
+    end
+
+    def collect_metric(metric)
+      @captures << metric
+    end
+    alias :<< :collect_metric
+
+  end
+end

data/lib/statue/backends/logger.rb

@@ -0,0 +1,10 @@
+module Statue
+  class LoggerBackend < Struct.new(:logger)
+
+    def collect_metric(metric)
+      logger.info("Statue") { metric.to_s }
+    end
+    alias :<< :collect_metric
+
+  end
+end

data/lib/statue/backends/null.rb

@@ -0,0 +1,9 @@
+module Statue
+  class NullBackend
+
+    def collect_metric(metric)
+    end
+    alias :<< :collect_metric
+
+  end
+end

data/lib/statue/backends/udp.rb

@@ -0,0 +1,33 @@
+require 'socket'
+
+module Statue
+  class UDPBackend
+    attr_reader :address
+
+    def initialize(host = nil, port = nil)
+      @address = Addrinfo.udp(host || "127.0.0.1", port || 8125)
+    end
+
+    def collect_metric(metric)
+      if metric.sample_rate == 1 || rand < metric.sample_rate
+        send_to_socket metric.to_s
+      end
+    end
+    alias :<< :collect_metric
+
+    private
+
+    def socket
+      @socket ||= address.connect
+    end
+
+    def send_to_socket(message)
+      Statue.debug(message)
+      socket.send(message, 0)
+    rescue => e
+      Statue.error("#{e.class} #{e}")
+      nil
+    end
+
+  end
+end

data/lib/statue/backends.rb

@@ -0,0 +1,6 @@
+module Statue
+  autoload :LoggerBackend,  "statue/backends/logger"
+  autoload :CaptureBackend, "statue/backends/capture"
+  autoload :NullBackend,    "statue/backends/null"
+  autoload :UDPBackend,     "statue/backends/udp"
+end

data/lib/statue/metric.rb

@@ -0,0 +1,48 @@
+module Statue
+  class Metric
+    TYPES = {
+      c:  'increment',
+      ms: 'measure',
+      g:  'gauge',
+      kv: 'key/value',
+      s:  'set'
+    }
+
+    attr_accessor :type, :name, :value, :sample_rate
+
+    def self.counter(name, value = 1, **options)
+      new(type: :c, value: value, name: name, **options)
+    end
+
+    def self.measure(name, duration: nil, **options, &block)
+      value = duration || Statue.duration(&block)
+      new(type: :ms, value: value, name: name, **options)
+    end
+
+    def initialize(type:, name:, value:, sample_rate: 1.0)
+      @type  = type
+      @name  = name
+      @value = value
+      @sample_rate = sample_rate
+    end
+
+    def to_s
+      str = "#{full_name}:#{value}|#{type}"
+      str << "|@#{sample_rate}" if sample_rate != 1.0
+      str
+    end
+
+    def inspect
+      "#<StatsD::Instrument::Metric #{full_name} #{TYPES[type]}(#{value})@#{sample_rate}>"
+    end
+
+    def full_name
+      if Statue.namespace
+        "#{Statue.namespace}.#{@name}"
+      else
+        @name
+      end
+    end
+
+  end
+end

data/lib/statue/rack_statistics.rb

@@ -0,0 +1,117 @@
+require 'statue'
+
+module Statue
+  # Middleware to send metrics about rack requests
+  #
+  # this middleware reports metrics with the following pattern:
+  #  `request.{env['REQUEST_METHOD']}.{path_name}
+  #
+  # where `path_name` can be configured when inserting the middleware like this:
+  #   `use RackStatistics, path_name: ->(env) { ... build the path name ... }`
+  # You can build the path using the environment information in the lambda or
+  # you can delegate that logic to your app stack and later fetching it from
+  # the env, Eg:
+  #   `use RackStatistics, path_name: ->(env) { env['route.path_name'] }`
+  #
+  # This middleware will report the following metrics
+  #
+  # Counters:
+  #
+  # * <key>.status-XXX (where XXX is the status code)
+  # * <key>.success    (on any status 2XX)
+  # * <key>.unmodified (on status 304)
+  # * <key>.redirect   (on any status 3XX)
+  # * <key>.failure    (on any status 4xx)
+  # * <key>.error      (on any status 5xx or when an exception is raised)
+  #
+  # Timers (all measured from the middleware perspective):
+  #
+  # * <key> (request time)
+  # * request.queue (queue time, depends on HTTP_X_QUEUE_START header)
+  #
+  # To get accurate timers, the middleware should be as higher as
+  # possible in your rack stack
+  #
+  class RackStatistics
+    DEFAULT_PATH_NAME = lambda do |env|
+      # Remove duplicate and trailing '/'
+      path = env['REQUEST_PATH'].squeeze('/').chomp('/')
+      if path == ''
+        'root'
+      else
+        # Skip leading '/'
+        env['REQUEST_PATH'][1..-1].tr('/,|', '-')
+      end
+    end
+
+    def initialize(app, path_name: DEFAULT_PATH_NAME)
+      @app = app
+      @path_name  = path_name
+    end
+
+    def call(env)
+      report_header_metrics(env)
+
+      response = nil
+      duration = Statue.duration do
+        response = @app.call(env)
+      end
+
+      report_response_metrics(env, response, duration)
+
+      response
+    rescue => e
+      report_exception(env, e) and raise
+    end
+
+    private
+
+    def report_header_metrics(env)
+      if start_header = env['HTTP_X_QUEUE_START']
+        queue_start = start_header[/t=([\d\.]+)/, 1].to_f
+        Statue.report_duration 'request.queue', Time.now.to_f - queue_start
+      end
+    end
+
+    def report_response_metrics(env, response, duration)
+      metric_name = metric_name(env)
+      status, _headers, _body = response
+
+      Statue.report_duration metric_name, duration
+
+      Statue.report_increment "#{metric_name}.status-#{status}"
+      Statue.report_increment "#{metric_name}.#{status_group(status)}"
+    end
+
+    def report_exception(env, _exception)
+      Statue.report_increment "#{metric_name(env)}.error"
+    end
+
+    def metric_name(env)
+      "request.#{env['REQUEST_METHOD']}.#{@path_name.call(env)}"
+    end
+
+    # success: ok (2XX)
+    # failure: client error (4xx)
+    # error: server error (5xx)
+    # unmodified: (304)
+    # redirect: (3XX)
+    def status_group(status)
+      case status
+      when 100..299
+        'success'
+      when 304
+        'unmodified'
+      when 300..399
+        'redirect'
+      when 400..499
+        'failure'
+      when 500..599
+        'error'
+      else
+        'invalid-status'
+      end
+    end
+
+  end
+end

data/lib/statue/version.rb

@@ -0,0 +1,3 @@
+module Statue
+  VERSION = '0.1.1'
+end

data/lib/statue.rb

@@ -0,0 +1,59 @@
+require 'statue/version'
+
+require 'statue/backends'
+require 'statue/metric'
+
+module Statue
+  extend self
+
+  attr_accessor :namespace, :logger
+
+  attr_accessor :backend
+
+  def report_duration(metric_name, duration = nil, **options, &block)
+    result = nil
+    backend << Metric.measure(metric_name, duration: duration, **options) do
+      result = block.call
+    end
+    result
+  end
+
+  def report_increment(metric_name, **options)
+    backend << Metric.counter(metric_name, **options)
+  end
+
+  def report_success_or_failure(metric_name, success_method: nil, **options, &block)
+    result  = block.call
+    success = success_method ? result.public_send(success_method) : result
+
+    if success
+      report_increment("#{metric_name}.success", **options)
+    else
+      report_increment("#{metric_name}.failure", **options)
+    end
+
+    result
+  rescue
+    report_increment("#{metric_name}.failure", **options)
+    raise
+  end
+
+  def backend
+    @backend ||= UDPBackend.new
+  end
+
+  def duration
+    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    yield
+    Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+  end
+
+  def debug(text, &block)
+    logger.debug(text, &block) if logger
+  end
+
+  def error(text, &block)
+    logger.error(text, &block) if logger
+  end
+
+end

data/statue.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'statue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "statue"
+  spec.version       = Statue::VERSION
+  spec.authors       = ["Juan Barreneche"]
+  spec.email         = ["devs@restorando.com"]
+  spec.summary       = %q{Easily track application metrics into Statsie}
+  spec.description   = %q{Track application metrics to Statsie}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/test/statue_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+describe Statue do
+  after do
+    Statue.backend.captures.clear
+  end
+
+  describe ".report_increment" do
+    it "Adds a counter metric to the backend" do
+      Statue.report_increment("some.counter")
+
+      assert_equal 1, Statue.backend.captures.size
+      assert_equal "some.counter:1|c", Statue.backend.captures.first.to_s
+    end
+  end
+
+  describe ".report_duration" do
+
+    it "adds a measure metric to the backend using the block call duration" do
+      Statue.stub(:duration, 1.5) do
+        result = Statue.report_duration("some.timer") { nil }
+
+        assert_equal 1, Statue.backend.captures.size
+        assert_equal "some.timer:1.5|ms", Statue.backend.captures.first.to_s
+      end
+    end
+
+    it "returns the block result" do
+      result = Statue.report_duration("some.timer") { 42 }
+
+      assert_equal 42, result
+    end
+
+    it "adds a measure metric to the backend using the fixed value" do
+      result = Statue.report_duration("some.timer", 2.5)
+
+      assert_equal 1, Statue.backend.captures.size
+      assert_equal "some.timer:2.5|ms", Statue.backend.captures.first.to_s
+    end
+
+    it "doesn't report duration if an exception is thrown" do
+      begin
+        Statue.report_duration("some.timer") { raise "error" }
+      rescue => e
+        assert_equal "error", e.message
+        assert_empty Statue.backend.captures
+      end
+    end
+
+  end
+
+  describe ".report_success_or_failure" do
+
+    it "Adds a counter metric to the backend with .success suffix with a truthy result" do
+      Statue.report_success_or_failure("some.event") { 42 }
+
+      assert_equal 1, Statue.backend.captures.size
+      assert_equal "some.event.success:1|c", Statue.backend.captures.first.to_s
+    end
+
+    it "Adds a counter metric to the backend with .failure suffix with a falsey result" do
+      Statue.report_success_or_failure("some.event") { nil }
+
+      assert_equal 1, Statue.backend.captures.size
+      assert_equal "some.event.failure:1|c", Statue.backend.captures.first.to_s
+    end
+
+    it "returns the block result" do
+      result = Statue.report_success_or_failure("some.event") { 42 }
+
+      assert_equal 42, result
+    end
+
+    it "Adds a counter metric to the backend with .failure suffix when an exception ocurrs" do
+      begin
+        Statue.report_success_or_failure("some.event") { raise "error" }
+      rescue => e
+        assert_equal "error", e.message
+        assert_equal 1, Statue.backend.captures.size
+        assert_equal "some.event.failure:1|c", Statue.backend.captures.first.to_s
+      end
+    end
+
+    it "allows to use a symbol for a custom success_method" do
+      Statue.report_success_or_failure("some.zero_event", success_method: :zero?) { 0 }
+      Statue.report_success_or_failure("some.life_event", success_method: :zero?) { 42 }
+      zero_event, life_event = Statue.backend.captures
+
+      assert_equal 2, Statue.backend.captures.size
+      assert_equal "some.zero_event.success:1|c", zero_event.to_s
+      assert_equal "some.life_event.failure:1|c", life_event.to_s
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'statue'
+
+Statue.backend = Statue::CaptureBackend.new

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: statue
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Juan Barreneche
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Track application metrics to Statsie
+email:
+- devs@restorando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/statue.rb
+- lib/statue/backends.rb
+- lib/statue/backends/capture.rb
+- lib/statue/backends/logger.rb
+- lib/statue/backends/null.rb
+- lib/statue/backends/udp.rb
+- lib/statue/metric.rb
+- lib/statue/rack_statistics.rb
+- lib/statue/version.rb
+- statue.gemspec
+- test/statue_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Easily track application metrics into Statsie
+test_files:
+- test/statue_test.rb
+- test/test_helper.rb