metrician 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ea4543ca702d54b9c5b3b98da80914d17c4804e
-  data.tar.gz: 923cd68e6fd20feb0b1a786c83b53dec87e629a7
+  metadata.gz: 0061f0ebb86e501bc59c0b0ec001bcc7371b725c
+  data.tar.gz: 17fe4bb8fd8faa906a197dc95f15d518ae2af77c
 SHA512:
-  metadata.gz: 8c3ef47ea845363d1c5d581435de855b4c115397523aa71d4632489a70dbed294e51779d05582a3d2119ad88800037760348f8acfb4ad1d469753c5df325c454
-  data.tar.gz: f29e315bffa5fa8ccd9dd86d0f39782f174eab18278f4c98ed09e5d898ca6597c4dbcd87efcf97c39ca91a08d62114a833bbbcde1052821d62545f10b13788be
+  metadata.gz: d3060f34b98a589e141a0dd337291f9f016ab4186595cec5db7681abb0095e25a09a6490c76efeafefd31a4442db30a0faf74f3ffcd83eecaec4c6c74acb8ea9
+  data.tar.gz: b17b46f886d8351c54a5001835106c46eae4d59b3a6badb5f6f8765f8252f644ed32a0d7c36e15fac154286cae782d528a702b6bd83108eab1b9aec7f3fa90cc

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.1.0 [September 5, 2017]
+* **BREAKING** Rename Method Tracing -> Method Timing to reflect reality better. Metrics go from `tracer.<stuff>` to `timer.<stuff>`.
+
 ### 0.0.11 [August 18, 2017]
 * Remove dependence on ActiveSupport
 

data/README.md

@@ -26,7 +26,7 @@ Request Metrics:
 * content length
 * web server queue time (for servers that set HTTP_X_QUEUE_START like nginx)
 
-And also you can do generic method tracing.
+And also you can report generic method timing.
 
 ## Installation
 

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

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

data/gemfiles/Gemfile.5.0.pg.lock

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

data/gemfiles/Gemfile.dalli_not_memcached.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.11)
+    metrician (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -180,4 +180,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.14.2
+   1.14.6

data/gemfiles/Gemfile.minimal.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.11)
+    metrician (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -45,4 +45,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.14.2
+   1.14.6

data/lib/metrician/reporter.rb

@@ -33,7 +33,7 @@ require "metrician/reporters/active_record"
 require "metrician/reporters/delayed_job"
 require "metrician/reporters/honeybadger"
 require "metrician/reporters/memcache"
-require "metrician/reporters/method_tracer"
+require "metrician/reporters/method_timer"
 require "metrician/reporters/middleware"
 require "metrician/reporters/net_http"
 require "metrician/reporters/redis"

data/lib/metrician/reporters/memcache.rb

@@ -31,22 +31,22 @@ module Metrician
     end
 
     def instrument_class(client_class)
-      return if client_class.method_defined?(:get_with_metrician_trace)
+      return if client_class.method_defined?(:get_with_metrician_time)
       METHODS.each do |method_name|
         next unless client_class.method_defined?(method_name)
         client_class.class_eval <<-RUBY
-          def #{method_name}_with_metrician_trace(*args, &blk)
+          def #{method_name}_with_metrician_time(*args, &blk)
             start_time = Time.now
             begin
-              #{method_name}_without_metrician_trace(*args, &blk)
+              #{method_name}_without_metrician_time(*args, &blk)
             ensure
               duration = (Time.now - start_time).to_f
               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}
-          alias #{method_name} #{method_name}_with_metrician_trace
+          alias #{method_name}_without_metrician_time #{method_name}
+          alias #{method_name} #{method_name}_with_metrician_time
         RUBY
       end
     end

data/lib/metrician/reporters/method_timer.rb

@@ -0,0 +1,70 @@
+module Metrician
+
+  class MethodTimer < Reporter
+
+    def self.enabled?
+      Metrician.configuration[:method_timer][:enabled]
+    end
+
+    def instrument
+      Module.send(:include, TimingMethodInterceptor)
+    end
+
+  end
+
+  module TimingMethodInterceptor
+
+    def self.default_metric_name(klass, is_klass_method, method_name)
+      name = klass.name.underscore
+      name = "#{name}.self" if is_klass_method
+      "timer.#{name}.#{method_name}".downcase.tr_s("^a-zA-Z0-9.", "_")
+    end
+
+    def self.timeable_method?(klass, method_name)
+      klass.method_defined?(method_name) ||
+        klass.private_method_defined?(method_name) ||
+        klass.methods.include?(method_name)
+    end
+
+    def self.already_timed_method?(klass, is_klass_method, timed_name)
+      is_klass_method ?
+        klass.methods.include?(timed_name) :
+        klass.method_defined?(timed_name)
+    end
+
+    def self.code_to_eval(is_klass_method, method_name, timed_name, untimed_name, metric_name)
+      <<-EOD
+        #{'class << self' if is_klass_method}
+        def #{timed_name}(*args, &block)
+          start_time = Time.now
+          begin
+            #{untimed_name}(*args, &block)
+          ensure
+            Metrician.gauge("#{metric_name}", (Time.now - start_time).to_f)
+          end
+        end
+        alias :#{untimed_name} :#{method_name}
+        alias :#{method_name} :#{timed_name}
+        #{'end' if is_klass_method}
+      EOD
+    end
+
+    def add_metrician_method_timer(method_name, metric_name = nil)
+      return false unless TimingMethodInterceptor.timeable_method?(self, method_name)
+
+      is_klass_method = methods.include?(method_name)
+      timed_name = "with_metrician_time_#{method_name}"
+      return false if TimingMethodInterceptor.already_timed_method?(self, is_klass_method, timed_name)
+
+      metric_name ||= TimingMethodInterceptor.default_metric_name(self, is_klass_method, method_name)
+      untimed_name = "without_metrician_time_#{method_name}"
+
+      timed_method_code =
+        TimingMethodInterceptor.code_to_eval(is_klass_method, method_name, timed_name,
+                                              untimed_name, metric_name)
+      class_eval(timed_method_code, __FILE__, __LINE__)
+    end
+
+  end
+
+end

data/lib/metrician/reporters/net_http.rb

@@ -11,18 +11,18 @@ module Metrician
     end
 
     def instrument
-      return if ::Net::HTTP.method_defined?(:request_with_metrician_trace)
+      return if ::Net::HTTP.method_defined?(:request_with_metrician_time)
       ::Net::HTTP.class_eval do
-        def request_with_metrician_trace(req, body = nil, &block)
+        def request_with_metrician_time(req, body = nil, &block)
           start_time = Time.now
           begin
-            request_without_metrician_trace(req, body, &block)
+            request_without_metrician_time(req, body, &block)
           ensure
             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
-        alias_method :request, :request_with_metrician_trace
+        alias_method :request_without_metrician_time, :request
+        alias_method :request, :request_with_metrician_time
       end
     end
 

data/lib/metrician/reporters/redis.rb

@@ -9,12 +9,12 @@ module Metrician
     end
 
     def instrument
-      return if ::Redis::Client.method_defined?(:call_with_metrician_trace)
+      return if ::Redis::Client.method_defined?(:call_with_metrician_time)
       ::Redis::Client.class_eval do
-        def call_with_metrician_trace(*args, &blk)
+        def call_with_metrician_time(*args, &blk)
           start_time = Time.now
           begin
-            call_without_metrician_trace(*args, &blk)
+            call_without_metrician_time(*args, &blk)
           ensure
             duration = (Time.now - start_time).to_f
             Metrician.gauge(CACHE_METRIC, duration) if Metrician.configuration[:cache][:command][:enabled]
@@ -24,8 +24,8 @@ module Metrician
             end
           end
         end
-        alias_method :call_without_metrician_trace, :call
-        alias_method :call, :call_with_metrician_trace
+        alias_method :call_without_metrician_time, :call
+        alias_method :call, :call_with_metrician_time
       end
     end
 

data/lib/metrician/version.rb

@@ -1,5 +1,5 @@
 module Metrician
 
-  VERSION = "0.0.11".freeze
+  VERSION = "0.1.0".freeze
 
 end

data/metrician.defaults.yaml

@@ -131,10 +131,10 @@
   :exception_specific:
     :enabled: false
 
-# "method_tracing" settings control hooking into Module and allowing
+# "method_timer" settings control hooking into Module and allowing
 # ruby methods to be timed
-:method_tracer:
+:method_timer:
 
-  # hook into Module with add_metrician_method_tracer added as a base
+  # hook into Module with add_metrician_method_timer added as a base
   # feature of every ruby object
   :enabled: false

data/metrician.example.yaml

@@ -127,10 +127,10 @@
 #   :exception_specific:
 #     :enabled: false
 
-# # "method_tracing" settings control hooking into Module and allowing
+# # "method_timer" settings control hooking into Module and allowing
 # # ruby methods to be timed
-:method_tracer:
+:method_timer:
 
-#   # hook into Module with add_metrician_method_tracer added as a base
+#   # hook into Module with add_metrician_method_timer added as a base
 #   # feature of every ruby object
 #   :enabled: true

data/spec/metrician_spec.rb

@@ -67,6 +67,33 @@ RSpec.describe Metrician do
     end
   end
 
+  describe "method timing" do
+    before do
+      Metrician.configuration[:method_timer][:enabled] = true
+      @agent = Metrician.null_agent
+      Metrician.activate(@agent)
+    end
+
+    let(:test_instance) do
+      class TestClass
+        def instance_it; end
+        add_metrician_method_timer :instance_it
+
+        def self.class_it; end
+        add_metrician_method_timer :class_it
+      end
+      TestClass.new
+    end
+
+    specify "instance method timings are reported" do
+      @agent.stub(:gauge)
+      @agent.should_receive(:gauge).with("app.timer.test_class.instance_it", anything)
+      test_instance.instance_it
+      @agent.should_receive(:gauge).with("app.timer.test_class.self.class_it", anything)
+      test_instance.class.class_it
+    end
+  end
+
   describe "exception tracking" do
     before do
       Metrician.configuration[:exception][:enabled] = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metrician
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
 platform: ruby
 authors:
 - Expected Behavior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
@@ -150,7 +150,7 @@ files:
 - lib/metrician/reporters/delayed_job.rb
 - lib/metrician/reporters/honeybadger.rb
 - lib/metrician/reporters/memcache.rb
-- lib/metrician/reporters/method_tracer.rb
+- lib/metrician/reporters/method_timer.rb
 - lib/metrician/reporters/middleware.rb
 - lib/metrician/reporters/net_http.rb
 - lib/metrician/reporters/redis.rb

data/lib/metrician/reporters/method_tracer.rb

@@ -1,70 +0,0 @@
-module Metrician
-
-  class MethodTracer < Reporter
-
-    def self.enabled?
-      Metrician.configuration[:method_tracer][:enabled]
-    end
-
-    def instrument
-      Module.send(:include, TracingMethodInterceptor)
-    end
-
-  end
-
-  module TracingMethodInterceptor
-
-    def self.default_metric_name(klass, is_klass_method, method_name)
-      name = klass.name.underscore
-      name = "#{name}.self" if is_klass_method
-      "tracer.#{name}.#{method_name}".downcase.tr_s("^a-zA-Z0-9.", "_")
-    end
-
-    def self.traceable_method?(klass, method_name)
-      klass.method_defined?(method_name) ||
-        klass.private_method_defined?(method_name) ||
-        klass.methods.include?(method_name.to_s)
-    end
-
-    def self.already_traced_method?(klass, is_klass_method, traced_name)
-      is_klass_method ?
-        klass.methods.include?(traced_name) :
-        klass.method_defined?(traced_name)
-    end
-
-    def self.code_to_eval(is_klass_method, method_name, traced_name, untraced_name, metric_name)
-      <<-EOD
-        #{'class << self' if is_klass_method}
-        def #{traced_name}(*args, &block)
-          start_time = Time.now
-          begin
-            #{untraced_name}(*args, &block)
-          ensure
-            Metrician.gauge("#{metric_name}", (Time.now - start_time).to_f)
-          end
-        end
-        alias :#{untraced_name} :#{method_name}
-        alias :#{method_name} :#{traced_name}
-        #{'end' if is_klass_method}
-      EOD
-    end
-
-    def add_metrician_method_tracer(method_name, metric_name = nil)
-      return false unless TracingMethodInterceptor.traceable_method?(self, method_name)
-
-      is_klass_method = methods.include?(method_name.to_s)
-      traced_name = "with_metrician_trace_#{method_name}"
-      return false if TracingMethodInterceptor.already_traced_method?(self, is_klass_method, traced_name)
-
-      metric_name ||= TracingMethodInterceptor.default_metric_name(self, is_klass_method, method_name)
-      untraced_name = "without_metrician_trace_#{method_name}"
-
-      traced_method_code =
-        TracingMethodInterceptor.code_to_eval(is_klass_method, method_name, traced_name,
-                                              untraced_name, metric_name)
-      class_eval(traced_method_code, __FILE__, __LINE__)
-    end
-
-  end
-
-end