nightwing 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 918b61571eb184206d03a99f762982658944339c
-  data.tar.gz: 1e3741e8078e80f055354d80de4fee4a311d72e0
+  metadata.gz: d1a31b84aa7f3d919e2afa26971a8ed1936efa9c
+  data.tar.gz: d4bd99cef7cb8449ed7e05d5f189053c21fdd695
 SHA512:
-  metadata.gz: 06dbfca4a437ba0df72dee941eb0847e5831629b1ca98270712a7bda6d4426c1c65ae3db7359171d2e8d0908687f2494ceb5b016e0ade49c5a4d888b5eda5452
-  data.tar.gz: 1dabeed4b2bfc8f07d514520acb3f50b39a61fae193c0950b8f3b141a475e501324e124a22cd36228397d9a6c77937f3b152350369e9d9bf71998bb7194ed9cf
+  metadata.gz: 2babddd5a3b8c38132211c41fe33c5ceef7d850e4a8a83c32a7267fac271944d1badc830f62e4c676795685b748522b7f724c86c0e710adbf21ed130dfe1d046
+  data.tar.gz: e42a3b39948aaee75c2a9b5450dc421ffda4c5ef74065ea3250a05ef1b85aca3b7c3fdbf73875942ff3abde2ed4806208af74f4290f1a75d6f0db47088dce024

data/.rubocop.yml

@@ -14,6 +14,8 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 Style/IfUnlessModifier:
   Enabled: false
+Style/PerlBackrefs:
+  Enabled: false
 Style/SignalException:
   Enabled: false
 Style/GuardClause:

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.2.0
+
+- Renamed memory_used metric so that we can utilize the memory namespace for additional metrics
+
+**Renamed Metrics**
+
+- `sidekiq.<queue>.<worker>.memory_used` to `sidekiq.<queue>.<worker>.memory.delta`
+
+**New Metrics**
+
+- `instrumentation.sql.<table>.<action>.time`
+
 ## 0.1.0
 
 - Add new Profiler middleware

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nightwing (0.1.0)
+    nightwing (0.2.0)
       activesupport (>= 4.1.0)
       oink (= 0.10.1)
       sidekiq (>= 2.6)

data/README.md

@@ -28,6 +28,14 @@ Sidekiq.configure_server do |config|
 end
 ```
 
+```ruby
+# config/initializers/instrumentation.rb
+ActiveSupport::Notifications.subscribe(
+  'sql.active_record',
+  Nightwing::Instrumentation::ActiveRecord.new(client: Librato),
+)
+```
+
 ### Available options
 
 | Name      | Description                    | Required? | Default           |
@@ -39,7 +47,13 @@ end
 
 When debug mode is turned on, Nightwing will output the metrics into a parsable format. The output destination is determined by the logger. If no logger is given then we send the debugging output to STDOUT.
 
-## Metrics
+## Instrumentation Metrics
+
+Below are the metrics reported to Librato from instrumentation classes
+
+- `instrumentation.sql.<table>.<action>.time`: how long the database query took to complete
+
+## Sidekiq Metrics
 
 Below are the metrics reported to Librato from the Sidekiq middleware
 
@@ -56,7 +70,7 @@ Below are the metrics reported to Librato from the Sidekiq middleware
 - `sidekiq.<queue>.failed`: number of jobs in given queue that raised an error
 - `sidekiq.<queue>.time`: how long jobs took to process (in milliseconds)
 - `sidekiq.<queue>.gc.count`: number of times the Ruby GC kicked off
-- `sidekiq.<queue>.memory_used`: the different in the process memory after jobs were processed (in bytes)
+- `sidekiq.<queue>.memory.delta`: the different in the process memory after jobs were processed (in bytes)
 
 ¹: the difference between now and when the oldest job was enqueued (given in seconds)
 
@@ -68,4 +82,4 @@ Below are the metrics reported to Librato from the Sidekiq middleware
 - `sidekiq.<queue>.<worker>.time`: how long given worker took to process (in milliseconds)
 - `sidekiq.<queue>.<worker>.retried`: number of times a given worker retried
 - `sidekiq.<queue>.<worker>.gc.count`: number of times the Ruby GC kicked off
-- `sidekiq.<queue>.<worker>.memory_used`: the different in the process memory after jobs were processed (in bytes)
+- `sidekiq.<queue>.<worker>.memory.delta`: the different in the process memory after jobs were processed (in bytes)

data/lib/nightwing.rb

@@ -1,4 +1,5 @@
 require "nightwing/version"
+require "nightwing/instrumentation/active_record"
 require "nightwing/sidekiq/stats"
 require "nightwing/sidekiq/queue_stats"
 require "nightwing/sidekiq/worker_stats"

data/lib/nightwing/base.rb

@@ -0,0 +1,27 @@
+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/active_record.rb

@@ -0,0 +1,37 @@
+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
+      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
+
+      def call(_name, started, finished, _unique_id, payload)
+        if payload[:name] == "SQL" || payload[:name] =~ /.* Load$/ || payload[:name].nil?
+          table, action = query_info(payload[:sql])
+        end
+
+        if table
+          query_time = (finished - started) * 1_000
+          client.timing("#{namespace}.sql.#{table.downcase}.#{action.downcase}.time", query_time.round)
+        end
+      end
+
+      private
+
+      def query_info(query)
+        case query
+        when SQL_INSERT_DELETE_PARSER_REGEXP
+          [$3, $1]
+        when SQL_UPDATE_REGEXP
+          [$1, "update"]
+        when SQL_SELECT_REGEXP
+          [$1, "select"]
+        end
+      end
+    end
+  end
+end

data/lib/nightwing/instrumentation/base.rb

@@ -0,0 +1,17 @@
+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

data/lib/nightwing/sidekiq/base.rb

@@ -1,29 +1,11 @@
 require "sidekiq/api"
-require "nightwing/metric"
-require "nightwing/debug_client"
-require "nightwing/logger"
-require "nightwing/client_logger"
+require "nightwing/base"
 
 module Nightwing
   module Sidekiq
-    class Base
-      attr_reader :namespace, :logger
-
+    class Base < Nightwing::Base
       def initialize(options = {})
-        @namespace = options.fetch(:namespace, "sidekiq")
-        @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
+        super options.merge(namespace: "sidekiq")
       end
 
       private

data/lib/nightwing/sidekiq/profiler.rb

@@ -1,4 +1,3 @@
-require "nightwing/sidekiq/profiler"
 require "oink"
 
 module Nightwing
@@ -15,16 +14,17 @@ module Nightwing
 
           yield
         ensure
-          memory_delta_in_bytes = memory_snapshot - initial_snapshot
+          finish_snapshot = memory_snapshot
+          memory_delta_in_bytes = finish_snapshot - initial_snapshot
           total_time = ((Time.now - started_at) * 1_000).round
           total_gc_count = ::GC.count - initial_gc_count
 
           client.timing "#{worker_namespace}.time", total_time
-          client.measure "#{worker_namespace}.memory_used", memory_delta_in_bytes
+          client.measure "#{worker_namespace}.memory.delta", memory_delta_in_bytes
           client.measure "#{worker_namespace}.gc.count", total_gc_count
 
           client.timing "#{queue_namespace}.time", total_time
-          client.measure "#{queue_namespace}.memory_used", memory_delta_in_bytes
+          client.measure "#{queue_namespace}.memory.delta", memory_delta_in_bytes
           client.measure "#{queue_namespace}.gc.count", total_gc_count
         end
       end

data/lib/nightwing/version.rb

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

data/spec/nightwing/instrumentation/active_record_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+require "active_support/all"
+
+describe Nightwing::Instrumentation::ActiveRecord do
+  subject { described_class.new(namespace: "instr") }
+
+  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)
+        payload = { name: "SQL", sql: "select * from users;" }
+        subject.call(nil, 5.seconds.ago, 3.seconds.ago, nil, payload)
+      end
+    end
+
+    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)
+        payload = { name: "SQL", sql: "insert into foo values(1, 2, 3);" }
+        subject.call(nil, 10.seconds.ago, 9.seconds.ago, nil, payload)
+      end
+    end
+  end
+end

data/spec/nightwing/sidekiq/profiler_spec.rb

@@ -24,9 +24,9 @@ describe Nightwing::Sidekiq::Profiler do
     end
 
     it "records memory" do
-      expect(subject.client).to receive(:measure).with("sidekiq.default.my_worker.memory_used", 0).and_call_original
+      expect(subject.client).to receive(:measure).with("sidekiq.default.my_worker.memory.delta", 0).and_call_original
       expect(subject.client).to receive(:measure).with("sidekiq.default.my_worker.gc.count", 0).and_call_original
-      expect(subject.client).to receive(:measure).with("sidekiq.default.memory_used", 0).and_call_original
+      expect(subject.client).to receive(:measure).with("sidekiq.default.memory.delta", 0).and_call_original
       expect(subject.client).to receive(:measure).with("sidekiq.default.gc.count", 0).and_call_original
 
       subject.call(MyWorker.new, nil, "default") do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nightwing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Ledet
@@ -123,8 +123,11 @@ files:
 - README.md
 - circle.yml
 - lib/nightwing.rb
+- lib/nightwing/base.rb
 - lib/nightwing/client_logger.rb
 - lib/nightwing/debug_client.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
@@ -134,6 +137,7 @@ files:
 - lib/nightwing/sidekiq/worker_stats.rb
 - lib/nightwing/version.rb
 - nightwing.gemspec
+- 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