ventable-statsd 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcc39504e8969b950d09412fb294e9374363113b
+  data.tar.gz: 6404aafc8fc04e43600bb7ac613a84566b0e133e
+SHA512:
+  metadata.gz: 51acb90d7d8a388ab4b652b0380bfd9642de5d78dae31af1237a943228a9105e323bf072aebf200630396cf5e32f2ed470030f154ebcb0bffa817f9f3c55793b
+  data.tar.gz: a787a16e1d26efcb7388d1611f708e01404a9c1659cbfc38dc1ffa1f710079ddbf980d52d26249f27dcc27752d89afe6da7a0c3b7fbb009b38d2a2486aa4acae

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/doc/
+/spec/reports/
+/spec/coverage/
+/tmp/
+.idea
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Konstantin Gredeskoul
+
+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,227 @@
+
+[![Build Status](https://travis-ci.org/kigster/ventable-statsd.svg?branch=master)](https://travis-ci.org/kigster/ventable-statsd)
+[![Gem Version](https://badge.fury.io/rb/ventable-statsd.svg)](https://badge.fury.io/rb/ventable-statsd)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kigster/simple-feed/master/LICENSE.txt)
+
+# Ventable::Statsd – Easily Track Application Events with Statsd
+
+This library is a small extension to the
+[Ventable](https://github.com/kigster/ventable) eventing library. It
+provides out of the box support for tracking Ventable events using
+Statsd. 
+
+Why? Because by utilizing Ventable's powerful abstraction you can map
+the most important events in the system as classes, and then subscribe
+them all globally to the `Statsd` collector.
+
+This gem does not depend on any particular implementation of `statsd`
+client library, and it expects that you create a `statsd` client and
+pass it via the `.configure` to the `Ventable::Statsd`. 
+
+The client should typically respond to the methods such as `increment`,
+`gauge`, `set`, `measure` and expect the metric name and value to be
+it's parameters. The methods were modelled based on the
+[`statsd-instrument`](https://github.com/Shopify/statsd-instrument) ruby
+gem, but it should be compatible with many others.
+
+## Usage
+
+The gem works as follows:
+
+1. You configure the backend
+2. You register your ventable events to notify `Ventable::Statsd`
+3. You either follow the default naming strategy, or provide your own.
+   See [Naming Events](#naming-events) further down.
+
+### Configuration
+
+Before we can track our events, let's configure our statsd:
+
+```ruby
+require 'statsd-instrument'
+require 'ventable/statsd'
+
+# see https://github.com/Shopify/statsd-instrument for more info
+StatsD.backend = StatsD::Instrument::Backends::UDPBackend.new("172.16.0.1:8125", :statsd)
+
+Ventable::Statsd.configure do |config|
+  config.statsd = StatsD
+  config.enabled = true
+end
+```
+
+### Registration of the Events
+
+Now we must connect the event dispatch mechanism with the
+`Ventable::Statsd` module:
+
+```ruby
+class ApplicationOpenedEvent
+  include Ventable::Event
+end
+
+# Subscribe the event to track event dispatch
+ApplicationOpenedEvent.notifies Ventable::Statsd
+
+# Now fire the event, and it should send a packet to statsd!
+ApplicationOpenedEvent.new.fire!
+#=> calls StatsD.increment('application_opened_count', 1)
+```
+
+Or you can register `Ventable::Statsd` in a super class of all of your
+application events, so that you don't have to repeat this code:
+
+```ruby
+class AbstractEvent
+  def self.inherited(klass)
+    klass.instance_eval do
+      include Ventable::Event
+    end
+    klass.notifies Ventable::Statsd
+  end
+end
+
+class ApplicationOpenedEvent < AbstractEvent; end
+```
+
+<a name='naming-events'></a>
+
+### Naming Metrics from Events
+  
+The biggest customization lies within the way you might like to map
+various event occurring to a specific metric name in the Graphite
+database.
+
+As you might now, when metric name is separated by a dot '.', Graphite
+create sub-folders and group sub-metrics together. For example
+`order.completed.count` and `order.cancelled.count` would be grouped
+together under `order.*` in Graphite.
+
+This is why the default naming scheme uses your event class name,
+converts it to a lower-case underscored version, and replaces all
+underscores with a dot (while also removing redundant `_event` if
+there). This way, an event named, say `UserRegistrationCompletedEvent`
+would be converted to a metric name `user.registration.completed.count`.
+Note how the default metric type is `count`, which would be registered
+by calling `increment(name, 1)` on `Statsd`.
+
+#### Customizing Event-to-Metric Naming 
+
+But what if you wanted to customize how metrics are called? 
+
+What if you want to keep track of some events as a gauge and not the counter?
+
+In these and other cases, there are two ways to customize the event
+names. But before we jump in to see how these are configured, let's
+discuss what these procs are expected to return.
+
+##### Event Naming Hash
+
+The *return* of naming customization method/proc is a complete or any
+portion of the following hash — and here are a couple of examples that
+hopefully explain how this hash is used by the library:
+
+```ruby
+ # Method to call on statsd; and its value        Metric to pass to Statsd
+ { method: :increment, value: 1,           name: 'graphite.metric.name' }
+ { method: :gauge,     value: event.total, name: 'graphite.aggregate.gauge' }
+```
+
+
+##### Globally via a Proc
+ 
+You can configure a proc at the top level that receives an event as a
+parameter, and returns an _event naming hash_ (see above) for a given
+event. This can be useful if you can write a single proc that covers all
+of your cases in one place, but is distinct from the default naming.
+
+The argument to the proc or method is the event instance. 
+
+Below we provide the metric naming algorithm in the configuration clause
+for the gem:
+
+```ruby
+Ventable::Stats.configure do |c|
+  # this would return a name 'my_event.count' for MyEvent
+  c.event_to_metric_proc = ->(event) { { method: :increment,
+                                          value:  1,
+                                           name:  event.class.name.underscore + '.count' } }
+end
+```
+
+##### Via a class method `statsd_config`
+
+You can also configure each event with a class method `statsd_config`
+that receives an event instance as an argument, and must return the
+_event naming hash_ to customize the naming and statsd methods.
+
+While in the previous example above the proc was applied to all events,
+the following would only apply to the concrete event classes below:
+
+```ruby
+class OrderShippedEvent
+  attr_accessor :carrier
+  class << self
+    def statsd_config
+        ->(event) { { method: :increment,
+                       value:  1,
+                        name:  "order.shipped.#{event.carrier.code}.count" } }
+    end
+  end                      
+end
+
+class OrderReturnStartedEvent
+  class << self
+    def statsd_config
+        ->(*) { { name:  'order.returns.count' } }
+    end
+  end                      
+end
+```
+
+The above examples demonstrate the flexibility of the naming: 
+
+1. In the first example, `OrderShippedEvent` is supposed have `carrier`
+   accessor, which in turn has a `code` — presumably returning a short
+   string, one of `%w(fedex ups dhl)` etc. By using this custom naming
+   scheme we are able to group in Graphite our shipping completions by
+   carrier without having to create a new event class for each carrier
+   type.
+2. In the second example we do not care about the event instance, but
+   provide the gem with an alternative name for this event. Note also
+   that we are not including `:method` or `:value`, which would then be
+   used from the defaults.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ventable-statsd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ventable-statsd
+
+## 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/kigster/ventable-statsd.
+
+
+## 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,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+require 'yard'
+
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE.txt)
+  t.options.unshift('--title', '"SimpleFeed — Fast and Scalable "write-time" Simple Feed for Social Networks, with a Redis-based default backend implementation."')
+  t.after = ->() { exec('open doc/index.html') } if RUBY_PLATFORM =~ /darwin/
+end
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ventable/statsd"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ventable/statsd.rb

@@ -0,0 +1,38 @@
+require 'ventable/statsd/version'
+require 'ventable/statsd/tracker'
+
+module Ventable
+  module Statsd
+    # @!parse extend Ventable::Statsd::Tracker::InstanceMethods
+    def tracker
+      Ventable::Statsd::Tracker.instance
+    end
+
+    def self.tracker
+      Ventable::Statsd::Tracker.instance
+    end
+
+    def self.configure
+      yield(Ventable::Statsd::Tracker.instance)
+    end
+
+    class << self
+      # @!macro [attach] generate_method
+      #   @method $1_way
+      #   Sends $1 to +Ventable::Statsd::Tracker.instance+
+      def self.gen(method)
+        define_method(method) do |*args|
+          tracker.send(method, *args)
+        end
+      end
+
+      gen :handle_event
+      gen :event_to_metric
+      gen :event_to_metric_proc=
+      gen :enable!
+      gen :disable!
+      gen :statsd=
+
+   end
+  end
+end

data/lib/ventable/statsd/tracker.rb

@@ -0,0 +1,102 @@
+require 'singleton'
+require 'ventable'
+require 'active_support/inflections'
+
+module Ventable
+  module Statsd
+    PROXIED_METHODS       = %i(increment gauge set measure)
+
+    DEFAULT_CONFIGURATION = ->(event) { { method: :increment,
+                                          value:  1,
+                                          name:   event_to_metric(event) + '.count' } }
+
+    # Main interface class which delegates some methods to the instance of
+    # statsd in order to increment, or gauge/set various metrics.
+    #
+    # @attr [Statsd] statsd any statsd interface class that responds to methods listed in +PROXIED_METHODS+
+    # @attr_reader [Bool] enabled set to false to bypass delegation
+    # @attr_writer [Proc] event_to_metric_proc optional proc returning event configuration hash
+    class Tracker
+      include Singleton
+
+      attr_writer :statsd, :enabled, :event_to_metric_proc
+
+      private
+
+      def initialize
+        super
+        @statsd               = nil
+        @enabled              = true
+        @event_to_metric_proc = nil
+      end
+
+      public
+
+      PROXIED_METHODS.each do |method|
+        define_method(method) do |metric, amount, *args|
+          @statsd.send(method, metric, amount, *args)
+        end
+      end
+
+      def enable!
+        self.enabled = true
+      end
+
+      def disable!
+        self.enabled = false
+      end
+
+      # A wrapper around the actual +Statsd+, which checks whether
+      # the gem is enabled or disabled before calling +Statsd+.
+      #
+      # @param [Symbol] operation method name to send to the actual +Statsd+
+      #
+      # @example Increment a counter
+      #   enable!
+      #   statsd(:increment, 'my_event_count', 1)
+      #
+      # @return nil if disabled, or whatever +Statsd+ returns otherwise.
+      def statsd(operation, *args, **opts, &block)
+        if @enabled
+          raise ArgumentError, 'statsd is not configured, please set it before recording events' unless @statsd
+          self.send(operation, *args, **opts, &block)
+        end
+      end
+
+      def handle_event(event)
+        ec      = event_config(event)
+        options = ec[:options] || {}
+        statsd(ec[:method], *[ec[:name], ec[:value]], **options)
+      end
+
+      private
+
+      def event_config(event)
+        # defaults:
+        config = DEFAULT_CONFIGURATION[event]
+
+        if @event_to_metric_proc
+          proc_config = @event_to_metric_proc.call(event) # expect a config Hash
+          raise TypeError, "#event_to_metric_proc must return a hash, \neg. { method: :gauge, value: 0.1, name: 'frauds_detected_this_hour' }, \nbut I got #{proc_config.class.name}" unless proc_config.is_a?(Hash)
+          config.merge!(proc_config) if proc_config
+        end
+
+        if event.class.respond_to?(:statsd_config)
+          config.merge!(event.class.statsd_config(event))
+        end
+
+        config
+      end
+
+      def event_to_metric(event)
+        event.
+          class.
+          name.
+          gsub(/.*::/, '').
+          underscore.
+          gsub(/_?event/, '').
+          gsub('_', '.')
+      end
+    end
+  end
+end

data/lib/ventable/statsd/version.rb

@@ -0,0 +1,5 @@
+module Ventable
+  module Statsd
+    VERSION = '0.2.0'
+  end
+end

data/ventable-statsd.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ventable/statsd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ventable-statsd'
+  spec.version       = Ventable::Statsd::VERSION
+  spec.authors       = ['Konstantin Gredeskoul']
+  spec.email         = ['kig@reinvent.one']
+
+  spec.summary       = %q{Integrate Ventable with Statsd in order to track some or all events that occur using a light-weight UDP protocol.}
+  spec.description   = %q{Integrate Ventable with Statsd in order to track some or all events that occur using a light-weight UDP protocol.}
+  spec.homepage      = 'https://github.com/kigster/ventable-statsd'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'ventable', '~> 1.0'
+
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: ventable-statsd
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: ventable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Integrate Ventable with Statsd in order to track some or all events that
+  occur using a light-weight UDP protocol.
+email:
+- kig@reinvent.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ventable/statsd.rb
+- lib/ventable/statsd/tracker.rb
+- lib/ventable/statsd/version.rb
+- ventable-statsd.gemspec
+homepage: https://github.com/kigster/ventable-statsd
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Integrate Ventable with Statsd in order to track some or all events that
+  occur using a light-weight UDP protocol.
+test_files: []