netuitive_rails_agent 0.10.0 → 1.0.1

data/README.md

@@ -1,11 +1,21 @@
-#netuitive_rails_agent
-Creates default rails metrics to be sent to netuitived using netuitive_ruby_api. 
+Netuitive Rails Agent
+======================
 
-Requirements:
-	netuitived must be running
+The Netuitive Rails Agent creates default rails metrics to be sent to NetuitiveD using the netuitive_ruby_api gem. The Netuitive Rails Agent is meant to work in conjunction with the [netuitive_ruby_api](https://rubygems.org/gems/netuitive_ruby_api) gem and NetuitiveD to help [Netuitive](https://www.netuitive.com) monitor your Ruby applications.
 
-Install:
-	add "gem 'netuitive_rails_agent'" to your Gemfile
-	run "bundle install"
-	restart your rails app
+For more information on the Netuitive Rails Agent, see our Ruby agent [help docs](https://help.netuitive.com/Content/Misc/Datasources/new_ruby_datasource.htm), or contact Netuitive support at [support@netuitive.com](mailto:support@netuitive.com).
+
+Requirements
+-------------
+
+[NetuitiveD](https://github.com/Netuitive/netuitived) must be installed and running.
+
+Installing the Netuitive Rails Agent
+-------------------------------------
+
+1. Add `gem 'netuitive_rails_agent'` to your Gemfile.
+	
+2. Run `bundle install`.
+	
+3. Restart your rails app.
 

data/config/agent.yml

@@ -1,2 +1,37 @@
 #all are configurable using environment variables
-debugLevel: error #options (in ascending order of debugness) are: error, info, debug. environment variable: NETUITIVE_RAILS_DEBUG_LEVEL
+
+#log config options
+logLocation: #NETUITIVE_RAILS_LOG_LOCATION absolute path of log file. leave blank for default location in the gem directory.
+logAge: daily #NETUITIVE_RAILS_LOG_AGE Number of old log files to keep, or frequency of rotation (daily, weekly or monthly).
+logSize: #NETUITIVE_RAILS_LOG_SIZE Maximum logfile size in bytes(only applies when shift_age is a number).
+debugLevel: error #NETUITIVE_RAILS_DEBUG_LEVEL options (in ascending order of debugness) are: error, info, debug.
+
+#feature flags
+#active support nptifications
+actionControllerEnabled: true #NETUITIVE_RAILS_ACTION_CONTROLLER_ENABLED
+activeRecordEnabled: true #NETUITIVE_RAILS_ACTIVE_RECORD_ENABLED
+actionViewEnabled: true #NETUITIVE_RAILS_ACTION_VIEW_ENABLED
+actionMailerEnabled: true #NETUITIVE_RAILS_ACTION_MAILER_ENABLED
+activeSupportEnabled: true #NETUITIVE_RAILS_ACTIVE_SUPPORT_ENABLED
+activeJobEnabled: true #NETUITIVE_RAILS_ACTIVE_JOB_ENABLED
+#injected instrumentation
+requestWrapperEnabled: true #NETUITIVE_RAILS_REQUEST_WRAPPER_ENABLED
+actionErrorsEnabled: true #NETUITIVE_RAILS_ACTION_ERRORS_ENABLED
+#interpreter metrics
+gcEnabled: true #NETUITIVE_RAILS_GC_ENABLED
+objectSpaceEnabled: true #NETUITIVE_RAILS_OBJECT_SPACE_ENABLED
+#3rd party
+sidekiqEnabled: false #NETUITIVE_RAILS_SIDEKIQ_ENABLED toggle for collection of sidekiq metrics and errors. error events will not be sent if sendErrorEvents is set to false.
+#error tracking features
+sendErrorEvents: false #NETUITIVE_RAILS_SEND_ERROR_EVENTS toggle for sending exceptions to netuitived for export as external events.
+
+#feature configs
+queueTimeUnits: 1 #NETUITIVE_RAILS_QUEUE_TIME_UNITS this is the divisor required to get the queue time metric into seconds. examples: seconds: 1, milliseconds: 1000, microseconds: 1000000.
+ignoredErrors: #NETUITIVE_RAILS_IGNORED_ERRORS list of exceptions to ignore. should be provided in the following yaml format:
+#ignoredErrors:
+# - RuntimeError
+# - ArgumentError
+#or the following env argument format: NETUITIVE_RAILS_IGNORED_ERRORS=RuntimeError,ArgumentError
+#to ignore exceptions that match against an ancestor, add "^" to the exception class.
+#Example: NETUITIVE_RAILS_IGNORED_ERRORS=RuntimeError^
+#will ignore all errors that inherit from RuntimeError

data/lib/netuitive_rails_agent.rb

@@ -1,20 +1,46 @@
+require 'logger'
+require 'active_support'
+require 'action_controller'
+require 'action_mailer'
+require 'active_support/concern'
 require 'netuitive_ruby_api'
-require 'active_support/all'
-require 'netuitive/action_controller'
-require 'netuitive/active_record'
-require 'netuitive/action_view'
-require 'netuitive/action_mailer'
-require 'netuitive/active_support'
-require 'netuitive/active_job'
-require 'netuitive/rails_config_manager'
-require 'netuitive/scheduler'
+require 'netuitive_rails_agent/config_manager'
+require 'netuitive_rails_agent/netuitive_logger'
 
-NetuitiveActionControllerSub::subscribe
-NetuitiveActiveRecordSub::subscribe
-NetuitiveActionViewSub::subscribe
-NetuitiveActionMailer::subscribe
-NetuitiveActiveSupportSub::subscribe
-NetuitiveActiveJobSub::subscribe
+# load config and logger
+NetuitiveRailsAgent::ConfigManager.load_config
+NetuitiveRailsAgent::NetuitiveLogger.setup
+NetuitiveRailsAgent::ConfigManager.read_config
 
-ConfigManager::setup
-Scheduler::startSchedule
+require 'netuitive_rails_agent/api_interaction'
+require 'netuitive_rails_agent/controller_utils'
+require 'netuitive_rails_agent/error_utils'
+require 'netuitive_rails_agent/error_tracker'
+require 'netuitive_rails_agent/request_data'
+require 'netuitive_rails_agent/action_controller'
+require 'netuitive_rails_agent/active_record'
+require 'netuitive_rails_agent/action_view'
+require 'netuitive_rails_agent/action_mailer'
+require 'netuitive_rails_agent/active_support'
+require 'netuitive_rails_agent/active_job'
+require 'netuitive_rails_agent/sidekiq'
+require 'netuitive_rails_agent/gc'
+require 'netuitive_rails_agent/objectspace'
+require 'netuitive_rails_agent/scheduler'
+
+# subscribe to notifications
+interaction = NetuitiveRailsAgent::ApiInteraction.new
+NetuitiveRailsAgent::ActionControllerSub.new(interaction).subscribe if NetuitiveRailsAgent::ConfigManager.action_controller_enabled
+NetuitiveRailsAgent::ActiveRecordSub.new(interaction).subscribe if NetuitiveRailsAgent::ConfigManager.active_record_enabled
+NetuitiveRailsAgent::ActionViewSub.new(interaction).subscribe if NetuitiveRailsAgent::ConfigManager.action_view_enabled
+NetuitiveRailsAgent::ActionMailerSub.new(interaction).subscribe if NetuitiveRailsAgent::ConfigManager.action_mailer_enabled
+NetuitiveRailsAgent::ActiveSupportSub.new(interaction).subscribe if NetuitiveRailsAgent::ConfigManager.active_support_enabled
+NetuitiveRailsAgent::ActiveJobSub.new(interaction).subscribe if NetuitiveRailsAgent::ConfigManager.active_job_enabled
+
+# start metrics that are collected on a schedule
+NetuitiveRailsAgent::Scheduler.new(interaction).start_schedule if NetuitiveRailsAgent::ConfigManager.gc_enabled || NetuitiveRailsAgent::ConfigManager.object_space_enabled
+
+# sidekiq
+NetuitiveRailsAgent::SidekiqTracker.new.setup if NetuitiveRailsAgent::ConfigManager.sidekiq_enabled
+
+NetuitiveRailsAgent::NetuitiveLogger.log.info 'Netuitive rails agent installed'

data/lib/netuitive_rails_agent/action_controller.rb

@@ -0,0 +1,97 @@
+ActionController::Base.class_eval do
+  include NetuitiveRailsAgent::ErrorTrackerHook if NetuitiveRailsAgent::ConfigManager.action_errors_enabled
+  if NetuitiveRailsAgent::ConfigManager.request_wrapper_enabled
+    include NetuitiveRailsAgent::RequestDataHook
+    before_action :netuitive_request_hook
+  end
+end
+
+module NetuitiveRailsAgent
+  class ActionControllerSub
+    attr_reader :interaction
+
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def subscribe
+      ActiveSupport::Notifications.subscribe(/process_action.action_controller/) do |*args|
+        process_action(*args)
+      end
+      ActiveSupport::Notifications.subscribe(/write_fragment.action_controller/) do |*_args|
+        write_fragment
+      end
+      ActiveSupport::Notifications.subscribe(/read_fragment.action_controller/) do |*_args|
+        read_fragment
+      end
+      ActiveSupport::Notifications.subscribe(/expire_fragment.action_controller/) do |*_args|
+        expire_fragment
+      end
+      ActiveSupport::Notifications.subscribe(/write_page.action_controller/) do |*_args|
+        write_page
+      end
+      ActiveSupport::Notifications.subscribe(/expire_page.action_controller/) do |*_args|
+        expire_page
+      end
+      ActiveSupport::Notifications.subscribe(/send_file.action_controller/) do |*_args|
+        send_file
+      end
+      ActiveSupport::Notifications.subscribe(/redirect_to.action_controller/) do |*_args|
+        redirect_to
+      end
+      ActiveSupport::Notifications.subscribe(/halted_callback.action_controller/) do |*_args|
+        halted_callback
+      end
+    end
+
+    def process_action(*args)
+      event = ActiveSupport::Notifications::Event.new(*args)
+      controller = event.payload[:controller].to_s
+      action = event.payload[:action].to_s
+      interaction.add_sample("action_controller.#{controller}.#{action}.request.total_duration", event.duration)
+      interaction.add_sample("action_controller.#{controller}.#{action}.request.query_time", event.payload[:db_runtime])
+      interaction.add_sample("action_controller.#{controller}.#{action}.request.view_time", event.payload[:view_runtime])
+      interaction.add_sample("action_controller.#{controller}.request.total_duration", event.duration)
+      interaction.add_sample("action_controller.#{controller}.request.query_time", event.payload[:db_runtime])
+      interaction.add_sample("action_controller.#{controller}.request.view_time", event.payload[:view_runtime])
+      interaction.add_sample('action_controller.request.total_duration', event.duration)
+      interaction.add_sample('action_controller.request.query_time', event.payload[:db_runtime])
+      interaction.add_sample('action_controller.request.view_time', event.payload[:view_runtime])
+      interaction.aggregate_metric("action_controller.#{controller}.#{action}.total_requests", 1)
+      interaction.aggregate_metric("action_controller.#{controller}.total_requests", 1)
+      interaction.aggregate_metric('action_controller.total_requests', 1)
+    end
+
+    def write_fragment
+      interaction.aggregate_metric('action_controller.write_fragment', 1)
+    end
+
+    def read_fragment
+      interaction.aggregate_metric('action_controller.read_fragment', 1)
+    end
+
+    def expire_fragment
+      interaction.aggregate_metric('action_controller.expire_fragment', 1)
+    end
+
+    def write_page
+      interaction.aggregate_metric('action_controller.write_page', 1)
+    end
+
+    def expire_page
+      interaction.aggregate_metric('action_controller.expire_page', 1)
+    end
+
+    def send_file
+      interaction.aggregate_metric('action_controller.sent_file', 1)
+    end
+
+    def redirect_to
+      interaction.aggregate_metric('action_controller.redirect', 1)
+    end
+
+    def halted_callback
+      interaction.aggregate_metric('action_controller.halted_callback', 1)
+    end
+  end
+end

data/lib/netuitive_rails_agent/action_mailer.rb

@@ -0,0 +1,29 @@
+module NetuitiveRailsAgent
+  class ActionMailerSub
+    attr_reader :interaction
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def subscribe
+      ActiveSupport::Notifications.subscribe(/receive.action_mailer/) do |*args|
+        receive(args)
+      end
+      ActiveSupport::Notifications.subscribe(/deliver.action_mailer/) do |*args|
+        deliver(args)
+      end
+    end
+
+    def receive(*args)
+      event = ActiveSupport::Notifications::Event.new(*args)
+      mailer = event.payload[:mailer].to_s
+      interaction.aggregate_metric("action_mailer.#{mailer}.receive", 1)
+    end
+
+    def deliver(*args)
+      event = ActiveSupport::Notifications::Event.new(*args)
+      mailer = event.payload[:mailer].to_s
+      interaction.aggregate_metric("action_mailer.#{mailer}.deliver", 1)
+    end
+  end
+end

data/lib/netuitive_rails_agent/action_view.rb

@@ -0,0 +1,25 @@
+module NetuitiveRailsAgent
+  class ActionViewSub
+    attr_reader :interaction
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def subscribe
+      ActiveSupport::Notifications.subscribe(/render_template.action_view/) do |*_args|
+        render_template
+      end
+      ActiveSupport::Notifications.subscribe(/render_partial.action_view/) do |*_args|
+        render_partial
+      end
+    end
+
+    def render_template
+      interaction.aggregate_metric('action_view.render_template', 1)
+    end
+
+    def render_partial
+      interaction.aggregate_metric('action_view.render_partial', 1)
+    end
+  end
+end

data/lib/netuitive_rails_agent/active_job.rb

@@ -0,0 +1,25 @@
+module NetuitiveRailsAgent
+  class ActiveJobSub
+    attr_reader :interaction
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def subscribe
+      ActiveSupport::Notifications.subscribe(/enqueue.active_job/) do |*_args|
+        enqueue
+      end
+      ActiveSupport::Notifications.subscribe(/perform.active_job/) do |*_args|
+        perform
+      end
+    end
+
+    def enqueue
+      interaction.aggregate_metric('active_job.enqueue', 1)
+    end
+
+    def perform
+      interaction.aggregate_metric('active_job.perform', 1)
+    end
+  end
+end

data/lib/netuitive_rails_agent/active_record.rb

@@ -0,0 +1,26 @@
+module NetuitiveRailsAgent
+  class ActiveRecordSub
+    attr_reader :interaction
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def subscribe
+      ActiveSupport::Notifications.subscribe(/instantiation.active_record/) do |*_args|
+        instantiation
+      end
+
+      ActiveSupport::Notifications.subscribe(/sql.active_record/) do |*_args|
+        sql
+      end
+    end
+
+    def instantiation
+      interaction.aggregate_metric('active_record.instantiation', 1)
+    end
+
+    def sql
+      interaction.aggregate_metric('active_record.sql.statement', 1)
+    end
+  end
+end

data/lib/netuitive_rails_agent/active_support.rb

@@ -0,0 +1,46 @@
+module NetuitiveRailsAgent
+  class ActiveSupportSub
+    attr_reader :interaction
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def subscribe
+      ActiveSupport::Notifications.subscribe(/cache_read.active_support/) do |*_args|
+        cache_read
+      end
+      ActiveSupport::Notifications.subscribe(/cache_generate.active_support/) do |*_args|
+        cache_generate
+      end
+      ActiveSupport::Notifications.subscribe(/cache_fetch_hit.active_support/) do |*_args|
+        cache_fetch_hit
+      end
+      ActiveSupport::Notifications.subscribe(/cache_write.active_support/) do |*_args|
+        cache_write
+      end
+      ActiveSupport::Notifications.subscribe(/cache_delete.active_support/) do |*_args|
+        cache_delete
+      end
+    end
+
+    def cache_read
+      interaction.aggregate_metric('active_support.cache_read', 1)
+    end
+
+    def cache_generate
+      interaction.aggregate_metric('active_support.cache_generate', 1)
+    end
+
+    def cache_fetch_hit
+      interaction.aggregate_metric('active_support.cache_fetch_hit', 1)
+    end
+
+    def cache_write
+      interaction.aggregate_metric('active_support.cache_write', 1)
+    end
+
+    def cache_delete
+      interaction.aggregate_metric('active_support.cache_delete', 1)
+    end
+  end
+end

data/lib/netuitive_rails_agent/api_interaction.rb

@@ -0,0 +1,43 @@
+module NetuitiveRailsAgent
+  class ApiInteraction
+    def send_metrics
+      NetuitiveRubyAPI.send_metrics
+    end
+
+    def add_sample(metric_id, val)
+      NetuitiveRubyAPI.add_sample(metric_id, val)
+    end
+
+    def add_counter_sample(metric_id, val)
+      NetuitiveRubyAPI.add_counter_sample(metric_id, val)
+    end
+
+    def aggregate_metric(metric_id, val)
+      NetuitiveRubyAPI.aggregate_metric(metric_id, val)
+    end
+
+    def aggregate_counter_metric(metric_id, val)
+      NetuitiveRubyAPI.aggregate_counter_metric(metric_id, val)
+    end
+
+    def clear_metrics
+      NetuitiveRubyAPI.clear_metrics
+    end
+
+    def interval
+      NetuitiveRubyAPI.interval
+    end
+
+    def event(message, timestamp = Time.new, title = 'Ruby Event', level = 'Info', source = 'Ruby Agent', type = 'INFO', tags = nil)
+      NetuitiveRubyAPI.event(message, timestamp, title, level, source, type, tags)
+    end
+
+    def exception_event(exception, klass = nil, tags = nil)
+      NetuitiveRubyAPI.exception_event(exception, klass, tags)
+    end
+
+    def stop_server
+      NetuitiveRubyAPI.stop_server
+    end
+  end
+end

data/lib/netuitive_rails_agent/config_manager.rb

@@ -0,0 +1,124 @@
+module NetuitiveRailsAgent
+  class ConfigManager
+    class << self
+      attr_accessor :capture_errors
+
+      attr_accessor :ignored_errors
+
+      attr_accessor :queue_time_divisor
+
+      attr_accessor :sidekiq_enabled
+
+      attr_accessor :action_controller_enabled
+
+      attr_accessor :active_record_enabled
+
+      attr_accessor :action_view_enabled
+
+      attr_accessor :action_mailer_enabled
+
+      attr_accessor :active_support_enabled
+
+      attr_accessor :active_job_enabled
+
+      attr_accessor :request_wrapper_enabled
+
+      attr_accessor :action_errors_enabled
+
+      attr_accessor :gc_enabled
+
+      attr_accessor :object_space_enabled
+
+      attr_accessor :data
+
+      def property(name, var, default = nil)
+        prop = ENV[var]
+        prop = data[name] if prop.nil? || (prop == '')
+        return prop unless prop.nil? || (prop == '')
+        default
+      end
+
+      def boolean_property(name, var)
+        prop = ENV[var].nil? ? nil : ENV[var].dup
+        if prop.nil? || (prop == '')
+          prop = data[name]
+        else
+          prop.strip!
+          prop = prop.casecmp('true').zero?
+        end
+        prop
+      end
+
+      def float_property(name, var)
+        prop = ENV[var].nil? ? nil : ENV[var]
+        if prop.nil? || (prop == '')
+          data[name].to_f
+        else
+          prop.to_f
+        end
+      end
+
+      def string_list_property(name, var)
+        list = []
+        prop = ENV[var].nil? ? nil : ENV[var].dup
+        if prop.nil? || (prop == '')
+          list = data[name] if !data[name].nil? && data[name].is_a?(Array)
+        else
+          list = prop.split(',')
+        end
+        list.each(&:strip!) unless list.empty?
+        list
+      end
+
+      def load_config
+        gem_root = File.expand_path('../../..', __FILE__)
+        @data = YAML.load_file "#{gem_root}/config/agent.yml"
+      end
+
+      def read_config
+        debug_level_string = property('debugLevel', 'NETUITIVE_RAILS_DEBUG_LEVEL')
+        NetuitiveRailsAgent::NetuitiveLogger.log.level = if debug_level_string == 'error'
+                                                           Logger::ERROR
+                                                         elsif debug_level_string == 'info'
+                                                           Logger::INFO
+                                                         elsif debug_level_string == 'debug'
+                                                           Logger::DEBUG
+                                                         else
+                                                           Logger::ERROR
+                                                         end
+
+        @capture_errors = boolean_property('sendErrorEvents', 'NETUITIVE_RAILS_SEND_ERROR_EVENTS')
+        @queue_time_divisor = float_property('queueTimeUnits', 'NETUITIVE_RAILS_QUEUE_TIME_UNITS')
+        @ignored_errors = string_list_property('ignoredErrors', 'NETUITIVE_RAILS_IGNORED_ERRORS')
+        @sidekiq_enabled = boolean_property('sidekiqEnabled', 'NETUITIVE_RAILS_SIDEKIQ_ENABLED')
+        @action_controller_enabled = boolean_property('actionControllerEnabled', 'NETUITIVE_RAILS_ACTION_CONTROLLER_ENABLED')
+        @active_record_enabled = boolean_property('activeRecordEnabled', 'NETUITIVE_RAILS_ACTIVE_RECORD_ENABLED')
+        @action_view_enabled = boolean_property('actionViewEnabled', 'NETUITIVE_RAILS_ACTION_VIEW_ENABLED')
+        @action_mailer_enabled = boolean_property('actionMailerEnabled', 'NETUITIVE_RAILS_ACTION_MAILER_ENABLED')
+        @active_support_enabled = boolean_property('activeSupportEnabled', 'NETUITIVE_RAILS_ACTIVE_SUPPORT_ENABLED')
+        @active_job_enabled = boolean_property('activeJobEnabled', 'NETUITIVE_RAILS_ACTIVE_JOB_ENABLED')
+        @request_wrapper_enabled = boolean_property('requestWrapperEnabled', 'NETUITIVE_RAILS_REQUEST_WRAPPER_ENABLED')
+        @action_errors_enabled = boolean_property('actionErrorsEnabled', 'NETUITIVE_RAILS_ACTION_ERRORS_ENABLED')
+        @gc_enabled = boolean_property('gcEnabled', 'NETUITIVE_RAILS_GC_ENABLED')
+        @object_space_enabled = boolean_property('objectSpaceEnabled', 'NETUITIVE_RAILS_OBJECT_SPACE_ENABLED')
+
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug "read config file. Results:
+          debugLevel: #{debug_level_string},
+          capture_errors: #{capture_errors},
+          ignored_errors: #{ignored_errors},
+          queue_time_divisor: #{queue_time_divisor},
+          sidekiq_enabled: #{sidekiq_enabled},
+          action_controller_enabled: #{action_controller_enabled},
+          active_record_enabled: #{active_record_enabled},
+          action_view_enabled: #{action_view_enabled},
+          action_mailer_enabled: #{action_mailer_enabled},
+          active_support_enabled: #{active_support_enabled},
+          active_job_enabled: #{active_job_enabled},
+          request_wrapper_enabled: #{request_wrapper_enabled},
+          action_errors_enabled: #{action_errors_enabled},
+          gc_enabled: #{gc_enabled},
+          object_space_enabled: #{object_space_enabled}"
+      end
+    end
+  end
+end