influxdb-rails 0.4.999 → 1.0.0.beta1

data/lib/influxdb/rails/air_traffic_controller.rb

@@ -1,30 +1,22 @@
 module InfluxDB
   module Rails
-    module AirTrafficController
-      def influxdb_request_data
-        unfiltered_params = params.to_hash
-        if respond_to?(:filter_parameters)
-          filtered_params = filter_parameters(unfiltered_params)
-        elsif defined? request.filtered_parameters
-          filtered_params = request.filtered_parameters
-        else
-          filtered_params = unfiltered_params.except(:password, :password_confirmation)
-        end
-
+    module AirTrafficController # :nodoc:
+      def influxdb_request_data # rubocop:disable Metrics/MethodLength
         {
-          :params => filtered_params,
-          :session_data => influxdb_session_data,
-          :controller => params[:controller],
-          :action => params[:action],
-          :request_url => influxdb_request_url,
-          :user_agent => request.env["HTTP_USER_AGENT"],
-          :remote_ip => request.remote_ip,
-          :referer => request.referer,
-          :current_user => (current_user rescue nil)
+          params:       influxdb_filtered_params,
+          session_data: influxdb_session_data,
+          controller:   params[:controller],
+          action:       params[:action],
+          request_url:  influxdb_request_url,
+          user_agent:   request.env["HTTP_USER_AGENT"],
+          remote_ip:    request.remote_ip,
+          referer:      request.referer,
+          current_user: (current_user rescue nil),
         }
       end
 
       private
+
       def influxdb_session_data
         session.respond_to?(:to_hash) ? session.to_hash : session.data
       end
@@ -34,6 +26,16 @@ module InfluxDB
         url << ":#{request.port}" unless [80, 443].include?(request.port)
         url << request.fullpath
       end
+
+      def influxdb_filtered_params
+        if respond_to?(:filter_parameters)
+          filter_parameters(unfiltered_params)
+        elsif defined?(request.filtered_parameters)
+          request.filtered_parameters
+        else
+          params.to_hash.except(:password, :password_confirmation)
+        end
+      end
     end
   end
 end

data/lib/influxdb/rails/backtrace.rb

@@ -1,8 +1,8 @@
 module InfluxDB
   module Rails
-    class Backtrace
-      class Line
-        FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
+    class Backtrace # rubocop:disable Style/Documentation
+      class Line # rubocop:disable Style/Documentation
+        FORMAT = /^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/.freeze
 
         attr_reader :file
         attr_reader :number
@@ -17,7 +17,7 @@ module InfluxDB
         end
 
         def inspect
-          "<Line: #{to_s}>"
+          "<Line: #{to_s}>" # rubocop:disable Lint/StringConversionInInterpolation
         end
       end
 
@@ -37,7 +37,7 @@ module InfluxDB
       end
 
       def inspect
-        "<Backtrace: " + lines.collect { |line| line.to_s }.join(", ") + ">"
+        "<Backtrace: " + lines.collect(&:to_s).join(", ") + ">"
       end
     end
   end

data/lib/influxdb/rails/configuration.rb

@@ -1,6 +1,8 @@
 module InfluxDB
   module Rails
-    class Configuration
+    # rubocop:disable Metrics/ClassLength
+
+    class Configuration # rubocop:disable Style/Documentation
       attr_accessor :influxdb_hosts
       attr_accessor :influxdb_port
       attr_accessor :influxdb_username
@@ -17,9 +19,10 @@ module InfluxDB
       attr_accessor :series_name_for_controller_runtimes
       attr_accessor :series_name_for_view_runtimes
       attr_accessor :series_name_for_db_runtimes
+      attr_accessor :series_name_for_exceptions
+      attr_accessor :series_name_for_instrumentation
 
-      attr_accessor :application_id
-      deprecate :application_id => "This method serve no purpose and will be removed in the release after 0.1.12"
+      attr_accessor :rails_app_name
 
       attr_accessor :application_name
       attr_accessor :application_root
@@ -43,46 +46,51 @@ module InfluxDB
       attr_accessor :instrumentation_enabled
       attr_accessor :debug
 
-      attr_accessor :reraise_global_exceptions
-      deprecate :reraise_global_exceptions => "This method serves no purpose and will be removed in the release after 0.1.13"
-
-
       DEFAULTS = {
-        :influxdb_hosts     => ["localhost"],
-        :influxdb_port      => 8086,
-        :influxdb_username  => "root",
-        :influxdb_password  => "root",
-        :influxdb_database  => nil,
-        :async              => true,
-        :use_ssl            => false,
-        :retry              => nil,
-        :open_timeout       => 5,
-        :read_timeout       => 300,
-        :max_delay          => 30,
-        :time_precision     => "s",
-
-        :series_name_for_controller_runtimes  => "rails.controller",
-        :series_name_for_view_runtimes        => "rails.view",
-        :series_name_for_db_runtimes          => "rails.db",
-
-        :ignored_exceptions => %w{ActiveRecord::RecordNotFound
-                                  ActionController::RoutingError},
-        :ignored_exception_messages => [],
-        :ignored_reports => [],
-        :ignored_environments => %w{test cucumber selenium},
-        :ignored_user_agents => %w{GoogleBot},
-        :environment_variable_filters => [
+        influxdb_hosts:                      ["localhost"].freeze,
+        influxdb_port:                       8086,
+        influxdb_username:                   "root".freeze,
+        influxdb_password:                   "root".freeze,
+        influxdb_database:                   nil,
+        async:                               true,
+        use_ssl:                             false,
+        retry:                               nil,
+        open_timeout:                        5,
+        read_timeout:                        300,
+        max_delay:                           30,
+        time_precision:                      "s".freeze,
+
+        series_name_for_controller_runtimes: "rails.controller".freeze,
+        series_name_for_view_runtimes:       "rails.view".freeze,
+        series_name_for_db_runtimes:         "rails.db".freeze,
+        series_name_for_exceptions:          "rails.exceptions".freeze,
+        series_name_for_instrumentation:     "instrumentation".freeze,
+
+        rails_app_name:                      nil,
+
+        ignored_exceptions:                  %w[
+          ActiveRecord::RecordNotFound
+          ActionController::RoutingError
+        ].freeze,
+
+        ignored_exception_messages:          [].freeze,
+        ignored_reports:                     [].freeze,
+        ignored_environments:                %w[test cucumber selenium].freeze,
+        ignored_user_agents:                 %w[GoogleBot].freeze,
+        environment_variable_filters:        [
           /password/i,
           /key/i,
           /secret/i,
           /ps1/i,
           /rvm_.*_clr/i,
-          /color/i
-        ],
-        :backtrace_filters => [
-          lambda { |line| line.gsub(/^\.\//, "") },
+          /color/i,
+        ].freeze,
+
+        backtrace_filters:                   [
+          ->(line) { line.gsub(%r{^\./}, "") },
           lambda { |line|
             return line if InfluxDB::Rails.configuration.application_root.to_s.empty?
+
             line.gsub(/#{InfluxDB::Rails.configuration.application_root}/, "[APP_ROOT]")
           },
           lambda { |line|
@@ -90,9 +98,12 @@ module InfluxDB
               Gem.path.each { |path| line = line.gsub(/#{path}/, "[GEM_ROOT]") }
             end
             line
-          }
-        ]
-      }
+          },
+        ].freeze,
+      }.freeze
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
 
       def initialize
         @influxdb_hosts     = DEFAULTS[:influxdb_hosts]
@@ -111,6 +122,10 @@ module InfluxDB
         @series_name_for_controller_runtimes  = DEFAULTS[:series_name_for_controller_runtimes]
         @series_name_for_view_runtimes        = DEFAULTS[:series_name_for_view_runtimes]
         @series_name_for_db_runtimes          = DEFAULTS[:series_name_for_db_runtimes]
+        @series_name_for_exceptions           = DEFAULTS[:series_name_for_exceptions]
+        @series_name_for_instrumentation      = DEFAULTS[:series_name_for_instrumentation]
+
+        @rails_app_name = DEFAULTS[:rails_app_name]
 
         @ignored_exceptions           = DEFAULTS[:ignored_exceptions].dup
         @ignored_exception_messages   = DEFAULTS[:ignored_exception_messages].dup
@@ -126,21 +141,30 @@ module InfluxDB
         @instrumentation_enabled  = true
       end
 
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
       def debug?
-        !!@debug
+        !!@debug # rubocop:disable Style/DoubleNegation
       end
 
       def instrumentation_enabled?
-        !!@instrumentation_enabled
+        !!@instrumentation_enabled # rubocop:disable Style/DoubleNegation
       end
 
       def ignore_user_agent?(incoming_user_agent)
-        return false if self.ignored_user_agents.nil?
-        self.ignored_user_agents.any? {|agent| incoming_user_agent =~ /#{agent}/}
+        return false if ignored_user_agents.nil?
+
+        ignored_user_agents.any? { |agent| incoming_user_agent =~ /#{agent}/ }
       end
 
       def ignore_current_environment?
-        self.ignored_environments.include?(self.environment)
+        ignored_environments.include?(environment)
+      end
+
+      def ignore_exception?(ex)
+        !ignored_exception_messages.find { |msg| /.*#{msg}.*/ =~ ex.message }.nil? ||
+          ignored_exceptions.include?(ex.class.to_s)
       end
 
       def define_custom_exception_data(&block)
@@ -148,18 +172,25 @@ module InfluxDB
       end
 
       def add_custom_exception_data(exception_presenter)
-        @custom_exception_data_handler.call(exception_presenter) if @custom_exception_data_handler
+        @custom_exception_data_handler&.call(exception_presenter)
       end
 
-      def database_name
-        @application_id.to_s + @environment.to_s
+      def load_rails_defaults
+        @logger           ||= ::Rails.logger
+        @environment      ||= ::Rails.env
+        @application_root ||= ::Rails.root
+        @application_name ||= ::Rails.application.class.parent_name
+        @framework          = "Rails"
+        @framework_version  = ::Rails.version
       end
-      deprecate :database_name => "This method will be removed in the release after 0.1.12, you ought to use #influxdb_database"
 
       private
+
       def initialize_http_connection
         Net::HTTP.new(@app_host, "80")
       end
     end
+
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/influxdb/rails/exception_presenter.rb

@@ -4,7 +4,7 @@ require "json"
 
 module InfluxDB
   module Rails
-    class ExceptionPresenter
+    class ExceptionPresenter # rubocop:disable Style/Documentation
       attr_reader :exception
       attr_reader :backtrace
       attr_reader :params
@@ -18,38 +18,27 @@ module InfluxDB
       attr_reader :user_agent
       attr_reader :custom_data
 
-      def initialize(e, params = {})
-        e = e.continued_exception if e.respond_to?(:continued_exception)
-        e = e.original_exception if e.respond_to?(:original_exception)
+      def initialize(ex, params = {})
+        ex = ex.continued_exception if ex.respond_to?(:continued_exception)
+        ex = ex.original_exception if ex.respond_to?(:original_exception)
+
+        @exception    = ex.is_a?(String) ? Exception.new(ex) : ex
+        @backtrace    = InfluxDB::Rails::Backtrace.new(@exception.backtrace)
+        @dimensions   = {}
+        configure_from_params(params)
 
-        @exception = e.is_a?(String) ? Exception.new(e) : e
-        @backtrace = InfluxDB::Rails::Backtrace.new(@exception.backtrace)
-        @params = params[:params]
-        @session_data = params[:session_data] || {}
-        @current_user = params[:current_user]
-        @controller = params[:controller]
-        @action = params[:action]
-        @request_url = params[:request_url]
-        @user_agent = params[:user_agent]
-        @referer = params[:referer]
-        @remote_ip = params[:remote_ip]
-        @custom_data = params[:custom_data] || {}
         @environment_variables = ENV.to_hash || {}
-        @dimensions = {}
       end
 
-      def context
+      def context # rubocop:disable Metrics/MethodLength
         c = {
-          :time => InfluxDB::Rails.current_timestamp,
-          :application_name => InfluxDB::Rails.configuration.application_name,
-          :application_root => InfluxDB::Rails.configuration.application_root,
-          :framework => InfluxDB::Rails.configuration.framework,
-          :framework_version => InfluxDB::Rails.configuration.framework_version,
-          :message => @exception.message,
-          :backtrace => JSON.generate(@backtrace.to_a),
-          :language => "Ruby",
-          :language_version => "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
-          :custom_data => @custom_data
+          application_name:  InfluxDB::Rails.configuration.application_name,
+          application_root:  InfluxDB::Rails.configuration.application_root,
+          framework:         InfluxDB::Rails.configuration.framework,
+          framework_version: InfluxDB::Rails.configuration.framework_version,
+          language:          "Ruby",
+          language_version:  "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
+          custom_data:       @custom_data,
         }
 
         InfluxDB::Rails.configuration.add_custom_exception_data(self)
@@ -57,27 +46,49 @@ module InfluxDB
       end
 
       def dimensions
-        d = {
-          :class => @exception.class.to_s,
-          :method => "#{@controller}##{@action}",
-          :filename => File.basename(@backtrace.lines.first.try(:file)),
-          :server => Socket.gethostname,
-          :status => "open"
+        {
+          class:    @exception.class.to_s,
+          method:   "#{@controller}##{@action}",
+          filename: File.basename(@backtrace.lines.first.try(:file)),
+          server:   Socket.gethostname,
+          status:   "open",
         }.merge(@dimensions)
       end
 
+      def values
+        {
+          exception_message:   @exception.message,
+          exception_backtrace: JSON.generate(@backtrace.to_a),
+        }
+      end
+
       def request_data
         {
-          :params => @params,
-          :session_data => @session_data,
-          :controller => @controller,
-          :action => @action,
-          :request_url => @request_url,
-          :referer => @referer,
-          :remote_ip => @remote_ip,
-          :user_agent => @user_agent
+          params:       @params,
+          session_data: @session_data,
+          controller:   @controller,
+          action:       @action,
+          request_url:  @request_url,
+          referer:      @referer,
+          remote_ip:    @remote_ip,
+          user_agent:   @user_agent,
         }
       end
+
+      private
+
+      def configure_from_params(params)
+        @params       = params[:params]
+        @session_data = params[:session_data] || {}
+        @current_user = params[:current_user]
+        @controller   = params[:controller]
+        @action       = params[:action]
+        @request_url  = params[:request_url]
+        @user_agent   = params[:user_agent]
+        @referer      = params[:referer]
+        @remote_ip    = params[:remote_ip]
+        @custom_data  = params[:custom_data] || {}
+      end
     end
   end
 end

data/lib/influxdb/rails/instrumentation.rb

@@ -1,32 +1,32 @@
 module InfluxDB
   module Rails
-    module Instrumentation
-      def benchmark_for_instrumentation
+    module Instrumentation # rubocop:disable Style/Documentation
+      def benchmark_for_instrumentationn # rubocop:disable Metrics/MethodLength
         start = Time.now
         yield
 
-        unless InfluxDB::Rails.configuration.ignore_current_environment?
-          elapsed = ((Time.now - start) * 1000).ceil
-          InfluxDB::Rails.client.write_point "instrumentation", {
-            values: {
-              value: elapsed,
-            },
-            tags: {
-              method: "#{controller_name}##{action_name}",
-              server: Socket.gethostname,
-            },
+        c = InfluxDB::Rails.configuration
+        return if c.ignore_current_environment?
+
+        InfluxDB::Rails.client.write_point \
+          c.series_name_for_instrumentation,
+          values: {
+            value: ((Time.now - start) * 1000).ceil,
+          },
+          tags:   {
+            method: "#{controller_name}##{action_name}",
+            server: Socket.gethostname,
           }
-        end
       end
 
       def self.included(base)
         base.extend(ClassMethods)
       end
 
-      module ClassMethods
+      module ClassMethods # rubocop:disable Style/Documentation
         def instrument(methods = [])
           methods = [methods] unless methods.is_a?(Array)
-          around_filter :benchmark_for_instrumentation, :only => methods
+          around_filter :benchmark_for_instrumentation, only: methods
         end
       end
     end