netuitive_rails_agent 0.10.0 → 1.0.1

data/lib/netuitive_rails_agent/controller_utils.rb

@@ -0,0 +1,17 @@
+module NetuitiveRailsAgent
+  module ControllerUtils
+    def netuitive_action_name
+      return controller.action_name if defined? controller # rails 3.1.X
+      action_name # rails 4.X
+    end
+
+    def netuitive_controller_name
+      self.class.name
+    end
+
+    def netuitive_request_uri
+      return request.fullpath if defined? request.fullpath # rails 3
+      request.original_fullpath # rails >3.2
+    end
+  end
+end

data/lib/netuitive_rails_agent/error_tracker.rb

@@ -0,0 +1,33 @@
+module NetuitiveRailsAgent
+  module ErrorTrackerHook
+    extend ActiveSupport::Concern
+
+    include NetuitiveRailsAgent::ControllerUtils
+
+    include NetuitiveRailsAgent::ErrorUtils
+
+    included do
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'ErrorTracker included'
+      rescue_from Exception do |exception|
+        begin
+          tags = {
+            URI: netuitive_request_uri,
+            Controller: netuitive_controller_name,
+            Action: netuitive_action_name
+          }
+          metrics = ['action_controller.errors']
+          if netuitive_controller_name
+            metrics << "action_controller.#{netuitive_controller_name}.errors"
+            if netuitive_action_name
+              metrics << "action_controller.#{netuitive_controller_name}.#{netuitive_action_name}.errors"
+            end
+          end
+          handle_error(exception, metrics, tags)
+        rescue => e
+          NetuitiveRailsAgent::NetuitiveLogger.log.error "exception during controller error tracking: message:#{e.message} backtrace:#{e.backtrace}"
+        end
+        raise exception
+      end
+    end
+  end
+end

data/lib/netuitive_rails_agent/error_utils.rb

@@ -0,0 +1,41 @@
+module NetuitiveRailsAgent
+  module ErrorUtils
+    attr_accessor :interaction
+
+    def ignored_error?(exception)
+      unless NetuitiveRailsAgent::ConfigManager.ignored_errors.empty?
+        NetuitiveRailsAgent::ConfigManager.ignored_errors.each do |name|
+          if name.include? '^'
+            name.tr!('^', '')
+            exception.class.ancestors.each do |ancestor|
+              return true if name.casecmp(ancestor.name).zero?
+            end
+          elsif name.casecmp(exception.class.name).zero?
+            return true
+          end
+        end
+      end
+      false
+    end
+
+    def handle_error(exception, metrics = [], tags = {})
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug "received error: #{exception}"
+      unless ignored_error?(exception)
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug "#{exception} wasn't ignored"
+        if NetuitiveRailsAgent::ConfigManager.capture_errors
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug "sending error: #{exception}"
+          @interaction = NetuitiveRailsAgent::ApiInteraction.new unless @interaction
+          @interaction.exception_event(exception, exception.class, tags)
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug 'sent error'
+        end
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug 'sending error metrics'
+        metrics.each do |metric|
+          @interaction.aggregate_metric(metric.to_s, 1)
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug "sent error metric with name: #{metric}"
+        end
+      end
+    rescue => e
+      NetuitiveRailsAgent::NetuitiveLogger.log.error "exception during error tracking: message:#{e.message} backtrace:#{e.backtrace}"
+    end
+  end
+end

data/lib/netuitive_rails_agent/gc.rb

@@ -0,0 +1,33 @@
+module NetuitiveRailsAgent
+  class GCStatsCollector
+    attr_reader :interaction
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def collect
+      unless GC::Profiler.enabled?
+        NetuitiveRailsAgent::NetuitiveLogger.log.warn 'gc profiler not enabled'
+        return
+      end
+      begin
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug 'collecting gc metrics'
+          GC.stat.each do |key, value|
+            NetuitiveRailsAgent::NetuitiveLogger.log.debug "GC stat key: #{key}"
+            if (key.to_s == 'total_allocated_object') || (key.to_s == 'total_freed_object') || (key.to_s == 'count')
+              NetuitiveRailsAgent::NetuitiveLogger.log.debug "sending aggregateCounterMetric GC.stat.#{key}"
+              interaction.aggregate_counter_metric("GC.stat.#{key}", value)
+            else
+              NetuitiveRailsAgent::NetuitiveLogger.log.debug "sending aggregateMetric GC.stat.#{key}"
+              interaction.aggregate_metric("GC.stat.#{key}", value)
+            end
+          end
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug 'sending aggregateCounterMetric GC.profiler.total_time'
+          interaction.aggregate_counter_metric('GC.profiler.total_time', GC::Profiler.total_time)
+        rescue => e
+          NetuitiveRailsAgent::NetuitiveLogger.log.error "exception during gc collection: message:#{e.message} backtrace:#{e.backtrace}"
+        end
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'finished collecting gc metrics'
+    end
+  end
+end

data/lib/netuitive_rails_agent/netuitive_logger.rb

@@ -0,0 +1,49 @@
+module NetuitiveRailsAgent
+  class CheaterLogger
+    attr_accessor :level
+    def debug(message)
+    end
+
+    def error(message)
+    end
+
+    def info(message)
+    end
+  end
+
+  class NetuitiveLogger
+    class << self
+      attr_accessor :log
+      def setup
+        file = NetuitiveRailsAgent::ConfigManager.property('logLocation', 'NETUITIVE_RAILS_LOG_LOCATION', "#{File.expand_path('../../..', __FILE__)}/log/netuitive.log")
+        age = NetuitiveRailsAgent::ConfigManager.property('logAge', 'NETUITIVE_RAILS_LOG_AGE', 'daily')
+        age = format_age(age)
+        size = NetuitiveRailsAgent::ConfigManager.property('logSize', 'NETUITIVE_RAILS_LOG_SIZE', '1000000')
+        size = format_size(size)
+        NetuitiveRailsAgent::NetuitiveLogger.log = Logger.new(file, age, size.to_i)
+      rescue => e
+        puts 'netuitive unable to open log file'
+        puts e.message
+        NetuitiveRailsAgent::NetuitiveLogger.log = NetuitiveRailsAgent::CheaterLogger.new
+      end
+
+      def format_age(age)
+        return 'daily' if age.nil?
+        begin
+          Integer(age)
+        rescue
+          age
+        end
+      end
+
+      def format_size(size)
+        return 1_000_000 if size.nil?
+        begin
+          Integer(size)
+        rescue
+          size
+        end
+      end
+    end
+  end
+end

data/lib/netuitive_rails_agent/objectspace.rb

@@ -0,0 +1,19 @@
+module NetuitiveRailsAgent
+  class ObjectSpaceStatsCollector
+    attr_reader :interaction
+    def initialize(interaction)
+      @interaction = interaction
+    end
+
+    def collect
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'collecting object space metrics'
+      ObjectSpace.count_objects.each do |key, value|
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug "ObjectSpace.count_objects.#{key}"
+        interaction.aggregate_metric("ObjectSpace.count_objects.#{key}", value)
+      end
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'finished collecting object space metrics'
+    rescue => e
+      NetuitiveRailsAgent::NetuitiveLogger.log.error "exception during object space collection: message:#{e.message} backtrace:#{e.backtrace}"
+    end
+  end
+end

data/lib/netuitive_rails_agent/request_data.rb

@@ -0,0 +1,50 @@
+module NetuitiveRailsAgent
+  module RequestDataHook
+    include NetuitiveRailsAgent::ControllerUtils
+
+    HEADERS_NAMES = [
+      'HTTP_X_REQUEST_START'.freeze,
+      'HTTP_X_QUEUE_START'.freeze,
+      'HTTP_X_MIDDLEWARE_START'.freeze
+    ].freeze
+
+    def self.header_start_time(headers)
+      if headers
+        start_time = nil
+        HEADERS_NAMES.each do |header_name|
+          header = headers[header_name]
+          next if header.nil?
+          match = /\d+(\.\d{1,2})?/.match(header)
+          if match.nil?
+            NetuitiveRailsAgent::NetuitiveLogger.log.error "queue time header value #{header} is not recognized"
+            next
+          end
+          header_time = match.to_s.to_f / NetuitiveRailsAgent::ConfigManager.queue_time_divisor
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug "queue header_time: #{header_time}"
+          start_time = start_time.nil? || header_time < start_time ? header_time : start_time
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug "queue start_time: #{start_time}"
+        end
+        return (Time.now.to_f - start_time) * 1000.0
+      end
+      nil
+    end
+
+    def netuitive_request_hook
+      return unless request
+      begin
+        queue_time = NetuitiveRailsAgent::RequestDataHook.header_start_time(request.headers)
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug "queue_time: #{queue_time}"
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug 'sending queue_time metrics'
+        NetuitiveRubyAPI.add_sample('action_controller.request.queue_time', queue_time)
+        return unless netuitive_controller_name
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug "sending queue_time metrics with netuitive_controller_name #{netuitive_controller_name}"
+        NetuitiveRubyAPI.add_sample("action_controller.#{netuitive_controller_name}.request.queue_time", queue_time)
+        return unless netuitive_action_name
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug "sending queue_time metrics with netuitive_action_name #{netuitive_action_name}"
+        NetuitiveRubyAPI.add_sample("action_controller.#{netuitive_controller_name}.#{netuitive_action_name}.request.queue_time", queue_time)
+      rescue => e
+        NetuitiveRailsAgent::NetuitiveLogger.log.error "exception during request tracking: message:#{e.message} backtrace:#{e.backtrace}"
+      end
+    end
+  end
+end

data/lib/netuitive_rails_agent/scheduler.rb

@@ -0,0 +1,44 @@
+module NetuitiveRailsAgent
+  class Scheduler
+    attr_reader :gc_stats_collector
+    attr_reader :object_space_collector
+    attr_reader :interaction
+    def initialize(interaction)
+      @gc_stats_collector = NetuitiveRailsAgent::GCStatsCollector.new(interaction)
+      @object_space_collector = NetuitiveRailsAgent::ObjectSpaceStatsCollector.new(interaction)
+      @interaction = interaction
+    end
+
+    def start_schedule
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'starting schedule'
+      Thread.new do
+        loop do
+          begin
+            collect_metrics
+            sleep_time = interval
+            NetuitiveRailsAgent::NetuitiveLogger.log.debug "scheduler sleeping for: #{sleep_time}"
+            sleep(sleep_time)
+          rescue => e
+            NetuitiveRailsAgent::NetuitiveLogger.log.error "error during schedule: #{e.message}, backtrace: #{e.backtrace}"
+          end
+        end
+      end
+    end
+
+    def interval
+      interval = interaction.interval
+      interval = 60 if interval.nil?
+      interval
+    end
+
+    def collect_metrics
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'collecting schedule metrics'
+      begin
+        gc_stats_collector.collect if NetuitiveRailsAgent::ConfigManager.gc_enabled
+        object_space_collector.collect if NetuitiveRailsAgent::ConfigManager.object_space_enabled
+      rescue => e
+        NetuitiveRailsAgent::NetuitiveLogger.log.error "unable to collect schedule metrics: message:#{e.message} backtrace:#{e.backtrace}"
+      end
+    end
+  end
+end

data/lib/netuitive_rails_agent/sidekiq.rb

@@ -0,0 +1,67 @@
+module NetuitiveRailsAgent
+  class SidekiqTracker
+    def setup
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'turning on sidekiq tracking'
+      require 'sidekiq'
+      Sidekiq.configure_server do |config|
+        config.error_handlers << proc { |ex, ctx_hash| NetuitiveRailsAgent::SidekiqTracker::ErrorTracker.new.call(ex, ctx_hash) }
+        config.server_middleware do |chain|
+          chain.add NetuitiveRailsAgent::SidekiqTracker::ChainTracker
+        end
+      end
+      NetuitiveRailsAgent::NetuitiveLogger.log.debug 'sidekiq tracking installed'
+    end
+
+    class ChainTracker
+      attr_accessor :interaction
+      def initialize
+        @interaction = NetuitiveRailsAgent::ApiInteraction.new
+      end
+
+      def call(worker, item, queue)
+        begin
+          klass = item['wrapped'.freeze] || worker.class.to_s
+          queue = item['queue']
+          NetuitiveRailsAgent::NetuitiveLogger.log.debug "sidekiq job tracked. queue: #{queue}, class: #{klass}"
+          interaction.aggregate_metric("sidekiq.#{klass}.job.count", 1)
+          interaction.aggregate_metric("sidekiq.#{queue}.job.count", 1)
+          interaction.aggregate_metric("sidekiq.#{queue}.#{klass}.job.count", 1)
+        rescue => e
+          NetuitiveRailsAgent::NetuitiveLogger.log.error "exception during sidekiq chain tracking: message:#{e.message} backtrace:#{e.backtrace}"
+        end
+        yield
+      end
+    end
+
+    class ErrorTracker
+      include NetuitiveRailsAgent::ErrorUtils
+
+      def initialize
+        @interaction = NetuitiveRailsAgent::ApiInteraction.new
+      end
+
+      def call(exception, ctx_hash)
+        NetuitiveRailsAgent::NetuitiveLogger.log.debug "sidekiq error tracked. context: #{ctx_hash[:context]}"
+        tags = {
+          sidekiq: 'true',
+          context: ctx_hash[:context]
+        }
+        metrics = ['sidekiq.errors']
+        job = ctx_hash[:job]
+        unless job.nil?
+          if defined? job.item
+            item = job.item
+            klass = item['wrapped'.freeze] || worker.class.to_s
+            queue = item['queue']
+            metrics << "sidekiq.#{queue}.#{klass}.error.count"
+            metrics << "sidekiq.#{queue}.error.count"
+          end
+        end
+
+        handle_error(exception, metrics, tags)
+      rescue => e
+        NetuitiveRailsAgent::NetuitiveLogger.log.error "exception during sidekiq error tracking: message:#{e.message} backtrace:#{e.backtrace}"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netuitive_rails_agent
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netuitive_ruby_api
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: netuitived
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.1
 description: Automatically generates Rails metrics for submission to Netuitive's API
 email: jking@netuitive.com
 executables: []
@@ -50,17 +50,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/netuitive_rails_agent.rb
-- lib/netuitive/action_mailer.rb
-- lib/netuitive/objectspace.rb
-- lib/netuitive/netuitive_rails_logger.rb
-- lib/netuitive/action_view.rb
-- lib/netuitive/scheduler.rb
-- lib/netuitive/active_job.rb
-- lib/netuitive/rails_config_manager.rb
-- lib/netuitive/action_controller.rb
-- lib/netuitive/active_record.rb
-- lib/netuitive/gc.rb
-- lib/netuitive/active_support.rb
+- lib/netuitive_rails_agent/error_utils.rb
+- lib/netuitive_rails_agent/action_mailer.rb
+- lib/netuitive_rails_agent/objectspace.rb
+- lib/netuitive_rails_agent/action_view.rb
+- lib/netuitive_rails_agent/netuitive_logger.rb
+- lib/netuitive_rails_agent/scheduler.rb
+- lib/netuitive_rails_agent/active_job.rb
+- lib/netuitive_rails_agent/request_data.rb
+- lib/netuitive_rails_agent/config_manager.rb
+- lib/netuitive_rails_agent/action_controller.rb
+- lib/netuitive_rails_agent/active_record.rb
+- lib/netuitive_rails_agent/controller_utils.rb
+- lib/netuitive_rails_agent/gc.rb
+- lib/netuitive_rails_agent/sidekiq.rb
+- lib/netuitive_rails_agent/error_tracker.rb
+- lib/netuitive_rails_agent/active_support.rb
+- lib/netuitive_rails_agent/api_interaction.rb
 - config/agent.yml
 - ./LICENSE
 - log/netuitive.log