tzu_stats 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8d634f7f638b36e3757377ced48691433aa614b
+  data.tar.gz: 07ca6f7a9649bbe2f9ada9d68ea1abdfc82286e2
+SHA512:
+  metadata.gz: 37824bcdb56fe692fae06c575081d4b5e863b27c67e48ee6d605caed64e1898fb8e5a4763de67ba7ff8f428fbd7e49028dafdfdbee094b6a8be4d4b00143d4b5
+  data.tar.gz: 18d4abe9617383ca0dde37a23174748e45a74cf0e0aebc3389d4156bb76f39af8dbc12b12263a5a16ef2f2cd901cb7f60d4083145c968e8ac62a874d387a4306

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Morgan Bruce
+
+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,51 @@
+# TzuStats
+
+TzuStats uses Shopify's terrific [statsd-instrument gem](https://github.com/Shopify/statsd-instrument/) to instrument Tzu commands using StatsD.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tzu_stats'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tzu_stats
+
+## Usage
+
+Once installed in your application, the following statistics will automatically be pushed when `run!` or `run` is called on a Tzu command:
+
+```
+# time taken for a successful run (in milliseconds)
+[StatsD] measure DoStuff.run:1000.6256770575419
+
+# counts of success, invalid and failed outcomes
+[StatsD] increment DoStuff.run.success:1
+[StatsD] increment DoInvalidStuff.run.invalid:1
+[StatsD] increment DoFailingStuff.run.failure:1
+```
+
+The metric key used is `{name of command}.run.{outcome}`.
+
+Use [statsd-instrument](https://github.com/Shopify/statsd-instrument/#configuration) to configure your backend appropriately.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/onfido/tzu_stats.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tzu_stats"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tzu_stats.rb

@@ -0,0 +1,40 @@
+require 'tzu_stats/version'
+
+module TzuStats
+  def self.extended(base)
+    base.send :extend, StatsD::Instrument
+
+    # measures time taken
+    base.statsd_measure :run!, ->(obj, args) { "#{obj.class.to_s}.run" }
+
+    # count success, invalid & failure
+    base.statsd_count_outcomes :run!, ->(obj, args) { "#{obj.class.to_s}.run" }
+  end
+
+  def statsd_count_outcomes(method, name, *metric_options)
+    add_to_method(method, name, :count_outcomes) do |old_method, new_method, metric_name|
+      define_method(new_method) do |*args, &block|
+        begin
+          truthiness = result = send(old_method, *args, &block)
+        rescue => e
+          truthiness, exception = false, e
+          raise
+        else
+          result
+        ensure
+          if truthiness
+            suffix = 'success'
+          else
+            suffix = exception && exception.is_a?(Tzu::Invalid) ? 'invalid' : 'failure'
+          end
+
+          key = "#{StatsD::Instrument.generate_metric_name(metric_name, self, *args)}.#{suffix}"
+          StatsD.increment(key, 1, *metric_options)
+        end
+      end
+    end
+  end
+
+end
+
+Tzu.send :extend, TzuStats

data/lib/tzu_stats/version.rb

@@ -0,0 +1,3 @@
+module TzuStats
+  VERSION = "1.0.0"
+end

data/tzu_stats.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tzu_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tzu_stats"
+  spec.version       = TzuStats::VERSION
+  spec.authors       = ["Morgan Bruce"]
+  spec.email         = ["morgan@onfido.com"]
+
+  spec.summary       = 'Collects metrics from Tzu commands using statsd-instrument'
+  spec.homepage      = 'https://github.com/onfido/tzu_stats'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'tzu', '~> 0.1'
+  spec.add_dependency 'statsd-instrument'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: tzu_stats
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Morgan Bruce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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: 
+email:
+- morgan@onfido.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tzu_stats.rb
+- lib/tzu_stats/version.rb
+- tzu_stats.gemspec
+homepage: https://github.com/onfido/tzu_stats
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Collects metrics from Tzu commands using statsd-instrument
+test_files: []