nightwing 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1a31b84aa7f3d919e2afa26971a8ed1936efa9c
-  data.tar.gz: d4bd99cef7cb8449ed7e05d5f189053c21fdd695
+  metadata.gz: 1830dcc5ef65dd81a3991d08edb121cdd5e7dc35
+  data.tar.gz: 8fd3c1a4a52736adb30b92bec706960e068e8453
 SHA512:
-  metadata.gz: 2babddd5a3b8c38132211c41fe33c5ceef7d850e4a8a83c32a7267fac271944d1badc830f62e4c676795685b748522b7f724c86c0e710adbf21ed130dfe1d046
-  data.tar.gz: e42a3b39948aaee75c2a9b5450dc421ffda4c5ef74065ea3250a05ef1b85aca3b7c3fdbf73875942ff3abde2ed4806208af74f4290f1a75d6f0db47088dce024
+  metadata.gz: cafce097fd7a8470aa4b5316767d0dce065859c0f7de51a80b003696ce68db9773e11c9b30152092fd160dbcc8e81b4a8f90efc31071b88d40f6a1e28b1e2dc7
+  data.tar.gz: 0fe35c47611d301c4dfbffe431041ec9a6eea96c60af51d076ce6c3093f0ed1ff8f454f548e0b433795cfa8e61c41355c13257f37cd5969f174f346323948b4d

data/.rubocop.yml

@@ -10,10 +10,14 @@ Metrics/LineLength:
   Max: 120
 StringLiterals:
   EnforcedStyle: double_quotes
+Style/Alias:
+  Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
 Style/IfUnlessModifier:
   Enabled: false
+Style/ModuleFunction:
+  Enabled: false
 Style/PerlBackrefs:
   Enabled: false
 Style/SignalException:

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## Unreleased
+
+## 0.3.0
+
+- New profiling extension for Redis
+- New profiling extension for Memcache (via Dalli)
+- Added new `Nightwing.client` to global statds client configuration
+- Internal setup refactor
+- Metric changes are listed below
+
+**Renamed Metrics**
+
+- `instrumentation.sql.<table>.<action>.time` to `sql.<table>.<action>.time`
+
+**New Metrics**
+
+- `memcache.command.time`
+- `memcache.command.<command>.time`
+- `memcache.command.processed`
+- `memcache.command.<command>.processed`
+- `redis.command.time`
+- `redis.command.<command>.time`
+- `redis.command.processed`
+- `redis.command.<command>.processed`
+
 ## 0.2.0
 
 - Renamed memory_used metric so that we can utilize the memory namespace for additional metrics

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nightwing (0.2.0)
+    nightwing (0.3.0)
       activesupport (>= 4.1.0)
       oink (= 0.10.1)
       sidekiq (>= 2.6)
@@ -9,14 +9,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.5)
-      activesupport (= 4.2.5)
+    activemodel (4.2.5.1)
+      activesupport (= 4.2.5.1)
       builder (~> 3.1)
-    activerecord (4.2.5)
-      activemodel (= 4.2.5)
-      activesupport (= 4.2.5)
+    activerecord (4.2.5.1)
+      activemodel (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
       arel (~> 6.0)
-    activesupport (4.2.5)
+    activesupport (4.2.5.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)

data/README.md

@@ -28,14 +28,26 @@ Sidekiq.configure_server do |config|
 end
 ```
 
+To gather database metrics:
+
 ```ruby
 # config/initializers/instrumentation.rb
-ActiveSupport::Notifications.subscribe(
-  'sql.active_record',
-  Nightwing::Instrumentation::ActiveRecord.new(client: Librato),
-)
+Nightwing.client = Librato
+
+ActiveSupport::Notifications.subscribe('sql.active_record', Nightwing::Instrumentation::ActiveRecord.new)
 ```
 
+To gather Redis and memcache metrics:
+
+```ruby
+# config/initializers/instrumentation.rb
+Nightwing.client = Librato
+
+require 'nightwing/extensions/dalli' # dalli gem required
+require 'nightwing/extensions/redis' # redis gem required
+```
+
+
 ### Available options
 
 | Name      | Description                    | Required? | Default           |
@@ -51,7 +63,20 @@ When debug mode is turned on, Nightwing will output the metrics into a parsable
 
 Below are the metrics reported to Librato from instrumentation classes
 
-- `instrumentation.sql.<table>.<action>.time`: how long the database query took to complete
+- `sql.<table>.<action>.time`: how long the database query took to complete
+
+## Extensions Metrics
+
+Below are the metrics reported to Librato from instrumentation classes
+
+- `redis.command.processed`: number of times overall command was called
+- `redis.command.time`: response time (in ms) for all commands
+- `redis.command.<command>.processed`: number of times the command was called
+- `redis.command.<command>.time`: response time (in ms) for command
+- `memcache.command.processed`: number of times overall command was called
+- `memcache.command.time`: response time (in ms) for all commands
+- `memcache.command.<command>.processed`: number of times the command was called
+- `memcache.command.<command>.time`: response time (in ms) for command
 
 ## Sidekiq Metrics
 

data/circle.yml

@@ -1,5 +1,14 @@
+dependencies:
+  override:
+    - 'rvm-exec 2.1.7 bundle install'
+    - 'rvm-exec 2.2.3 bundle install'
+    - 'rvm-exec 2.3.0 bundle install'
+
 test:
-  pre:
-    - bundle exec rubocop
   override:
-    - bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+    - 'rvm-exec 2.1.7 bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml'
+    - 'rvm-exec 2.1.7 bundle exec rubocop'
+    - 'rvm-exec 2.2.3 bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml'
+    - 'rvm-exec 2.2.3 bundle exec rubocop'
+    - 'rvm-exec 2.3.0 bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml'
+    - 'rvm-exec 2.3.0 bundle exec rubocop'

data/lib/nightwing.rb

@@ -1,6 +1,26 @@
 require "nightwing/version"
+require "nightwing/debug_client"
 require "nightwing/instrumentation/active_record"
+require "nightwing/sidekiq/base"
 require "nightwing/sidekiq/stats"
 require "nightwing/sidekiq/queue_stats"
 require "nightwing/sidekiq/worker_stats"
 require "nightwing/sidekiq/profiler"
+
+module Nightwing
+  extend self
+
+  def client
+    @client || internal_client
+  end
+
+  def client=(c)
+    @client = c
+  end
+
+  private
+
+  def internal_client
+    @internal_client ||= Nightwing::DebugClient.new
+  end
+end

data/lib/nightwing/extensions/dalli.rb

@@ -0,0 +1,21 @@
+Dalli::Client.class_eval do
+  def perform_with_profiling(*args)
+    begin
+      start_time = Time.now
+      result = perform_without_profiling(*args)
+    ensure
+      time_ellasped = (Time.now - start_time) * 1_000
+      command = args.first.is_a?(Array) ? args[0][0] : args.first
+
+      Nightwing.client.timing "memcache.command.time", time_ellasped
+      Nightwing.client.timing "memcache.command.#{command}.time", time_ellasped
+
+      Nightwing.client.increment "memcache.command.processed"
+      Nightwing.client.increment "memcache.command.#{command}.processed"
+    end
+
+    result
+  end
+  alias perform_without_profiling perform
+  alias perform perform_with_profiling
+end if defined?(Dalli::Client)

data/lib/nightwing/extensions/redis.rb

@@ -0,0 +1,21 @@
+Redis::Client.class_eval do
+  def call_with_profiling(*args, &blk)
+    begin
+      start_time = Time.now
+      result = call_without_profiling(*args, &blk)
+    ensure
+      time_ellasped = (Time.now - start_time) * 1_000
+      command = args.first.is_a?(Array) ? args[0][0] : args.first
+
+      Nightwing.client.timing "redis.command.time", time_ellasped
+      Nightwing.client.timing "redis.command.#{command}.time", time_ellasped
+
+      Nightwing.client.increment "redis.command.processed"
+      Nightwing.client.increment "redis.command.#{command}.processed"
+    end
+
+    result
+  end
+  alias call_without_profiling call
+  alias call call_with_profiling
+end if defined?(Redis::Client)

data/lib/nightwing/instrumentation/active_record.rb

@@ -1,10 +1,8 @@
-require "nightwing/instrumentation/base"
-
 module Nightwing
   module Instrumentation
     # This code was influenced by Matt Aimonetti's awesome blog post: "Practical Guide to StatsD/Graphite Monitoring"
     # Check it out: https://matt.aimonetti.net/posts/2013/06/26/practical-guide-to-graphite-monitoring
-    class ActiveRecord < Base
+    class ActiveRecord
       SQL_INSERT_DELETE_PARSER_REGEXP = /^(\w+)\s(\w+)\s\W*(\w+)/
       SQL_SELECT_REGEXP = /select .*? FROM \W*(\w+)/i
       SQL_UPDATE_REGEXP = /update \W*(\w+)/i
@@ -15,8 +13,15 @@ module Nightwing
         end
 
         if table
+          action.downcase!
+          table.downcase!
           query_time = (finished - started) * 1_000
-          client.timing("#{namespace}.sql.#{table.downcase}.#{action.downcase}.time", query_time.round)
+
+          Nightwing.client.timing "sql.#{action}.time", query_time.round
+          Nightwing.client.timing "sql.#{action}.#{table}.time", query_time.round
+
+          Nightwing.client.increment "sql.#{action}.processed"
+          Nightwing.client.increment "sql.#{action}.#{table}.processed"
         end
       end
 

data/lib/nightwing/sidekiq/base.rb

@@ -1,11 +1,28 @@
 require "sidekiq/api"
-require "nightwing/base"
+require "nightwing/metric"
+require "nightwing/logger"
+require "nightwing/client_logger"
 
 module Nightwing
   module Sidekiq
-    class Base < Nightwing::Base
+    class Base
+      attr_reader :namespace, :logger
+
       def initialize(options = {})
-        super options.merge(namespace: "sidekiq")
+        @namespace = options.fetch(:namespace, "sidekiq")
+        @client = options.fetch(:client, Nightwing.client)
+        @logger = options.fetch(:logger, Nightwing::Logger.new)
+        @debug = options.fetch(:debug, false)
+      end
+
+      def client
+        @client_proxy ||= begin
+          if @debug
+            Nightwing::ClientLogger.new(client: @client, logger: @logger)
+          else
+            @client
+          end
+        end
       end
 
       private

data/lib/nightwing/version.rb

@@ -1,3 +1,3 @@
 module Nightwing
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/spec/nightwing/extensions/dalli_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+class Dalli
+  class Client
+    def perform(*_)
+      @performed = true
+    end
+
+    def called?
+      @performed
+    end
+  end
+end
+
+describe "Dalli extensions" do
+  subject { Dalli::Client.new }
+
+  before do
+    require "nightwing/extensions/dalli"
+  end
+
+  describe "#peform" do
+    it "measures time" do
+      expect(Nightwing.client).to receive(:timing) do |*args|
+        expect(args.first).to eq("memcache.command.time")
+        expect(args.last > 0).to be(true)
+      end
+
+      expect(Nightwing.client).to receive(:timing) do |*args|
+        expect(args.first).to eq("memcache.command.foo.time")
+        expect(args.last > 0).to be(true)
+      end
+
+      expect(Nightwing.client).to receive(:increment).with("memcache.command.processed")
+      expect(Nightwing.client).to receive(:increment).with("memcache.command.foo.processed")
+
+      subject.perform :foo
+    end
+
+    it "actually calls perform" do
+      subject.perform :foo
+      expect(subject).to be_called
+    end
+  end
+end

data/spec/nightwing/extensions/redis_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+class Redis
+  class Client
+    def call(*_)
+      @performed = true
+    end
+
+    def called?
+      @performed
+    end
+  end
+end
+
+describe "Redis extensions" do
+  subject { Redis::Client.new }
+
+  before do
+    require "nightwing/extensions/redis"
+  end
+
+  describe "#peform" do
+    it "measures time" do
+      expect(Nightwing.client).to receive(:timing) do |*args|
+        expect(args.first).to eq("redis.command.time")
+        expect(args.last > 0).to be(true)
+      end
+
+      expect(Nightwing.client).to receive(:timing) do |*args|
+        expect(args.first).to eq("redis.command.foo.time")
+        expect(args.last > 0).to be(true)
+      end
+
+      expect(Nightwing.client).to receive(:increment).with("redis.command.processed")
+      expect(Nightwing.client).to receive(:increment).with("redis.command.foo.processed")
+
+      subject.call :foo
+    end
+
+    it "actually calls perform" do
+      subject.call :foo
+      expect(subject).to be_called
+    end
+  end
+end

data/spec/nightwing/instrumentation/active_record_spec.rb

@@ -2,12 +2,16 @@ require "spec_helper"
 require "active_support/all"
 
 describe Nightwing::Instrumentation::ActiveRecord do
-  subject { described_class.new(namespace: "instr") }
+  subject { described_class.new }
 
   describe "#call" do
     context "when given select SQL query" do
       it "measures time" do
-        expect(subject.client).to receive(:timing).with("instr.sql.users.select.time", 2_000)
+        expect(Nightwing.client).to receive(:timing).with("sql.select.time", 2_000)
+        expect(Nightwing.client).to receive(:timing).with("sql.select.users.time", 2_000)
+        expect(Nightwing.client).to receive(:increment).with("sql.select.processed")
+        expect(Nightwing.client).to receive(:increment).with("sql.select.users.processed")
+
         payload = { name: "SQL", sql: "select * from users;" }
         subject.call(nil, 5.seconds.ago, 3.seconds.ago, nil, payload)
       end
@@ -15,7 +19,11 @@ describe Nightwing::Instrumentation::ActiveRecord do
 
     context "when given insert SQL query" do
       it "measures time" do
-        expect(subject.client).to receive(:timing).with("instr.sql.foo.insert.time", 1_000)
+        expect(Nightwing.client).to receive(:timing).with("sql.insert.time", 1_000)
+        expect(Nightwing.client).to receive(:timing).with("sql.insert.foo.time", 1_000)
+        expect(Nightwing.client).to receive(:increment).with("sql.insert.processed")
+        expect(Nightwing.client).to receive(:increment).with("sql.insert.foo.processed")
+
         payload = { name: "SQL", sql: "insert into foo values(1, 2, 3);" }
         subject.call(nil, 10.seconds.ago, 9.seconds.ago, nil, payload)
       end

data/spec/nightwing_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Nightwing do
+  describe "#client" do
+    context "when client is not set" do
+      class MyClient; end
+
+      before do
+        Nightwing.client = MyClient.new
+      end
+
+      it "returns client" do
+        expect(Nightwing.client.class).to eq(MyClient)
+      end
+    end
+
+    context "when client is not set" do
+      before do
+        Nightwing.client = nil
+      end
+
+      it "returns default client" do
+        expect(Nightwing.client.class).to eq(Nightwing::DebugClient)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nightwing
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Ledet
@@ -119,15 +119,15 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - circle.yml
 - lib/nightwing.rb
-- lib/nightwing/base.rb
 - lib/nightwing/client_logger.rb
 - lib/nightwing/debug_client.rb
+- lib/nightwing/extensions/dalli.rb
+- lib/nightwing/extensions/redis.rb
 - lib/nightwing/instrumentation/active_record.rb
-- lib/nightwing/instrumentation/base.rb
 - lib/nightwing/logger.rb
 - lib/nightwing/metric.rb
 - lib/nightwing/sidekiq/base.rb
@@ -137,12 +137,15 @@ files:
 - lib/nightwing/sidekiq/worker_stats.rb
 - lib/nightwing/version.rb
 - nightwing.gemspec
+- spec/nightwing/extensions/dalli_spec.rb
+- spec/nightwing/extensions/redis_spec.rb
 - spec/nightwing/instrumentation/active_record_spec.rb
 - spec/nightwing/metric_spec.rb
 - spec/nightwing/sidekiq/profiler_spec.rb
 - spec/nightwing/sidekiq/queue_stats_spec.rb
 - spec/nightwing/sidekiq/stats_spec.rb
 - spec/nightwing/sidekiq/worker_stats_spec.rb
+- spec/nightwing_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/teespring/nightwing
 licenses:

data/lib/nightwing/base.rb

@@ -1,27 +0,0 @@
-require "nightwing/metric"
-require "nightwing/debug_client"
-require "nightwing/logger"
-require "nightwing/client_logger"
-
-module Nightwing
-  class Base
-    attr_reader :namespace, :logger
-
-    def initialize(options = {})
-      @namespace = options.fetch(:namespace)
-      @client = options.fetch(:client, Nightwing::DebugClient.new)
-      @logger = options.fetch(:logger, Nightwing::Logger.new)
-      @debug = options.fetch(:debug, false)
-    end
-
-    def client
-      @client_proxy ||= begin
-        if @debug
-          Nightwing::ClientLogger.new(client: @client, logger: @logger)
-        else
-          @client
-        end
-      end
-    end
-  end
-end

data/lib/nightwing/instrumentation/base.rb

@@ -1,17 +0,0 @@
-require "nightwing/base"
-
-module Nightwing
-  module Instrumentation
-    class Base < Nightwing::Base
-      def initialize(options = {})
-        super default_options.merge(options)
-      end
-
-      private
-
-      def default_options
-        { namespace: "instrumentation" }
-      end
-    end
-  end
-end