tweek_metrics 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDEzZmFhN2JjMGI5N2UyMzJhZDkxNzJmODFmMDljY2ZlNzM5ZDk3OA==
+  data.tar.gz: !binary |-
+    ZDQ5NTlkZTlhZjkxNjkwM2QwZTRlMzU0MmQ4YzBjNWI2NTRhODQxMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTYxZjk4MzA1ODA4YWM5OWMzY2QyMDMzZGM4MTU5MjRmY2ZlYTkzNjVlYWM0
+    MzNjM2Y4ZTcxNmNlODZhZTg4YTQ5NzhkN2EyMDdjOWM0MWI1NTI1NjI4YWUy
+    NzJmYWU2ZGJkNWI5NDhjNmI2YTZjYjMxMjg3NjFiZjc3NzM3Zjc=
+  data.tar.gz: !binary |-
+    NGVjMTBmNmM2ZWQ3NzlmMjRhY2E4NmM2MTdlOTAyZWQxMDJmYTBkOGY3NTcz
+    NGJhZmRjMWZjYTExY2MyM2ZlMmI5MGVmNDQ1OTRkOTQ1NjM0MzUzNjNlYTUy
+    ZWU4NWQyMTFhNjk1ZmQ1ZTFmODQ3ZGM2NGEyMzRiOWJiMWQ4ZWQ=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 elvio
+
+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 @@
+# TweekMetrics
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tweek_metrics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tweek_metrics
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,25 @@
+require "bundler"
+Bundler.setup
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :build do
+  system "gem build tweek_metrics.gemspec"
+end
+
+task :install => :build do
+  system "gem install pkg/tweek_metrics-#{TweekApiAuth::VERSION}.gem"
+end
+
+task :release => :build do
+  system "git tag -a v#{TweekMetrics::VERSION} -m 'Tagging #{TweekMetrics::VERSION}'"
+  system "git push --tags"
+  system "rm *.gem"
+end
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/tweek_metrics/handler.rb

@@ -0,0 +1,46 @@
+require "benchmark"
+
+module TweekMetrics
+  class Handler
+    attr_reader :instruments, :key
+
+    def initialize(instruments, key, &block)
+      @instruments = instruments
+      @key = key
+      @block = block
+
+      handle!
+    end
+
+    def handle!
+      if @block
+        begin
+          @real_time = Benchmark.measure { @block.call }.real
+        rescue => e
+          @exception = e
+        end
+      end
+
+      if @exception
+        TweekMetrics.statsd.increment(create_key(TweekMetrics.namespace, :global, :exception, @exception.class.name))
+        TweekMetrics.statsd.increment(create_key(TweekMetrics.namespace, TweekMetrics.client, :exception, @exception.class.name))
+      else
+        if instruments.include?(:counter)
+          TweekMetrics.statsd.increment(create_key(TweekMetrics.namespace, :global, key))
+          TweekMetrics.statsd.increment(create_key(TweekMetrics.namespace, TweekMetrics.client, key))
+        end
+
+        if instruments.include?(:time)
+          TweekMetrics.statsd.timing(create_key(TweekMetrics.namespace, :global, key), @real_time)
+          TweekMetrics.statsd.timing(create_key(TweekMetrics.namespace, TweekMetrics.client, key), @real_time)
+        end
+      end
+    end
+
+    private
+
+    def create_key(*items)
+      items.flatten.compact.join(".")
+    end
+  end
+end

data/lib/tweek_metrics/version.rb

@@ -0,0 +1,3 @@
+module TweekMetrics
+  VERSION = "0.0.2"
+end

data/lib/tweek_metrics.rb

@@ -0,0 +1,42 @@
+require "statsd"
+require "tweek_metrics/version"
+require "tweek_metrics/handler"
+
+module TweekMetrics
+  @@config = {}
+  @@statsd = nil
+
+  def self.set_statsd_host(host)
+    @@config[:statsd_host] = host
+  end
+
+  def self.set_statsd_port(port)
+    @@config[:statsd_port] = port
+  end
+
+  def self.set_client(client)
+    @@config[:client] = client
+  end
+
+  def self.set_namespace(namespace)
+    @@config[:namespace] = namespace
+  end
+
+  def self.namespace
+    @@config[:namespace]
+  end
+
+  def self.client
+    @@config[:client]
+  end
+
+  def self.statsd
+    @@statsd ||= Statsd.new(@@config[:statsd_host], @@config[:statsd_port])
+  end
+
+  def self.measure(instruments, key, &block)
+    raise ArgumentError.new("instruments must be an Array") unless instruments.kind_of?(Array)
+    raise ArgumentError.new("key must be an Array") unless key.kind_of?(Array)
+    Handler.new(instruments, key, &block)
+  end
+end

data/spec/handler_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe TweekMetrics::Handler do
+  let(:statsd) { double("Statsd") }
+
+  class Fake
+    def self.execute
+    end
+  end
+
+  before do
+    TweekMetrics.stub(:statsd).and_return(statsd)
+    statsd.stub(:increment)
+    statsd.stub(:timing)
+  end
+
+  context "measuring counter" do
+    it "increments the global counter" do
+      TweekMetrics.measure([:counter, :time], [:request]) { Fake.execute }
+      expect(statsd).to have_received(:increment).with("#{$API_NAME}.global.request")
+    end
+
+    it "increments the client specific counter" do
+      TweekMetrics.measure([:counter, :time], [:request]) { Fake.execute }
+      expect(statsd).to have_received(:increment).with("#{$API_NAME}.#{$CLIENT_NAME}.request")
+    end
+  end
+
+  context "measuring timing" do
+    it "adds a new value to the global timing" do
+      TweekMetrics.measure([:counter, :time], [:request]) { Fake.execute }
+      expect(statsd).to have_received(:timing).with("#{$API_NAME}.global.request", kind_of(Numeric))
+    end
+
+    it "adds a new value to the client specific timing" do
+      TweekMetrics.measure([:counter, :time], [:request]) { Fake.execute }
+      expect(statsd).to have_received(:timing).with("#{$API_NAME}.#{$CLIENT_NAME}.request", kind_of(Numeric))
+    end
+  end
+
+  context "exception handler" do
+    before do
+      expect(Fake).to receive(:execute).and_raise(ArgumentError.new)
+    end
+
+    it "increments the global exception counter" do
+      TweekMetrics.measure([:counter, :time], [:request]) { Fake.execute }
+      expect(statsd).to have_received(:increment).with("#{$API_NAME}.global.exception.ArgumentError")
+    end
+
+    it "increments the client exception counter" do
+      TweekMetrics.measure([:counter, :time], [:request]) { Fake.execute }
+      expect(statsd).to have_received(:increment).with("#{$API_NAME}.#{$CLIENT_NAME}.exception.ArgumentError")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "bundler/setup"
+require "tweek_metrics"
+require "rspec/expectations"
+
+$CLIENT_NAME = "tester"
+$API_NAME = "test_api"
+
+RSpec.configure do |config|
+  config.before(:all) do
+    TweekMetrics.set_client($CLIENT_NAME)
+    TweekMetrics.set_namespace($API_NAME)
+  end
+end

data/spec/tweek_metrics_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe TweekMetrics do
+  let(:instruments) { [:timing, :counter] }
+  let(:key) { [:account, :test] }
+
+  it "delegates to TweekMetrics::Handler" do
+    expect(TweekMetrics::Handler).to receive(:new).with(instruments, key)
+    TweekMetrics.measure(instruments, key)
+  end
+
+  context "when instruments are not known" do
+    it "raises an error" do
+      expect { TweekMetrics.measure(1, key) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "when provided instruments are not an Array like" do
+    it "raises an error" do
+      expect { TweekMetrics.measure(instruments, 1) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/tweek_metrics.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tweek_metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tweek_metrics"
+  spec.version       = TweekMetrics::VERSION
+  spec.authors       = ["elvio"]
+  spec.email         = ["elvio@elviovicosa.com"]
+  spec.description   = %q{Measure activity using StatsD}
+  spec.summary       = %q{Measure activity using StatsD: Simple wrapper for Tweek specific needs}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "statsd-ruby"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: tweek_metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- elvio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-22 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Measure activity using StatsD
+email:
+- elvio@elviovicosa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tweek_metrics.rb
+- lib/tweek_metrics/handler.rb
+- lib/tweek_metrics/version.rb
+- spec/handler_spec.rb
+- spec/spec_helper.rb
+- spec/tweek_metrics_spec.rb
+- tweek_metrics.gemspec
+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.0.0
+signing_key: 
+specification_version: 4
+summary: ! 'Measure activity using StatsD: Simple wrapper for Tweek specific needs'
+test_files:
+- spec/handler_spec.rb
+- spec/spec_helper.rb
+- spec/tweek_metrics_spec.rb