active_record_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8b4a993bf23d773e272eb4a8edcc7d503727714
+  data.tar.gz: f603d3de05cdf67455242909c058651610582737
+SHA512:
+  metadata.gz: 57dbb243d4be150fbdacf18d66cf7bd1f1de3b82909739b322db29bba7905b69b212f6283f2bf01df60aba408a4c2160e6676d531a168f54a05233146b9bed7b
+  data.tar.gz: f7a4df44e3fcf1047f1703395bcfb87501d023eac85a748d0e0b0f3f306106e3284768eb2908784187038c6fb2a59acf61981f7c55921d89e8b83d808f796050

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.3.0
+
+before_install:
+  - gem install bundler -v 1.11.2
+  - bin/setup

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kyle Hargraves
+
+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,81 @@
+# ActiveRecordStats
+
+Provides Rails, Resque, and Sidekiq integrations for emitting metrics
+about ActiveRecord usage to StatsD using Shopify's [statsd-instrument][].
+
+## Installation
+
+As usual:
+
+~~~ruby
+gem 'active_record_stats', require: false
+~~~
+
+This library assumes that statsd has already been configured, and is
+available via the `StatsD` constant.
+
+## Usage
+
+For Rails web request instrumentation, add the following to your
+`config/application.rb`:
+
+~~~ruby
+require 'active_record_stats/rack_middleware'
+
+module YourApp
+  class Application < Rails::Application
+    config.middleware.use 'ActiveRecordStats::RackMiddleware'
+  end
+end
+~~~
+
+For Resque job instrumentation, `extend` your job classes like so:
+
+~~~ruby
+require 'active_record_stats/resque_plugin'
+
+class SomeJob
+  extend ActiveRecordStats::ResquePlugin
+end
+~~~
+
+For Sidekiq instrumentation, enable the server middleware:
+
+~~~ruby
+require 'active_record_stats/sidekiq_server_middleware'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add ActiveRecordStats::SidekiqServerMiddleware
+  end
+end
+~~~
+
+## Metric names
+
+Metrics will be with names in the following formats:
+
+1. Gauge db.web._controller_._action_._statement_: the number of `statement` queries
+   performed for a given controller action.
+2. Timer db.web._controller_._action_.runtime: the total `db_runtime` cost of
+   a given controller action, in milliseconds.
+3. Gauge db.job._class_._statement_: the number of `statement` queries performed
+   for a given job.
+
+As Graphite metric names may not contain a `/` character, they are replaced with
+two underscores (`__`). For sanity's sake, the same is done for `::` delimiters.
+
+Example metrics that might be emitted:
+
+* `db.web.v1__widgets.update.UPDATE:2|g`: two `UPDATE` statements were issued
+   when processing `V1::WidgetsController#update`.
+* `db.web.posts.create.runtime:123|g`: Rails reported the total time spent
+   in ActiveRecord for the `PostsController#create` action as 123 ms.
+* `db.job.cache__prime.SELECT:10|g`: ten `SELECT` statements were issued when
+   processing the `Cache::Prime` job.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[statsd-instrument]: https://github.com/Shopify/statsd-instrument

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :db do
+  desc "Use psql's `createdb` to create the test database"
+  task :create do
+    sh "createdb active_record_stats_test"
+  end
+
+  desc "Use psql's `dropdb` to drop the test database"
+  task :drop do
+    sh "dropdb active_record_stats_test"
+  end
+
+  desc "db:{drop,create}"
+  task reset: %w[db:drop db:create]
+end

data/active_record_stats.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_stats"
+  spec.version       = ActiveRecordStats::VERSION
+  spec.authors       = ["Kyle Hargraves"]
+  spec.email         = ["khargraves@enova.com"]
+
+  spec.summary       = %q{Emit ActiveRecord query counts and runtime to StatsD}
+  spec.description   = %q{ActiveRecord instrumentation for Rails, Resque and Sidekiq}
+  spec.homepage      = "https://github.com/enova/active_record_stats"
+  spec.license       = "MIT"
+
+  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_runtime_dependency 'activerecord', '~> 4.0'
+  spec.add_runtime_dependency 'statsd-instrument', '~> 2.0', '>= 2.0.4'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_development_dependency 'pg', '~> 0.18'
+  spec.add_development_dependency 'actionpack', '~> 4.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_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 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+bundle exec rake db:create

data/lib/active_record_stats.rb

@@ -0,0 +1,15 @@
+require 'active_record_stats/version'
+require 'active_record'
+require 'statsd-instrument'
+
+module ActiveRecordStats
+  def self.statement_type(sql)
+    return if sql.nil?
+
+    cleaned = sql.gsub(/^\s*(?:--.*)?$/, '').strip
+    return if cleaned.empty?
+
+    type = cleaned.split(' ', 2).first
+    type.try(:upcase)
+  end
+end

data/lib/active_record_stats/rack_middleware.rb

@@ -0,0 +1,61 @@
+require 'active_record_stats'
+require 'active_support/notifications'
+require 'action_dispatch/http/parameters'
+
+module ActiveRecordStats
+  class RackMiddleware
+    # The location in the Rack `env` where ActionDispatch stores its
+    # `parameters` value. This _may_ change across Rails versions, but
+    # I am not aware of any more reliable means of retrieving it.
+    ENV_KEY = 'action_dispatch.request.parameters'.freeze
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      totals  = {}
+      db_time = 0
+
+      gather_sql = ->(_name, _started_at, _finished_at, _unique_id, payload) {
+        return if payload[:name] == 'SCHEMA' || payload[:sql].blank?
+        return unless type = ActiveRecordStats.statement_type(payload[:sql])
+        totals[type] ||= 0
+        totals[type] += 1
+      }
+
+      gather_runtime = ->(_name, _started_at, _finished_at, _unique_id, payload) {
+        db_time = payload[:db_runtime]
+      }
+
+      subs = [
+        ActiveSupport::Notifications.subscribe('sql.active_record', &gather_sql),
+        ActiveSupport::Notifications.subscribe('process_action.action_controller', &gather_runtime)
+      ]
+
+      @app.call(env)
+
+    ensure
+      request_params = env[ENV_KEY]
+      if controller = request_params['controller']
+        controller = controller.gsub('/', '__')
+        action = request_params['action']
+        emit(controller, action, db_time, totals)
+      end
+
+      subs.each do |sub|
+        ActiveSupport::Notifications.unsubscribe(sub)
+      end
+    end
+
+    private
+
+    def emit(controller, action, db_time, totals)
+      totals.each do |verb, count|
+        StatsD.gauge "db.web.#{controller}.#{action}.#{verb}", count
+      end
+
+      StatsD.measure "db.web.#{controller}.#{action}.runtime", db_time
+    end
+  end
+end

data/lib/active_record_stats/resque_plugin.rb

@@ -0,0 +1,32 @@
+require 'active_record_stats'
+
+module ActiveRecordStats
+  module ResquePlugin
+    def around_perform_active_record_stats(*args, &block)
+      totals = {}
+
+      gather_sql = ->(_name, _started_at, _finished_at, _unique_id, payload) {
+        return if payload[:name] == 'SCHEMA' || payload[:sql].blank?
+        return unless type = ActiveRecordStats.statement_type(payload[:sql])
+        totals[type] ||= 0
+        totals[type] += 1
+      }
+
+      sub = ActiveSupport::Notifications.subscribe('sql.active_record', &gather_sql)
+      yield
+
+    ensure
+      emit_active_record_stats(name, totals)
+      ActiveSupport::Notifications.unsubscribe(sub)
+    end
+
+    private
+
+    def emit_active_record_stats(name, totals)
+      job = name.underscore.gsub('/', '__')
+      totals.each do |verb, count|
+        StatsD.gauge "db.job.#{job}.#{verb}", count
+      end
+    end
+  end
+end

data/lib/active_record_stats/sidekiq_server_middleware.rb

@@ -0,0 +1,32 @@
+require 'active_record_stats'
+
+module ActiveRecordStats
+  class SidekiqServerMiddleware
+    def call(worker, job, queue)
+      totals = {}
+
+      gather_sql = ->(_name, _started_at, _finished_at, _unique_id, payload) {
+        return if payload[:name] == 'SCHEMA' || payload[:sql].blank?
+        return unless type = ActiveRecordStats.statement_type(payload[:sql])
+        totals[type] ||= 0
+        totals[type] += 1
+      }
+
+      sub = ActiveSupport::Notifications.subscribe('sql.active_record', &gather_sql)
+      yield
+
+    ensure
+      emit(worker.class.to_s, totals)
+      ActiveSupport::Notifications.unsubscribe(sub)
+    end
+
+    private
+
+    def emit(worker_name, totals)
+      job = worker_name.underscore.gsub('/', '__')
+      totals.each do |verb, count|
+        StatsD.gauge "db.job.#{job}.#{verb}", count
+      end
+    end
+  end
+end

data/lib/active_record_stats/version.rb

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

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: active_record_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Hargraves
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: ActiveRecord instrumentation for Rails, Resque and Sidekiq
+email:
+- khargraves@enova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_stats.gemspec
+- bin/console
+- bin/setup
+- lib/active_record_stats.rb
+- lib/active_record_stats/rack_middleware.rb
+- lib/active_record_stats/resque_plugin.rb
+- lib/active_record_stats/sidekiq_server_middleware.rb
+- lib/active_record_stats/version.rb
+homepage: https://github.com/enova/active_record_stats
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Emit ActiveRecord query counts and runtime to StatsD
+test_files: []
+has_rdoc: