nsa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 911dad2e98c8f5fbd1f15023ed5c547930c2e2ec
+  data.tar.gz: 6c2123585565c8eb5eb41f54a141f3be57431d11
+SHA512:
+  metadata.gz: ad14487a0c6ed7a63c8ea14f734775faaa0729412e7dc150601620e967503c20300bb2829901784f275412634c88fd70aff471c62a47e9cf4585b412dbd61764
+  data.tar.gz: c6ae6b0d35649f93f735ea3d995f7b8a86bcbd40667f72334e803369ef1c6bc8ac809c4c861f4aa2bce798db5b5acba02587d97686628632a93f02bbd740350a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+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 nsa.gemspec
+gemspec

data/README.md

@@ -0,0 +1,155 @@
+# NSA (National Statsd Agency)
+
+Listen to your Rails ActiveSupport::Notifications and deliver to a Statsd backend.
+Support for writing your own custom collectors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "nsa"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nsa
+
+## Usage
+
+NSA comes packaged with collectors for ActionController, ActiveRecord, ActiveSupport Caching,
+and Sidekiq.
+
+To use this gem, simply get a reference to a statsd backend, then indicate which
+collectors you'd like to run. Each `collect` method specifies a Collector to use
+and the additional key namespace.
+
+```ruby
+$statsd = ::Statsd.new(ENV["STATSD_HOST"], ENV["STATSD_PORT"])
+application_name = ::Rails.application.class.parent_name.underscore
+application_env = ENV["PLATFORM_ENV"] || ::Rails.env
+$statsd.namespace = [ application_name, application_env ].join(".")
+
+::NSA.inform_statsd($statsd) do |informant|
+  # Load :action_controller collector with a key prefix of :web
+  informant.collect(:action_controller, :web)
+  informant.collect(:active_record, :db)
+  informant.collect(:cache, :cache)
+  informant.collect(:sidekiq, :sidekiq)
+end
+```
+
+## Built-in Collectors
+
+### `:action_controller`
+
+Listens to: `process_action.action_controller
+
+Metrics recorded:
+
++ Timing: `{ns}.{prefix}.{controller}.{action}.{format}.total_duration`
++ Timing: `{ns}.{prefix}.{controller}.{action}.{format}.db_time`
++ Timing: `{ns}.{prefix}.{controller}.{action}.{format}.view_time`
++ Increment: `{ns}.{prefix}.{controller}.{action}.{format}.status.{status_code}`
+
+### `:active_record`
+
+Listens to: `sql.active_record`
+
+Metrics recorded:
+
++ Timing: `{ns}.{prefix}.tables.{table_name}.queries.delete.duration`
++ Timing: `{ns}.{prefix}.tables.{table_name}.queries.insert.duration`
++ Timing: `{ns}.{prefix}.tables.{table_name}.queries.select.duration`
++ Timing: `{ns}.{prefix}.tables.{table_name}.queries.update.duration`
+
+### `:active_support_cache`
+
+Listens to: `cache_*.active_suppport`
+
+Metrics recorded:
+
++ Timing: `{ns}.{prefix}.delete.duration`
++ Timing: `{ns}.{prefix}.exist?.duration`
++ Timing: `{ns}.{prefix}.fetch_hit.duration`
++ Timing: `{ns}.{prefix}.generate.duration`
++ Timing: `{ns}.{prefix}.read_hit.duration`
++ Timing: `{ns}.{prefix}.read_miss.duration`
++ Timing: `{ns}.{prefix}.read_miss.duration`
+
+### `:sidekiq`
+
+Listens to: Sidekiq middleware, run before each job that is processed
+
+Metrics recorded:
+
++ Time: `{ns}.{prefix}.{WorkerName}.processing_time`
++ Increment: `{ns}.{prefix}.{WorkerName}.success`
++ Increment: `{ns}.{prefix}.{WorkerName}.failure`
++ Gauge: `{ns}.{prefix}.queues.{queue_name}.enqueued`
++ Gauge: `{ns}.{prefix}.queues.{queue_name}.latency`
++ Gauge: `{ns}.{prefix}.dead_size`
++ Gauge: `{ns}.{prefix}.enqueued`
++ Gauge: `{ns}.{prefix}.failed`
++ Gauge: `{ns}.{prefix}.processed`
++ Gauge: `{ns}.{prefix}.processes_size`
++ Gauge: `{ns}.{prefix}.retry_size`
++ Gauge: `{ns}.{prefix}.scheduled_size`
++ Gauge: `{ns}.{prefix}.workers_size`
+
+## Writing your own collector
+
+Writing your own collector is very simple. To take advantage of the keyspace handling you must:
+
+1. Create an object/module which responds to `collect`, taking the `key_prefix` as its only argument.
+2. Include or extend your class/module with `NSA::Statsd::Publisher`.
+
+For example:
+
+```ruby
+module UsersCollector
+  extend ::NSA::Statsd::Publisher
+
+  def self.collect(key_prefix)
+    loop do
+      statsd_gauge("count", ::User.count)
+      sleep 10 # don't do this, obvi
+    end
+  end
+end
+```
+
+Then let the informant know about it:
+
+```ruby
+# $statsd =
+NSA.inform_statsd($statsd) do |informant|
+  # ...
+  informant.collect(UserCollector, :users)
+end
+```
+
+The `NSA::Statsd::Publisher` module exposes the following methods:
+
++ `statsd_count(key, value = 1, sample_rate = nil)`
++ `statsd_decrement(key, sample_rate = nil)`
++ `statsd_gauge(key, value = 1, sample_rate = nil)`
++ `statsd_increment(key, sample_rate = nil)`
++ `statsd_set(key, value = 1, sample_rate = nil)`
++ `statsd_time(key, sample_rate = nil, &block)`
++ `statsd_timing(key, value = 1, sample_rate = nil)`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/localshred/nsa.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nsa"
+
+# 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/nsa.rb

@@ -0,0 +1,11 @@
+require "nsa/version"
+require "nsa/statsd_informant"
+
+module NSA
+
+  def self.inform_statsd(backend)
+    yield ::NSA::StatsdInformant
+    ::NSA::StatsdInformant.listen(backend)
+  end
+
+end

data/lib/nsa/collectors/action_controller.rb

@@ -0,0 +1,29 @@
+require "active_support/notifications"
+require "nsa/statsd/publisher"
+
+module NSA
+  module Collectors
+    module ActionController
+      extend ::NSA::Statsd::Publisher
+
+      def self.collect(key_prefix)
+        ::ActiveSupport::Notifications.subscribe(/process_action.action_controller/) do |*args|
+          event = ::ActiveSupport::Notifications::Event.new(*args)
+          controller = event.payload[:controller]
+          action = event.payload[:action]
+          format = event.payload[:format] || "all"
+          format = "all" if format == "*/*"
+          status = event.payload[:status]
+          key = "#{key_prefix}.#{controller}.#{action}.#{format}"
+
+          statsd_timing("#{key}.total_duration", event.duration)
+          statsd_timing("#{key}.db_time", event.payload[:db_runtime])
+          statsd_timing("#{key}.view_time", event.payload[:view_runtime])
+          statsd_increment("#{key}.status.#{status}")
+        end
+      end
+
+    end
+  end
+end
+

data/lib/nsa/collectors/active_record.rb

@@ -0,0 +1,34 @@
+require "nsa/statsd/publisher"
+
+module NSA
+  module Collectors
+    module ActiveRecord
+      extend ::NSA::Statsd::Publisher
+
+      DELETE_SQL_REGEX = /^DELETE.+FROM\s+"([^"]+)"/
+      INSERT_SQL_REGEX = /^INSERT INTO\s+"([^"]+)"/
+      SELECT_SQL_REGEX = /^SELECT.+FROM\s+"([^"]+)"/
+      UPDATE_SQL_REGEX = /^UPDATE\s+"([^"]+)"/
+
+      def self.collect(key_prefix)
+        ::ActiveSupport::Notifications.subscribe("sql.active_record") do |_, start, finish, _id, payload|
+          query_type, table_name = case payload[:sql]
+                                   when DELETE_SQL_REGEX then [ :delete, $1 ]
+                                   when INSERT_SQL_REGEX then [ :insert, $1 ]
+                                   when SELECT_SQL_REGEX then [ :select, $1 ]
+                                   when UPDATE_SQL_REGEX then [ :update, $1 ]
+                                   else nil
+                                   end
+
+          unless query_type.nil?
+            stat_name = "#{key_prefix}.tables.#{table_name}.queries.#{query_type}.duration"
+            duration_ms = (finish - start) * 1000
+            statsd_timing(stat_name, duration_ms)
+          end
+        end
+
+      end
+    end
+  end
+end
+

data/lib/nsa/collectors/active_support_cache.rb

@@ -0,0 +1,37 @@
+require "active_support/notifications"
+require "nsa/statsd/publisher"
+
+module NSA
+  module Collectors
+    module ActiveSupportCache
+      extend ::NSA::Statsd::Publisher
+
+      CACHE_TYPES = {
+        "cache_delete.active_support" => :delete,
+        "cache_exist?.active_support" => :exist?,
+        "cache_fetch_hit.active_support" => :fetch_hit,
+        "cache_generate.active_support" => :generate,
+        "cache_read.active_support" => :read,
+        "cache_write.active_support" => :write,
+      }.freeze
+
+      def self.collect(key_prefix)
+        ::ActiveSupport::Notifications.subscribe(/cache_[^.]+.active_support/) do |*event_args|
+          event = ::ActiveSupport::Notifications::Event.new(*event_args)
+          cache_type = CACHE_TYPES.fetch(event.name) do
+            event.name.split(".").first.gsub(/^cache_/, "")
+          end
+
+          if cache_type == :read
+            cache_type = event.payload[:hit] ? :read_hit : :read_miss
+          end
+
+          stat_name = "#{key_prefix}.#{cache_type}.duration"
+          statsd_timing(stat_name, event.duration)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/nsa/collectors/null.rb

@@ -0,0 +1,11 @@
+module NSA
+  module Collectors
+    module Null
+
+      def self.collect(*_)
+      end
+
+    end
+  end
+end
+

data/lib/nsa/collectors/sidekiq.rb

@@ -0,0 +1,72 @@
+require "nsa/statsd/publisher"
+
+module NSA
+  module Collectors
+    class Sidekiq
+      include ::NSA::Statsd::Publisher
+
+      def self.collect(key_prefix)
+        require "sidekiq"
+
+        ::Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add(::NSA::Collectors::Sidekiq, key_prefix)
+          end
+        end
+      rescue ::LoadError => exception
+        $stderr.puts("[LoadError] Failed to load sidekiq!", exception.message, *(exception.backtrace))
+      end
+
+      attr_accessor :key_prefix
+      private :key_prefix=
+
+      def initialize(key_prefix)
+        self.key_prefix = key_prefix.to_s.split(".")
+      end
+
+      def call(worker, message, queue_name)
+        worker_name = worker.class.name.tr("::", ".")
+
+        statsd_time(make_key(worker_name, :processing_time)) do
+          yield
+        end
+
+        statsd_increment(make_key(worker_name, :success))
+      rescue => exception
+        statsd_increment(make_key(worker_name, :failure))
+        fail exception
+      ensure
+        publish_overall_stats
+        publish_queue_size_and_latency(queue_name)
+      end
+
+      private
+
+      def publish_overall_stats
+        stats = ::Sidekiq::Stats.new
+        statsd_gauge(make_key(:dead_size), stats.dead_size)
+        statsd_gauge(make_key(:enqueued), stats.enqueued)
+        statsd_gauge(make_key(:failed), stats.failed)
+        statsd_gauge(make_key(:processed), stats.processed)
+        statsd_gauge(make_key(:processes_size), stats.processes_size)
+        statsd_gauge(make_key(:retry_size), stats.retry_size)
+        statsd_gauge(make_key(:scheduled_size), stats.scheduled_size)
+        statsd_gauge(make_key(:workers_size), stats.workers_size)
+      end
+
+      def publish_queue_size_and_latency(queue_name)
+        queue = ::Sidekiq::Queue.new(queue_name)
+        statsd_gauge(make_key(:queues, queue_name, :enqueued), queue.size)
+
+        if queue.respond_to?(:latency)
+          statsd_gauge(make_key(:queues, queue_name, :latency), queue.latency)
+        end
+      end
+
+      def make_key(*args)
+        (key_prefix + args).compact.join(".")
+      end
+
+    end
+  end
+end

data/lib/nsa/statsd/publisher.rb

@@ -0,0 +1,44 @@
+module NSA
+  module Statsd
+    module Publisher
+
+      def statsd_count(key, value = 1, sample_rate = nil)
+        __statsd_publish(:count, key, value, sample_rate)
+      end
+
+      def statsd_decrement(key, sample_rate = nil)
+        __statsd_publish(:decrement, key, 1, sample_rate)
+      end
+
+      def statsd_gauge(key, value = 1, sample_rate = nil)
+        __statsd_publish(:gauge, key, value, sample_rate)
+      end
+
+      def statsd_increment(key, sample_rate = nil)
+        __statsd_publish(:increment, key, 1, sample_rate)
+      end
+
+      def statsd_set(key, value = 1, sample_rate = nil)
+        __statsd_publish(:set, key, value, sample_rate)
+      end
+
+      def statsd_time(key, sample_rate = nil, &block)
+        __statsd_publish(:time, key, nil, sample_rate, &block)
+      end
+
+      def statsd_timing(key, value = 1, sample_rate = nil)
+        __statsd_publish(:timing, key, value, sample_rate)
+      end
+
+      def __statsd_publish(stat_type, key, value = nil, sample_rate = nil, &block)
+        payload = { :key => key }
+        payload.merge!({ :value => value }) if value
+        payload.merge!({ :sample_rate => sample_rate }) if sample_rate
+        payload.merge!({ :block => block }) if block_given?
+
+        ::ActiveSupport::Notifications.instrument("#{stat_type}.statsd", payload)
+      end
+
+    end
+  end
+end

data/lib/nsa/statsd/subscriber.rb

@@ -0,0 +1,30 @@
+module NSA
+  module Statsd
+    module Subscriber
+
+      def statsd_subscribe(backend)
+        ::ActiveSupport::Notifications.subscribe(/.statsd$/) do |name, start, finish, id, payload|
+          __send_event_to_statsd(backend, name, start, finish, id, payload)
+        end
+      end
+
+      def __send_event_to_statsd(backend, name, start, finish, id, payload)
+        action = name.to_s.split(".").first || :count
+
+        key_name = payload[:key]
+        sample_rate = payload.fetch(:sample_rate, 1)
+        block = payload[:block]
+
+        case action.to_sym
+        when :count, :timing, :set, :gauge then
+          value = payload.fetch(:value) { 1 }
+          backend.__send__(action, key_name, value, sample_rate, &block)
+        when :increment, :decrement, :time then
+          backend.__send__(action, key_name, sample_rate, &block)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/nsa/statsd_informant.rb

@@ -0,0 +1,31 @@
+require "nsa/statsd/subscriber"
+
+require "nsa/collectors/action_controller"
+require "nsa/collectors/active_record"
+require "nsa/collectors/active_support_cache"
+require "nsa/collectors/null"
+require "nsa/collectors/sidekiq"
+
+module NSA
+  module StatsdInformant
+    extend ::NSA::Statsd::Subscriber
+
+    COLLECTOR_TYPES = ::Hash.new(::NSA::Collectors::Null).merge({
+      :action_controller => ::NSA::Collectors::ActionController,
+      :active_record => ::NSA::Collectors::ActiveRecord,
+      :active_support_cache => ::NSA::Collectors::ActiveSupportCache,
+      :sidekiq => ::NSA::Collectors::Sidekiq
+    }).freeze
+
+    def self.collect(collector, key_prefix)
+      collector = COLLECTOR_TYPES[collector.to_sym] unless collector.respond_to?(:collect)
+      collector.collect(key_prefix)
+    end
+
+    def self.listen(backend)
+      statsd_subscribe(backend)
+    end
+
+  end
+end
+

data/lib/nsa/version.rb

@@ -0,0 +1,3 @@
+module NSA
+  VERSION = "0.1.0"
+end

data/nsa.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nsa/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nsa"
+  spec.version       = ::NSA::VERSION
+  spec.authors       = ["BJ Neilsen"]
+  spec.email         = ["bj.neilsen@gmail.com"]
+
+  spec.summary       = %q{Listen to your Rails ActiveSupport::Notifications and deliver to a Statsd backend.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://www.github.com/localshred/nsa"
+
+  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 "activesupport", "~> 4.2.0"
+  spec.add_dependency "sidekiq", "~> 3.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: nsa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BJ Neilsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.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: 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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: byebug
+  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: Listen to your Rails ActiveSupport::Notifications and deliver to a Statsd
+  backend.
+email:
+- bj.neilsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nsa.rb
+- lib/nsa/collectors/action_controller.rb
+- lib/nsa/collectors/active_record.rb
+- lib/nsa/collectors/active_support_cache.rb
+- lib/nsa/collectors/null.rb
+- lib/nsa/collectors/sidekiq.rb
+- lib/nsa/statsd/publisher.rb
+- lib/nsa/statsd/subscriber.rb
+- lib/nsa/statsd_informant.rb
+- lib/nsa/version.rb
+- nsa.gemspec
+homepage: https://www.github.com/localshred/nsa
+licenses: []
+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: Listen to your Rails ActiveSupport::Notifications and deliver to a Statsd
+  backend.
+test_files: []