hallmonitor 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54c0631a67fb95ae8201691fdd5e5e12c09936f1
-  data.tar.gz: d0dddea0967b40bfeea62612157649eeef033711
+  metadata.gz: 91292eab2c111a361683e82dde2bff423c1db242
+  data.tar.gz: 7c8b9deb17ff9fa07c86b27b55ce2ba86ea45d2a
 SHA512:
-  metadata.gz: 0e314315927b4dbaa450022ac88e054ff6e1e230a5f81db0930cab21e54c7e28d20d3521d17cce6671897f1837f8ad7a400409038f7e0a2e8e34e4da4e721045
-  data.tar.gz: 193b9d428e2cca3a95618f5a8b77853fefd8194673f2bf83ef8937326c05c0c47ad667c5328372a99845c4ae862b4f6acf948a77ec1e64b8de9e3721ceff5349
+  metadata.gz: de4981e3e0bdb1b4ae7ee75ea2d477fd5a0bce7582db2a088c6063513928e884f312e854ff33bd11de397bd933f6bfc18975bfed4b8eea6e18fde0483ca08cf9
+  data.tar.gz: 80449291d9b3c367be0271ad42499b811a26ad95a065725e0a3c3d041faa00bea077e75127d04413a78beb3ce951d89106382723b19965067f4eea9993ce6722

data/README.md

@@ -30,22 +30,49 @@ Hallmonitor.add_outputter Hallmonitor::Outputters::Datadog.new(datadog)
 ```
 
 ## Configuration
-Right now there's only one configuration option and here's how you can set it:
+There are a few configuration options, two of which are only
+applicable when used within rails.  You can configure their values like so:
 
 ```ruby
 # Configure Hallmonitor
 Hallmonitor.config |config|
   config.trap_outputter_exceptions = true # Default value is false
+  config.instrument_rails_controller_actions = true # Default value is false
+  config.controller_action_measure_name = 'controller.action.measure' # this is the default
+  config.controller_action_count_name = 'controller.action.count' # this is the default
 end
 ```
 
-**trap_outputter_exceptions:** instructs the output framework to ignore and squash any exceptions that might be raised from inside an outputter.  This can be useful if you want to configure multiple outputter and not have a misbehaving one interrupt other outputter, or your system.
+* **trap_outputter_exceptions:** instructs the output framework to ignore and squash any exceptions that might be raised from inside an outputter.  This can be useful if you want to configure multiple outputter and not have a misbehaving one interrupt other outputter, or your system.
+* **instrument_rails_controller_actions:** Whether or not to auto instrument rails controller actions, defaults to false
+* **controller_action_measure_name:** the metric name to use for the auto-instrumented metric for rails actions that include time measurements
+* **controller_action_count_name:** the metric name to use for the auto-instrumented metric for rails actions that tracks action invocation counts
 
 ## Usage
 
 There are a few different ways to use Hallmonitor:
 
+## Rails Autoinstrumentation
+
+If `config.instrument_rails_controller_actions` is true, and Rails is
+defined Hallmonitor will define a Railtie that auto-instruments all
+rails controller actions to collect execution duration and count
+information.  You can see details of the metrics gathered in the
+`hallmonitor/railtie.rb` file.
+
+You can configure the metric names that are used via the
+`config.controller_action_measure_name` and
+`config.controller_action_count_name` configuration directives.
+
+
 ### Included in your class
+
+The easiest way is to include `Hallmonitor::Monitored` in your class
+and use its `emit(...)` and `watch(...)` methods.  `emit` emits a
+single count metric with a name and optional tags, while `watch`
+executes the provided block and emits a `Hallmonitor::TimedEvent` with
+the duration that the block took to execute.
+
 ```ruby
 class Foo
   # Monitored adds a few methods you can use, like emit(...) and watch(...)
@@ -53,7 +80,6 @@ class Foo
 
   # This method will emit 100 events
   def bar
-
     # Emit 100 events.  The string will be the name of the Event object that gets emitted
     100.times do
       emit("event") # Will emit a new Event with the name 'event'
@@ -82,16 +108,19 @@ foo.time_me # Will emit a single TimedEvent
 ```
 
 ### Explicit Event objects
+
+You can also construct and manually emit a `Hallmonitor::Event` object
+if you need to:
+
 ```ruby
-# Event objects include Hallmonitor::Monitored and so they have
-# an emit method of their own
 event = Hallmonitor::Event.new("event")
 event.emit
 ```
 
 ## Contributing to Hallmonitor
 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the latest master to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
 * Start a feature/bugfix branch.

data/lib/hallmonitor.rb

@@ -6,25 +6,30 @@ require 'hallmonitor/timed_event'
 require 'hallmonitor/gauge_event'
 require 'hallmonitor/outputter'
 require 'hallmonitor/middleware'
+require 'hallmonitor/railtie' if defined?(Rails)
 
+# Top-level module, allows for configuration
 module Hallmonitor
   class << self
-    attr_accessor :config
-  end
+    # @return {Hallmonitor::Configuration} instance
+    def config
+      @config ||= Hallmonitor::Configuration.new
+    end
 
-  # Method to configure Hallmonitor, takes a block and passes a
-  # {Hallmonitor::Configuration} object in, which can be used to
-  # set configuration options.
-  def self.configure
-    self.config ||= Hallmonitor::Configuration.new
-    yield(config)
-  end
+    # Method to configure Hallmonitor, takes a block and passes a
+    # {Hallmonitor::Configuration} object in, which can be used to
+    # set configuration options.
+    def configure
+      yield(config)
+    end
 
-  # Adds an outputter to Hallmonitor.  Whenever events are emitted
-  # they will be sent to all registered outputters
-  # @param outputter [Outputter] An instance of an outputter
-  # @note This delegates to {Dispatcher.add_outputter}
-  def self.add_outputter(outputter)
-    Dispatcher.add_outputter(outputter)
+    # Adds an outputter to Hallmonitor.  Whenever events are emitted
+    # they will be sent to all registered outputters
+    #
+    # @param outputter [Outputter] An instance of an outputter
+    # @note This delegates to {Dispatcher.add_outputter}
+    def add_outputter(outputter)
+      Dispatcher.add_outputter(outputter)
+    end
   end
 end

data/lib/hallmonitor/configuration.rb

@@ -4,8 +4,22 @@ module Hallmonitor
     # Whether or not to trap outputter exceptions, defaults to false
     attr_accessor :trap_outputter_exceptions
 
+    # Whether or not to autoinstrument rails controller actions, defaults to false
+    attr_accessor :instrument_rails_controller_actions
+
+    # The metric name to use for controller action measurements,
+    # defaults to 'controller.action.measure'
+    attr_accessor :controller_action_measure_name
+
+    # The metric name to use for controller action counts, defaults to
+    # 'controller.action.measure'
+    attr_accessor :controller_action_count_name
+
     def initialize
       @trap_outputter_exceptions = false
+      @controller_action_measure_name = 'controller.action.measure'
+      @controller_action_count_name = 'controller.action.count'
+      @instrument_rails_controller_actions = false
     end
   end
 end

data/lib/hallmonitor/railtie.rb

@@ -0,0 +1,72 @@
+module Hallmonitor
+  # Auto-instruments Rails ActionController actions to collect metrics
+  # about their behavior
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      if Hallmonitor.config.instrument_rails_controller_actions
+        Hallmonitor::Railtie.enable_action_controller_metrics
+      end
+    end
+
+    def self.enable_action_controller_metrics
+      # See https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-action-controller
+      # for information on this notification
+      ActiveSupport::Notifications.subscribe(/process_action.action_controller/) do |*args|
+        begin
+          event_args = parse_process_action_payload(args)
+
+          tags = {
+            controller: event_args[:controller],
+            action: event_args[:action],
+            status_code: event_args[:status]
+          }
+
+          Hallmonitor::TimedEvent.new(
+            'controller.action.measure',
+            duration: {
+              total: event_args[:total_duration],
+              database: event_args[:db_time],
+              view: event_args[:view_time]
+            },
+            tags: tags
+          ).emit
+
+          Hallmonitor::Event.new('controller.action.count', tags: tags).emit
+        rescue => ex
+          Rails.logger.error("Caught error in Telemeter: #{ex.message}", ex)
+        end
+      end
+    end
+
+    # example args
+    # ["process_action.action_controller",
+    # 2013-11-22 11:17:04 -0600,
+    # 2013-11-22 11:17:04 -0600,
+    # "6a1302819619cb089922",
+    # {:controller=>"BranchesController",
+    #   :action=>"index",
+    #   :params=>{"action"=>"index", "controller"=>"branches"},
+    #   :format=>:html,
+    #   :method=>"GET",
+    #   :path=>"/branches",
+    #   :status=>200,
+    #   :view_runtime=>0.06999999999999999}]
+    def self.parse_process_action_payload(args)
+      parsed_arguments = {}
+      rails_payload = args[4]
+
+      parsed_arguments[:total_duration] = 1000.0 * (args[2] - args[1])
+      parsed_arguments[:view_time] = rails_payload[:view_runtime] || 0
+      parsed_arguments[:db_time] = rails_payload[:db_runtime] || 0
+      parsed_arguments[:status] = rails_payload[:status]
+      parsed_arguments[:controller] = rails_payload[:controller]
+      parsed_arguments[:action] = rails_payload[:action]
+      parsed_arguments[:format] = rails_payload[:format] || 'all'
+      parsed_arguments[:format] = 'all' if parsed_arguments[:format] == '*/*'
+
+      parsed_arguments
+    end
+
+
+  end
+end

data/lib/hallmonitor/version.rb

@@ -1,7 +1,7 @@
 module Hallmonitor
   module Version
     MAJOR = 5
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
     BUILD = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hallmonitor
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Chris TenHarmsel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -172,6 +172,7 @@ files:
 - lib/hallmonitor/outputters/iooutputter.rb
 - lib/hallmonitor/outputters/new_relic.rb
 - lib/hallmonitor/outputters/statsd_outputter.rb
+- lib/hallmonitor/railtie.rb
 - lib/hallmonitor/timed_event.rb
 - lib/hallmonitor/version.rb
 - spec/hallmonitor/dispatcher_spec.rb