metrician 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52f0bb06f70b89a43c10dfdbbfa5b989c2dfad48
-  data.tar.gz: 61bc03ef7baf8a15640ed25e8608fe8c3481a8ce
+  metadata.gz: 50753f3c05fa7176d026cb28dad17d914eaba6dd
+  data.tar.gz: a2488841dfdf26f306eee4f874e59ab9e065506e
 SHA512:
-  metadata.gz: 865aa70211d3d49137d2b8e53b9b7568fea8b74299bed02bda52aa24b8a4ec4b8850e705a12b8ad63b92088d8aa486678eee465c685d55f09381ecc79f5b0809
-  data.tar.gz: 0af23a989d74ccbb153fd665d1bdac9c9eec041aafd7420050dcc139efde8712dcaead5b981340f0e36e485a9b4fb5b2d745aa1437642c5af0b6405aa6b81a6a
+  metadata.gz: cf88d35020ebcc9294f25c3933097f8627d6dec8c5d3658e035382df7ba96899dc84cc18040a9ce40755bd286923b5cb23522c28689ed17f68d854748cc760c7
+  data.tar.gz: 3b3a1bcf966aef58b7bec42d246ad461e022f42b13f1952c6a78949c68dd208463767c7ba03657fc075ef7bc87670e69aab76fd93b0d101e9281c8783743fd06

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.0.9 [August 16, 2017]
+* Rename some metrics and add common prefix
+
 ### 0.0.8 [August 4, 2017]
 * Integrate with memcached and dalli if both are available
 

data/gemfiles/Gemfile.4.2.sidekiq-4.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.8)
+    metrician (0.0.9)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/Gemfile.5.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.8)
+    metrician (0.0.9)
 
 GEM
   remote: https://rubygems.org/

data/lib/metrician.rb

@@ -17,6 +17,7 @@ module Metrician
     :logger,
     "logger=".to_sym,
   ]
+  DEFAULT_PREFIX = "app.".freeze
 
   def self.activate(agent)
     self.agent = agent
@@ -51,17 +52,15 @@ module Metrician
     klass.to_s.underscore.gsub(%r{/}, ".")
   end
 
-  # TODO: consider removal/movement to Instrumental Agent
   def self.prefix=(prefix)
+    @prefixed = nil
     @prefix = prefix.to_s[-1] == "." ? prefix.to_s : "#{prefix}."
   end
 
-  # TODO: consider removal/movement to Instrumental Agent
   def self.prefix
-    @prefix || ""
+    @prefix ||= DEFAULT_PREFIX
   end
 
-  # TODO: consider removal/movement to Instrumental Agent
   def self.prefixed?
     @prefixed ||= !prefix.empty?
   end

data/lib/metrician/middleware/request_timing.rb

@@ -9,6 +9,8 @@ module Metrician
     # middleware).
     class RequestTiming
 
+      WEB_METRIC = "web".freeze
+
       def initialize(app)
         @app = app
       end
@@ -73,16 +75,16 @@ module Metrician
       end
 
       def gauge(kind, value, route = nil)
-        Metrician.gauge("web.#{kind}", value)
+        Metrician.gauge("#{WEB_METRIC}.#{kind}", value)
         if route && Middleware.route_tracking?
-          Metrician.gauge("web.#{kind}.#{route}", value)
+          Metrician.gauge("#{WEB_METRIC}.#{kind}.#{route}", value)
         end
       end
 
       def increment(kind, route = nil)
-        Metrician.increment("web.#{kind}")
+        Metrician.increment("#{WEB_METRIC}.#{kind}")
         if route && Middleware.route_tracking?
-          Metrician.increment("web.#{kind}.#{route}")
+          Metrician.increment("#{WEB_METRIC}.#{kind}.#{route}")
         end
       end
 

data/lib/metrician/reporters/active_record.rb

@@ -17,9 +17,10 @@ module Metrician
 
   module QueryInterceptor
 
-    COMMAND_EXP = /^(select|update|insert|delete|show|begin|commit|rollback|describe)/i
-    SQL_EXP     = /#{COMMAND_EXP} (?:into |from |.+? from )?(?:[`"]([a-z_]+)[`"])?/i
-    OTHER       = "other".freeze
+    COMMAND_EXP  = /^(select|update|insert|delete|show|begin|commit|rollback|describe)/i
+    SQL_EXP      = /#{COMMAND_EXP} (?:into |from |.+? from )?(?:[`"]([a-z_]+)[`"])?/i
+    OTHER        = "other".freeze
+    QUERY_METRIC = "database.query"
 
     def self.included(instrumented_class)
       return if instrumented_class.method_defined?(:log_without_metrician)
@@ -36,7 +37,7 @@ module Metrician
       sql = sql.dup.force_encoding(Encoding::BINARY)
       config = Metrician.configuration[:database]
       metrics = []
-      metrics << "database.query" if config[:query][:enabled]
+      metrics << QUERY_METRIC if config[:query][:enabled]
       if [:command, :table, :command_and_table].any?{ |key| config[key][:enabled] }
         command, table = parse_sql(sql)
         metrics << "database.#{command}" if config[:command][:enabled] && command

data/lib/metrician/reporters/honeybadger.rb

@@ -1,6 +1,8 @@
 module Metrician
   class Honeybadger < Reporter
 
+    EXCEPTION_METRIC = "tracked_exception"
+
     def self.enabled?
       !!defined?(::Honeybadger) &&
         Metrician.configuration[:exception][:enabled]
@@ -15,9 +17,9 @@ module Metrician
           #   context_manager.get_rack_env
           notify_without_metrician(exception, options)
         ensure
-          Metrician.increment("exception.raise") if Metrician.configuration[:exception][:raise][:enabled]
+          Metrician.increment(EXCEPTION_METRIC) if Metrician.configuration[:exception][:raise][:enabled]
           # TODO: underscore is rails only
-          Metrician.increment("exception.raise.#{Metrician.dotify(exception.class.name.underscore)}") if exception && Metrician.configuration[:exception][:exception_specific][:enabled]
+          Metrician.increment("#{EXCEPTION_METRIC}.#{Metrician.dotify(exception.class.name.underscore)}") if exception && Metrician.configuration[:exception][:exception_specific][:enabled]
         end
         alias_method :notify_without_metrician, :notify
         alias_method :notify, :notify_with_metrician

data/lib/metrician/reporters/memcache.rb

@@ -1,6 +1,7 @@
 module Metrician
   class Memcache < Reporter
 
+    CACHE_METRIC = "cache.command".freeze
     METHODS = %i[get delete cas prepend append replace decrement increment add set].freeze
 
     def self.memcached_gem?
@@ -40,8 +41,8 @@ module Metrician
               #{method_name}_without_metrician_trace(*args, &blk)
             ensure
               duration = (Time.now - start_time).to_f
-              Metrician.gauge("cache.command", duration) if Metrician.configuration[:cache][:command][:enabled]
-              Metrician.gauge("cache.command.#{method_name}", duration) if Metrician.configuration[:cache][:command_specific][:enabled]
+              Metrician.gauge(::Metrician::Memcache::CACHE_METRIC, duration) if Metrician.configuration[:cache][:command][:enabled]
+              Metrician.gauge("#{::Metrician::Memcache::CACHE_METRIC}.#{method_name}", duration) if Metrician.configuration[:cache][:command_specific][:enabled]
             end
           end
           alias #{method_name}_without_metrician_trace #{method_name}

data/lib/metrician/reporters/net_http.rb

@@ -3,6 +3,8 @@ require "net/http"
 module Metrician
   class NetHttp < Reporter
 
+    REQUEST_METRIC = "outgoing_request"
+
     def self.enabled?
       !!defined?(Net::HTTP) &&
         Metrician.configuration[:external_service][:enabled]
@@ -16,7 +18,7 @@ module Metrician
           begin
             request_without_metrician_trace(req, body, &block)
           ensure
-            Metrician.gauge("service.request", (Time.now - start_time).to_f) if Metrician.configuration[:external_service][:request][:enabled]
+            Metrician.gauge(REQUEST_METRIC, (Time.now - start_time).to_f) if Metrician.configuration[:external_service][:request][:enabled]
           end
         end
         alias_method :request_without_metrician_trace, :request

data/lib/metrician/reporters/redis.rb

@@ -1,6 +1,8 @@
 module Metrician
   class Redis < Reporter
 
+    CACHE_METRIC = "cache.command".freeze
+
     def self.enabled?
       !!defined?(::Redis) &&
         Metrician.configuration[:cache][:enabled]
@@ -15,10 +17,10 @@ module Metrician
             call_without_metrician_trace(*args, &blk)
           ensure
             duration = (Time.now - start_time).to_f
-            Metrician.gauge("cache.command", duration) if Metrician.configuration[:cache][:command][:enabled]
+            Metrician.gauge(CACHE_METRIC, duration) if Metrician.configuration[:cache][:command][:enabled]
             if Metrician.configuration[:cache][:command_specific][:enabled]
               method_name = args[0].is_a?(Array) ? args[0][0] : args[0]
-              Metrician.gauge("cache.command.#{method_name}", duration)
+              Metrician.gauge("#{CACHE_METRIC}.#{method_name}", duration)
             end
           end
         end

data/lib/metrician/version.rb

@@ -1,5 +1,5 @@
 module Metrician
 
-  VERSION = "0.0.8".freeze
+  VERSION = "0.0.9".freeze
 
 end

data/spec/metrician_spec.rb

@@ -73,7 +73,7 @@ RSpec.describe Metrician do
     describe "honeybadger" do
       specify "exceptions are instrumented" do
         @agent.stub(:increment)
-        @agent.should_receive(:increment).with("exception.raise", 1)
+        @agent.should_receive(:increment).with("app.tracked_exception", 1)
         Honeybadger.notify('Something went wrong.', {
           error_class: 'MyClass',
           context: {my_data: 'value'}
@@ -83,7 +83,7 @@ RSpec.describe Metrician do
       specify "exceptions are instrumented (job specific, string)" do
         Metrician.configuration[:exception][:exception_specific][:enabled] = true
         @agent.stub(:increment)
-        @agent.should_receive(:increment).with("exception.raise.string", 1)
+        @agent.should_receive(:increment).with("app.tracked_exception.string", 1)
         Honeybadger.notify('Something went wrong.', {
           error_class: 'MyClass',
           context: {my_data: 'value'}
@@ -93,7 +93,7 @@ RSpec.describe Metrician do
       specify "exceptions are instrumented (job specific, exception)" do
         Metrician.configuration[:exception][:exception_specific][:enabled] = true
         @agent.stub(:increment)
-        @agent.should_receive(:increment).with("exception.raise.runtime_error", 1)
+        @agent.should_receive(:increment).with("app.tracked_exception.runtime_error", 1)
         begin
           fail 'badgers!'
         rescue => exception
@@ -113,7 +113,7 @@ RSpec.describe Metrician do
 
     specify "top level queries are instrumented" do
       @agent.stub(:gauge)
-      @agent.should_receive(:gauge).with("database.query", anything)
+      @agent.should_receive(:gauge).with("app.database.query", anything)
 
       User.where(name: "foobar").to_a
     end
@@ -121,7 +121,7 @@ RSpec.describe Metrician do
     specify "per command instrumentation" do
       Metrician.configuration[:database][:command][:enabled] = true
       @agent.stub(:gauge)
-      @agent.should_receive(:gauge).with("database.select", anything)
+      @agent.should_receive(:gauge).with("app.database.select", anything)
 
       User.where(name: "foobar").to_a
     end
@@ -129,7 +129,7 @@ RSpec.describe Metrician do
     specify "per table instrumentation" do
       Metrician.configuration[:database][:table][:enabled] = true
       @agent.stub(:gauge)
-      @agent.should_receive(:gauge).with("database.users", anything)
+      @agent.should_receive(:gauge).with("app.database.users", anything)
 
       User.where(name: "foobar").to_a
     end
@@ -137,7 +137,7 @@ RSpec.describe Metrician do
     specify "per command and table instrumentation" do
       Metrician.configuration[:database][:command_and_table][:enabled] = true
       @agent.stub(:gauge)
-      @agent.should_receive(:gauge).with("database.select.users", anything)
+      @agent.should_receive(:gauge).with("app.database.select.users", anything)
 
       User.where(name: "foobar").to_a
     end
@@ -153,7 +153,7 @@ RSpec.describe Metrician do
       specify "DelayedJob is instrumented" do
         @agent.stub(:gauge)
 
-        @agent.should_receive(:gauge).with("jobs.run", anything)
+        @agent.should_receive(:gauge).with("app.jobs.run", anything)
         Delayed::Job.enqueue(TestDelayedJob.new(success: true))
         Delayed::Worker.new(exit_on_complete: true).start
       end
@@ -161,7 +161,7 @@ RSpec.describe Metrician do
       specify "job errors are instrumented" do
         @agent.stub(:increment)
 
-        @agent.should_receive(:increment).with("jobs.error", 1)
+        @agent.should_receive(:increment).with("app.jobs.error", 1)
         Delayed::Job.enqueue(TestDelayedJob.new(error: true))
         Delayed::Worker.new(exit_on_complete: true).start
       end
@@ -170,7 +170,7 @@ RSpec.describe Metrician do
         Metrician.configuration[:jobs][:job_specific][:enabled] = true
         @agent.stub(:gauge)
 
-        @agent.should_receive(:gauge).with("jobs.run.job.TestDelayedJob", anything)
+        @agent.should_receive(:gauge).with("app.jobs.run.job.TestDelayedJob", anything)
         Delayed::Job.enqueue(TestDelayedJob.new(success: true))
         Delayed::Worker.new(exit_on_complete: true).start
       end
@@ -189,14 +189,14 @@ RSpec.describe Metrician do
 
       specify "Resque is instrumented" do
         @agent.stub(:gauge)
-        @agent.should_receive(:gauge).with("jobs.run", anything)
+        @agent.should_receive(:gauge).with("app.jobs.run", anything)
 
         Resque::Job.create(:default, TestResqueJob, { "success" => true })
       end
 
       specify "job errors are instrumented" do
         @agent.stub(:increment)
-        @agent.should_receive(:increment).with("jobs.error", 1)
+        @agent.should_receive(:increment).with("app.jobs.error", 1)
 
         lambda { Resque::Job.create(:default, TestResqueJob, { "error" => true }) }.should raise_error(StandardError)
       end
@@ -221,7 +221,7 @@ RSpec.describe Metrician do
 
       specify "Sidekiq is instrumented" do
         @agent.stub(:gauge)
-        @agent.should_receive(:gauge).with("jobs.run", anything)
+        @agent.should_receive(:gauge).with("app.jobs.run", anything)
 
         # avoid load order error of sidekiq here by just including the
         # worker bits at latest possible time
@@ -230,7 +230,7 @@ RSpec.describe Metrician do
 
       specify "job errors are instrumented" do
         @agent.stub(:increment)
-        @agent.should_receive(:increment).with("jobs.error", 1)
+        @agent.should_receive(:increment).with("app.jobs.error", 1)
 
         # avoid load order error of sidekiq here by just including the
         # worker bits at latest possible time
@@ -241,7 +241,7 @@ RSpec.describe Metrician do
         Metrician.configuration[:jobs][:job_specific][:enabled] = true
         @agent.stub(:gauge)
 
-        @agent.should_receive(:gauge).with("jobs.run.job.TestSidekiqWorker", anything)
+        @agent.should_receive(:gauge).with("app.jobs.run.job.TestSidekiqWorker", anything)
         # avoid load order error of sidekiq here by just including the
         # worker bits at latest possible time
         TestSidekiqWorker.perform_async({ "success" => true})
@@ -250,7 +250,7 @@ RSpec.describe Metrician do
       specify "job errors are instrumented per job" do
         Metrician.configuration[:jobs][:job_specific][:enabled] = true
         @agent.stub(:increment)
-        @agent.should_receive(:increment).with("jobs.error.job.TestSidekiqWorker", 1)
+        @agent.should_receive(:increment).with("app.jobs.error.job.TestSidekiqWorker", 1)
 
         # avoid load order error of sidekiq here by just including the
         # worker bits at latest possible time
@@ -265,7 +265,7 @@ RSpec.describe Metrician do
       Metrician.activate(agent)
       client = Redis.new
       agent.stub(:gauge)
-      agent.should_receive(:gauge).with("cache.command", anything)
+      agent.should_receive(:gauge).with("app.cache.command", anything)
       client.get("foo-#{rand(100_000)}")
     end
 
@@ -280,7 +280,7 @@ RSpec.describe Metrician do
         Metrician.activate(agent)
         agent.stub(:gauge)
 
-        agent.should_receive(:gauge).with("cache.command", anything)
+        agent.should_receive(:gauge).with("app.cache.command", anything)
         begin
           client.get("foo-#{rand(100_000)}")
         rescue Memcached::NotFound
@@ -296,7 +296,7 @@ RSpec.describe Metrician do
       Metrician.activate(agent)
       agent.stub(:gauge)
 
-      agent.should_receive(:gauge).with("service.request", anything)
+      agent.should_receive(:gauge).with("app.outgoing_request", anything)
       Net::HTTP.get(URI.parse("http://example.com/"))
     end
   end
@@ -320,7 +320,7 @@ RSpec.describe Metrician do
       specify "Rack timing is instrumented" do
         agent.stub(:gauge)
 
-        agent.should_receive(:gauge).with("web.request", anything)
+        agent.should_receive(:gauge).with("app.web.request", anything)
         get "/"
       end
     end
@@ -340,8 +340,8 @@ RSpec.describe Metrician do
         agent.stub(:gauge)
         agent.stub(:increment)
 
-        agent.should_receive(:gauge).with("web.request", anything)
-        agent.should_receive(:increment).with("web.error", 1)
+        agent.should_receive(:gauge).with("app.web.request", anything)
+        agent.should_receive(:increment).with("app.web.error", 1)
         get "/"
       end
 
@@ -351,8 +351,8 @@ RSpec.describe Metrician do
         agent.stub(:gauge)
         agent.stub(:increment)
 
-        agent.should_not_receive(:gauge).with("web.request", anything)
-        agent.should_receive(:increment).with("web.error", 1)
+        agent.should_not_receive(:gauge).with("app.web.request", anything)
+        agent.should_receive(:increment).with("app.web.error", 1)
         get "/"
       end
     end
@@ -373,8 +373,8 @@ RSpec.describe Metrician do
         agent.stub(:gauge)
         agent.stub(:increment)
 
-        agent.should_receive(:gauge).with("web.request", anything)
-        agent.should_receive(:increment).with("web.error", 1)
+        agent.should_receive(:gauge).with("app.web.request", anything)
+        agent.should_receive(:increment).with("app.web.error", 1)
         lambda { get "/" }.should raise_error(RuntimeError, "boom")
       end
     end
@@ -394,7 +394,7 @@ RSpec.describe Metrician do
         Metrician.configuration[:request_timing][:queue_time][:enabled] = true
         agent.stub(:gauge)
 
-        agent.should_receive(:gauge).with("web.queue_time", anything)
+        agent.should_receive(:gauge).with("app.web.queue_time", anything)
         get "/", {}, { Metrician::Middleware::ENV_QUEUE_START_KEYS.first => 1.second.ago.to_f }
       end
     end
@@ -419,9 +419,9 @@ RSpec.describe Metrician do
         specify "satisfied is recorded" do
           agent.stub(:gauge)
 
-          agent.should_receive(:gauge).with("web.apdex.satisfied", anything)
-          agent.should_not_receive(:gauge).with("web.apdex.tolerated", anything)
-          agent.should_not_receive(:gauge).with("web.apdex.frustrated", anything)
+          agent.should_receive(:gauge).with("app.web.apdex.satisfied", anything)
+          agent.should_not_receive(:gauge).with("app.web.apdex.tolerated", anything)
+          agent.should_not_receive(:gauge).with("app.web.apdex.frustrated", anything)
           get "/"
         end
 
@@ -444,9 +444,9 @@ RSpec.describe Metrician do
         specify "tolerated is recorded" do
           agent.stub(:gauge)
 
-          agent.should_not_receive(:gauge).with("web.apdex.satisfied", anything)
-          agent.should_receive(:gauge).with("web.apdex.tolerated", anything)
-          agent.should_not_receive(:gauge).with("web.apdex.frustrated", anything)
+          agent.should_not_receive(:gauge).with("app.web.apdex.satisfied", anything)
+          agent.should_receive(:gauge).with("app.web.apdex.tolerated", anything)
+          agent.should_not_receive(:gauge).with("app.web.apdex.frustrated", anything)
           get "/"
         end
       end
@@ -468,9 +468,9 @@ RSpec.describe Metrician do
         specify "frustrated is recorded" do
           agent.stub(:gauge)
 
-          agent.should_not_receive(:gauge).with("web.apdex.satisfied", anything)
-          agent.should_not_receive(:gauge).with("web.apdex.tolerated", anything)
-          agent.should_receive(:gauge).with("web.apdex.frustrated", anything)
+          agent.should_not_receive(:gauge).with("app.web.apdex.satisfied", anything)
+          agent.should_not_receive(:gauge).with("app.web.apdex.tolerated", anything)
+          agent.should_receive(:gauge).with("app.web.apdex.frustrated", anything)
           get "/"
         end
       end
@@ -490,7 +490,7 @@ RSpec.describe Metrician do
 
       it "hooks into rails automatically" do
         agent.stub(:gauge)
-        agent.should_receive(:gauge).with("web.request", anything)
+        agent.should_receive(:gauge).with("app.web.request", anything)
 
         get "/"
         last_response.body.should == "foobar response"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metrician
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Expected Behavior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
@@ -125,7 +125,6 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- METRICS.MD
 - README.md
 - Rakefile
 - gemfiles/Gemfile.4.2.sidekiq-4

data/METRICS.MD

@@ -1,48 +0,0 @@
-# Metrics you can expect to report in a vanilla Rails app
-
-### `GET /users`
-
-* `active_record.users.find`
-* `database.sql`
-* `database.sql.select`
-* `web.request`
-* `web.request.users_controller.index.get`
-* `web.request.middleware`
-* `web.request.idle`
-* `web.response_size`
-* `web.response_size.users_controller.index.get`
-
-*You may also see another instance of `database.sql` and an instance of `database.sql.other` if the table schema is loaded.*
-
-*In development mode, you can expect to record one each of the following **per asset** on the page because they are served by Rack*
-
-* `web.request`
-* `web.request.assets`
-* `web.request.middleware`
-* `web.request.idle`
-* `web.response_size`
-* `web.response_size.assets`
-
-
-### `PATCH /redis`
-
-Assuming we have a form for setting a redis value, and a controller that looks like this:
-
-```ruby
-class RedisController < ApplicationController
-  def show
-    @value = $redis.get("foo")
-  end
-
-  def update
-    $redis.set("foo", params[:value])
-    redirect_to(redis_path)
-  end
-end
-```
-
-In addition to request metrics similar to those described above, we can expect the following redis-specific metrics to be recorded:
-
-* `redis.set` - during the update
-* `redis.get` - during the redirect/show
-