rack-stats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc7935a3039650c4d289b6be87f66adf885aeddd
+  data.tar.gz: fee55ac0e408533efb715f04b5ec762b0e5caeed
+SHA512:
+  metadata.gz: d476473c31f7f136ed1c27a740f9542a64ee9697f692e123bf1bedee8d24bdcb59b31f98b50cdcb08fe779026c22e5492120267bb11d00def4baf0008b541c6e
+  data.tar.gz: 05b0ecae37c2ad5ea7bb9d7b6ee68b64351ccac0c22a63e6366fed72662306405dbdc0313dcd7120ce550b0e1857ca93ce120f99cca3e4423d35c368da928d15

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alexis Montagne
+
+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,29 @@
+# Rack::Stats
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-stats'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-stats
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack-stats/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,2 @@
+require "bundler/gem_tasks"
+

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'rack-stats', path: '..'

data/example/config.ru

@@ -0,0 +1,12 @@
+require 'sinatra'
+require 'rack/stats'
+
+use Rack::Stats
+
+get '/' do
+  [200, 'foo']
+end
+
+get '/foo' do
+  [201, 'bar']
+end

data/lib/rack/stats/runtime.rb

@@ -0,0 +1,33 @@
+require 'statsd'
+require 'rack'
+require 'rack/stats/timer'
+require 'rack/stats/stat'
+
+module Rack
+  class Stats
+    class Runtime
+      def initialize(statsd, app, env, stats)
+        @batch = Statsd::Batch.new statsd
+        @app, @env, @timer = app, env, Timer.new
+        @stats = stats.map do |stat|
+          klass = stat[:type] == :increment ? Stat::Increment : Stat::Timing
+          klass.new stat[:name], stat[:value], stat[:condition]
+        end
+      end
+
+      def execute
+        r = @timer.time { @app.call(@env) }
+        flush_data @timer.duration, Rack::Response.new(r.last, r.first, r[1])
+        r
+      end
+
+      def flush_data(duration, response)
+        @stats.each do |stat|
+          stat.execute @batch, Rack::Request.new(@env), duration, response
+        end
+
+        @batch.flush
+      end
+    end
+  end
+end

data/lib/rack/stats/stat.rb

@@ -0,0 +1,37 @@
+module Rack
+  class Stats
+    module Stat
+      class Base
+        def initialize(compute_name, compute_value = nil, condition = nil)
+          @compute_name, @compute_value, @condition = \
+            compute_name, compute_value, condition
+        end
+
+        def execute(batch, request, duration, response)
+          if @condition.nil? || @condition.call(request, duration, response)
+            send_data(batch, request, duration, response)
+          end
+        end
+      end
+
+      class Timing < Base
+        def send_data(batch, request, duration, response)
+          batch.send(
+            :timing,
+            [@compute_name.call(request, duration, response)].compact.join('.'),
+            @compute_value.call(request, duration, response)
+          )
+        end
+      end
+
+      class Increment < Base
+        def send_data(batch, request, duration, response)
+          batch.send(
+            :increment,
+            [@compute_name.call(request, duration, response)].compact.join('.')
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rack/stats/timer.rb

@@ -0,0 +1,23 @@
+module Rack
+  class Stats
+    class Duration
+      def initialize(ns)
+        @ns = ns
+      end
+
+      def ms; @ns / 1_000_000; end
+      def s; ms / 1_000; end
+    end
+
+    class Timer
+      attr_reader :duration
+
+      def time(&blk)
+        t0 = Time.now.nsec
+        r = blk.call
+        @duration = Duration.new(Time.now.nsec - t0)
+        r
+      end
+    end
+  end
+end

data/lib/rack/stats/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Stats
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/stats.rb

@@ -0,0 +1,46 @@
+require 'rack/stats/version'
+require 'rack/stats/runtime'
+
+module Rack
+  class Stats
+    DEFAULT_STATS = [
+      {
+        name: -> (*_args) { 'request_duration_global' },
+        value: -> (_req, d, _resp) { d.ms },
+        type: :timing
+      },
+      {
+        name: lambda do |req, _d, _resp|
+          [
+            req.path.eql?('/') ? 'index' : req.path.gsub(/\//, '-'),
+            req.request_method.downcase,
+            'request_duration'
+          ]
+        end,
+        value: -> (_req, d, _resp) { d.ms },
+        type: :timing
+      },
+      {
+        name: -> (*_args) { 'request_number' },
+        type: :increment
+      },
+      {
+        name: lambda do |_req, _d, resp|
+          ['request_number_status', "#{resp.status / 100}XX"]
+        end,
+        type: :increment
+      }
+    ]
+
+    def initialize(app, args = {})
+      @app = app
+      @namespace = args.fetch(:namespace, ENV['RACK_STATS_NAMESPACE'])
+      @statsd = Statsd.new(*args.fetch(:statsd, '127.0.0.1:8125').split(':'))
+      @stats = args.fetch(:stats, DEFAULT_STATS)
+    end
+
+    def call(env)
+      Runtime.new(@statsd, @app, env, @stats).execute
+    end
+  end
+end

data/rack-stats.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-stats"
+  spec.version       = Rack::Stats::VERSION
+  spec.authors       = ["Alexis Montagne"]
+  spec.email         = ["alexis.montagne@gmail.com"]
+  spec.summary       = %q{Customisable rack middleware to instrument to instrument your application}
+  spec.description   = %q{Customisable rack middleware to instrument to instrument your application}
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "statsd-ruby"
+  spec.add_runtime_dependency "rack"
+end

data/spec/acceptance/global_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Rack::Stats do
+  let(:middleware) { Rack::Stats.new(app, args) }
+  let(:app) { -> (e) { [200, { 'Content-Length' => 3 }, ['foo']] } }
+  let(:args) { { stats: [] } }
+  let(:env) { double }
+  let(:inc) { { name: -> (*_args) { 'foo' }, type: :increment } }
+  let(:tim) do
+    { name: -> (*_args) { 'foo' }, value: -> (*_args) { 42 }, type: :timing }
+  end
+
+  after { middleware.call(env) }
+
+  subject { Statsd::Batch  }
+
+  describe 'no stats' do
+    it { expect_any_instance_of(subject).to_not receive(:timing) }
+    it { expect_any_instance_of(subject).to_not receive(:increment) }
+  end
+
+  describe 'increment metric' do
+    let(:args) { { stats: [inc] } }
+
+    it { expect_any_instance_of(subject).to_not receive(:timing) }
+    it do
+      expect_any_instance_of(subject).to receive(:increment).with('foo').once
+    end
+  end
+
+  describe 'timing metric' do
+    let(:args) { { stats: [tim] } }
+
+    it { expect_any_instance_of(subject).to_not receive(:increment) }
+    it do
+      expect_any_instance_of(subject).to receive(:timing).with('foo', 42).once
+    end
+  end
+
+  describe 'both types at the same time' do
+    let(:args) { { stats: [tim, inc] } }
+
+    it do
+      expect_any_instance_of(subject).to receive(:increment).with('foo').once
+    end
+    it do
+      expect_any_instance_of(subject).to receive(:timing).with('foo', 42).once
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+require 'rack/stats'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rack-stats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexis Montagne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Customisable rack middleware to instrument to instrument your application
+email:
+- alexis.montagne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/rack/stats.rb
+- lib/rack/stats/runtime.rb
+- lib/rack/stats/stat.rb
+- lib/rack/stats/timer.rb
+- lib/rack/stats/version.rb
+- rack-stats.gemspec
+- spec/acceptance/global_spec.rb
+- spec/spec_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.2.2
+signing_key: 
+specification_version: 4
+summary: Customisable rack middleware to instrument to instrument your application
+test_files:
+- spec/acceptance/global_spec.rb
+- spec/spec_helper.rb