influxdb-rails 1.0.0.beta1 → 1.0.1.beta1

data/Rakefile

@@ -2,28 +2,27 @@ require "bundler/gem_tasks"
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-begin
-  targeted_files = ARGV.drop(1)
-  file_pattern = targeted_files.empty? ? "spec/**/*_spec.rb" : targeted_files
+targeted_files = ARGV.drop(1)
+file_pattern = targeted_files.empty? ? "spec/**/*_spec.rb" : targeted_files
 
-  require "rspec/core"
-  require "rspec/core/rake_task"
+require "rspec/core"
+require "rspec/core/rake_task"
 
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.pattern = FileList[file_pattern]
-  end
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = FileList[file_pattern]
+end
 
-  RSpec.configure do |config|
-    config.color = true
-    config.formatter = :documentation
-  end
-rescue LoadError
-  require "spec/rake/spectask"
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :documentation
+end
 
-  puts file_pattern
+task default: %i[spec rubocop]
 
-  Spec::Rake::SpecTask.new(:spec) do |t|
-    t.pattern = FileList[file_pattern]
-    t.spec_opts += ["--color"]
+task "test:all" => :default do
+  Dir.glob("gemfiles/Gemfile.rails-*.x") do |gemfile|
+    puts RSpec::Core::Formatters::ConsoleCodes.wrap(gemfile, :cyan)
+    sh({ "BUNDLE_GEMFILE" => gemfile }, "bundle", "install", "--quiet", "--retry=2", "--jobs=2")
+    sh({ "BUNDLE_GEMFILE" => gemfile }, "bundle", "exec", "rspec")
   end
 end

data/gemfiles/Gemfile.rails-5.0.x

@@ -3,5 +3,7 @@ source "https://rubygems.org"
 gem 'actionpack', '~> 5.0.0'
 gem 'activesupport', '~> 5.0.0'
 gem 'activemodel', '~> 5.0.0'
+gem 'sqlite3', '1.3.13'
+
 
 gemspec :path => '../'

data/gemfiles/Gemfile.rails-6.0.x

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem 'actionpack', '~> 6.0.0'
+gem 'activesupport', '~> 6.0.0'
+gem 'activemodel', '~> 6.0.0'
+gem 'sqlite3', '~> 1.4'
+# FIXME: https://github.com/rspec/rspec-rails/issues/2177
+gem 'rspec-rails', '~> 4.0.0.beta2'
+
+gemspec :path => '../'

data/influxdb-rails.gemspec

@@ -4,30 +4,40 @@ require "influxdb/rails/version"
 
 Gem::Specification.new do |spec|
   spec.name        = "influxdb-rails"
-  spec.version     = InfluxDB::Rails::VERSION
-  spec.authors     = ["Dominik Menke", "Todd Persen"]
-  spec.email       = ["dominik.menke@gmail.com", "todd@influxdb.com"]
-  spec.homepage    = "https://influxdata.com"
   spec.summary     = "InfluxDB bindings for Ruby on Rails."
-  spec.description = "This gem automatically instruments your Ruby on Rails" \
-                     " 4.2/5.x applications using InfluxDB for storage."
+  spec.description = "This gem instruments your Ruby on Rails application using InfluxDB."
+  spec.version     = InfluxDB::Rails::VERSION
+  spec.authors     = ["Christian Bruckmayer", "Henne Vogelsang"]
+  spec.email       = ["christian@bruckmayer.net", "hvogel@hennevogel.de"]
   spec.licenses    = ["MIT"]
+  spec.homepage    = "https://influxdata.com"
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/influxdata/influxdb-rails/issues",
+    "changelog_uri"     => "https://github.com/influxdata/influxdb-rails/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/influxdata/influxdb-rails/blob/master/README.md",
+    "source_code_uri"   => "https://github.com/influxdata/influxdb-rails",
+  }
 
   spec.files         = `git ls-files`.split($/) # rubocop:disable Style/SpecialGlobalVars
   spec.test_files    = spec.files.grep(%r{^(test|spec|features|smoke)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_runtime_dependency "influxdb", "~> 0.5.0"
-  spec.add_runtime_dependency "railties", "> 3"
+  spec.add_runtime_dependency "influxdb", "~> 0.6", ">= 0.6.4"
+  spec.add_runtime_dependency "railties", ">= 5.0"
 
+  spec.add_development_dependency "activejob"
+  spec.add_development_dependency "activerecord"
   spec.add_development_dependency "bundler", ">= 1.0.0"
   spec.add_development_dependency "fakeweb"
+  spec.add_development_dependency "launchy"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rdoc"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-rails", ">= 3.0.0"
-  spec.add_development_dependency "rubocop", "~> 0.60.0"
+  spec.add_development_dependency "rubocop", "~> 0.61.1"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "tzinfo"
 end

data/lib/influxdb-rails.rb

@@ -2,12 +2,16 @@ require "net/http"
 require "net/https"
 require "rubygems"
 require "socket"
+require "influxdb/rails/middleware/block_instrumentation_subscriber"
+require "influxdb/rails/middleware/render_subscriber"
+require "influxdb/rails/middleware/request_subscriber"
+require "influxdb/rails/middleware/sql_subscriber"
+require "influxdb/rails/middleware/active_record_subscriber"
+require "influxdb/rails/middleware/active_job_subscriber"
+require "influxdb/rails/sql/query"
 require "influxdb/rails/version"
-require "influxdb/rails/logger"
-require "influxdb/rails/exception_presenter"
 require "influxdb/rails/configuration"
-require "influxdb/rails/backtrace"
-require "influxdb/rails/rack"
+require "influxdb/rails/context"
 
 require "influxdb/rails/railtie" if defined?(Rails::Railtie)
 
@@ -16,140 +20,53 @@ module InfluxDB
   # InfluxDB and Rails. This is a singleton class.
   module Rails
     class << self
-      include InfluxDB::Rails::Logger
-
       attr_writer :configuration
       attr_writer :client
 
-      def configure(_silent = false)
-        yield(configuration)
-
-        # if we change configuration, reload the client
-        self.client = nil
+      def configure
+        return configuration unless block_given?
 
-        InfluxDB::Logging.logger = configuration.logger unless configuration.logger.nil?
+        yield configuration
+        self.client = nil # if we change configuration, reload the client
       end
 
       # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/AbcSize
 
       def client
-        @client ||= InfluxDB::Client.new \
-          database:       configuration.influxdb_database,
-          username:       configuration.influxdb_username,
-          password:       configuration.influxdb_password,
-          hosts:          configuration.influxdb_hosts,
-          port:           configuration.influxdb_port,
-          async:          configuration.async,
-          use_ssl:        configuration.use_ssl,
-          retry:          configuration.retry,
-          open_timeout:   configuration.open_timeout,
-          read_timeout:   configuration.read_timeout,
-          max_delay:      configuration.max_delay,
-          time_precision: configuration.time_precision
+        @client ||= begin
+          cfg = configuration.client
+          InfluxDB::Client.new \
+            database:       cfg.database,
+            username:       cfg.username,
+            password:       cfg.password,
+            auth_method:    cfg.auth_method,
+            hosts:          cfg.hosts,
+            port:           cfg.port,
+            async:          cfg.async,
+            use_ssl:        cfg.use_ssl,
+            retry:          cfg.retry,
+            open_timeout:   cfg.open_timeout,
+            read_timeout:   cfg.read_timeout,
+            max_delay:      cfg.max_delay,
+            time_precision: cfg.time_precision
+        end
       end
 
       # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
       def configuration
         @configuration ||= InfluxDB::Rails::Configuration.new
       end
 
-      def report_exception_unless_ignorable(ex, env = {})
-        report_exception(ex, env) unless ignorable_exception?(ex)
-      end
-      alias transmit_unless_ignorable report_exception_unless_ignorable
-
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/AbcSize
-
-      def report_exception(ex, env = {})
-        timestamp = InfluxDB::Rails.current_timestamp
-        env = influxdb_request_data if env.empty? && defined? influxdb_request_data
-        exception_presenter = ExceptionPresenter.new(ex, env)
-        log :info, "Exception: #{exception_presenter.to_json[0..512]}..."
-
-        client.write_point \
-          configuration.series_name_for_exceptions,
-          values:    exception_presenter.values.merge(ts: timestamp),
-          tags:      exception_presenter.context.merge(exception_presenter.dimensions),
-          timestamp: timestamp
-      rescue StandardError => ex
-        log :info, "[InfluxDB::Rails] Something went terribly wrong." \
-          " Exception failed to take off! #{ex.class}: #{ex.message}"
-      end
-      alias transmit report_exception
-
-      def handle_action_controller_metrics(_name, start, finish, _id, payload)
-        tags = {
-          method:      "#{payload[:controller]}##{payload[:action]}",
-          status:      payload[:status],
-          format:      payload[:format],
-          http_method: payload[:method],
-          path:        payload[:path],
-          server:      Socket.gethostname,
-          app_name:    configuration.application_name,
-        }.reject { |_, value| value.nil? }
-
-        ts = convert_timestamp(finish.utc)
-
-        begin
-          {
-            configuration.series_name_for_controller_runtimes => ((finish - start) * 1000).ceil,
-            configuration.series_name_for_view_runtimes       => (payload[:view_runtime] || 0).ceil,
-            configuration.series_name_for_db_runtimes         => (payload[:db_runtime] || 0).ceil,
-          }.each do |series_name, value|
-            client.write_point series_name, values: { value: value }, tags: tags, timestamp: ts
-          end
-        rescue StandardError => e
-          log :error, "[InfluxDB::Rails] Unable to write points: #{e.message}"
-        end
+      def current
+        @current ||= InfluxDB::Rails::Context.new
       end
 
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-
-      TIMESTAMP_CONVERSIONS = {
-        "ns" => 1e9.to_r,
-        nil  => 1e9.to_r,
-        "u"  => 1e6.to_r,
-        "ms" => 1e3.to_r,
-        "s"  => 1.to_r,
-        "m"  => 1.to_r / 60,
-        "h"  => 1.to_r / 60 / 60,
-      }.freeze
-      private_constant :TIMESTAMP_CONVERSIONS
-
-      def convert_timestamp(time)
-        conv = TIMESTAMP_CONVERSIONS.fetch(configuration.time_precision) do
-          raise "Invalid time precision: #{configuration.time_precision}"
+      def instrument(name, options = {})
+        ActiveSupport::Notifications.instrument "block_instrumentation.influxdb_rails",
+                                                **options.merge(name: name) do
+          yield if block_given?
         end
-
-        (time.to_r * conv).to_i
-      end
-
-      def current_timestamp
-        convert_timestamp(Time.now.utc)
-      end
-
-      def ignorable_exception?(ex)
-        configuration.ignore_current_environment? || configuration.ignore_exception?(ex)
-      end
-
-      def rescue
-        yield
-      rescue StandardError => ex
-        raise ex if configuration.ignore_current_environment?
-
-        transmit_unless_ignorable(ex)
-      end
-
-      def rescue_and_reraise
-        yield
-      rescue StandardError => ex
-        transmit_unless_ignorable(ex)
-        raise ex
       end
     end
   end

data/lib/influxdb/rails/configuration.rb

@@ -1,196 +1,116 @@
+require "active_support/concern"
+
 module InfluxDB
   module Rails
-    # rubocop:disable Metrics/ClassLength
-
-    class Configuration # rubocop:disable Style/Documentation
-      attr_accessor :influxdb_hosts
-      attr_accessor :influxdb_port
-      attr_accessor :influxdb_username
-      attr_accessor :influxdb_password
-      attr_accessor :influxdb_database
-      attr_accessor :async
-      attr_accessor :use_ssl
-      attr_accessor :retry
-      attr_accessor :open_timeout
-      attr_accessor :read_timeout
-      attr_accessor :max_delay
-      attr_accessor :time_precision
-
-      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 :rails_app_name
-
-      attr_accessor :application_name
-      attr_accessor :application_root
-
-      attr_accessor :logger
-      attr_accessor :environment
-      attr_accessor :framework
-      attr_accessor :framework_version
-      attr_accessor :language
-      attr_accessor :language_version
-      attr_accessor :ignored_exceptions
-      attr_accessor :ignored_exception_messages
-      attr_accessor :ignored_reports
-      attr_accessor :ignored_environments
-      attr_accessor :ignored_user_agents
-      attr_accessor :backtrace_filters
-      attr_accessor :aggregated_exception_classes
-      attr_accessor :environment_variables
-      attr_accessor :environment_variable_filters
-
-      attr_accessor :instrumentation_enabled
-      attr_accessor :debug
-
-      DEFAULTS = {
-        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,
-        ].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|
-            if defined?(Gem) && !Gem.path.nil? && !Gem.path.empty?
-              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]
-        @influxdb_port      = DEFAULTS[:influxdb_port]
-        @influxdb_username  = DEFAULTS[:influxdb_username]
-        @influxdb_password  = DEFAULTS[:influxdb_password]
-        @influxdb_database  = DEFAULTS[:influxdb_database]
-        @async              = DEFAULTS[:async]
-        @use_ssl            = DEFAULTS[:use_ssl]
-        @retry              = DEFAULTS[:retry]
-        @open_timeout       = DEFAULTS[:open_timeout]
-        @read_timeout       = DEFAULTS[:read_timeout]
-        @max_delay          = DEFAULTS[:max_delay]
-        @time_precision     = DEFAULTS[:time_precision]
-
-        @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
-        @ignored_reports              = DEFAULTS[:ignored_reports].dup
-        @ignored_environments         = DEFAULTS[:ignored_environments].dup
-        @ignored_user_agents          = DEFAULTS[:ignored_user_agents].dup
-        @backtrace_filters            = DEFAULTS[:backtrace_filters].dup
-        @environment_variable_filters = DEFAULTS[:environment_variable_filters]
-        @aggregated_exception_classes = []
-
-        @debug                    = false
-        @rescue_global_exceptions = false
-        @instrumentation_enabled  = true
+    module Configurable
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def defaults
+          @defaults ||= {}
+        end
+
+        def set_defaults(**values) # rubocop:disable Naming/AccessorMethodName:
+          defaults.merge! values
+          attr_accessor(*defaults.keys)
+        end
       end
 
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-
-      def debug?
-        !!@debug # rubocop:disable Style/DoubleNegation
+      def load_defaults
+        self.class.defaults.each do |key, value|
+          val = value.dup rescue value
+          public_send "#{key}=", val
+        end
       end
+    end
+    private_constant :Configurable
+
+    class ClientConfig
+      include Configurable
+
+      set_defaults(
+        hosts:          ["localhost"].freeze,
+        port:           8086,
+        username:       "root".freeze,
+        password:       "root".freeze,
+        database:       nil,
+        auth_method:    "params".freeze,
+        async:          true,
+        use_ssl:        false,
+        retry:          nil,
+        open_timeout:   5,
+        read_timeout:   300,
+        max_delay:      30,
+        time_precision: "s".freeze
+      )
 
-      def instrumentation_enabled?
-        !!@instrumentation_enabled # rubocop:disable Style/DoubleNegation
+      def initialize
+        load_defaults
       end
+    end
+    private_constant :ClientConfig
+
+    class Configuration
+      include Configurable
+
+      set_defaults(
+        measurement_name:     "rails".freeze,
+        ignored_hooks:        [].freeze,
+        tags_middleware:      ->(tags) { tags },
+        rails_app_name:       nil,
+        ignored_environments: %w[test cucumber selenium].freeze,
+        environment:          ::Rails.env,
+        debug:                false
+      )
+
+      # config option set after_initialize
+      attr_accessor(:environment, :application_name)
+
+      # configuration passed to InfluxDB::Client
+      attr_reader :client
+
+      # FIXME: Old configuration options, remove this in 1.0.1
+      attr_writer \
+        :series_name_for_controller_runtimes,
+        :series_name_for_view_runtimes,
+        :series_name_for_db_runtimes,
+        :series_name_for_render_template,
+        :series_name_for_render_partial,
+        :series_name_for_render_collection,
+        :series_name_for_sql,
+        :series_name_for_exceptions,
+        :series_name_for_instrumentation,
+        :ignored_exceptions,
+        :ignored_exception_messages,
+        :ignored_user_agents,
+        :application_root,
+        :environment_variable_filters,
+        :backtrace_filters,
+        :influxdb_database,
+        :influxdb_username,
+        :influxdb_password,
+        :influxdb_hosts,
+        :influxdb_port,
+        :async,
+        :use_ssl,
+        :retry,
+        :open_timeout,
+        :read_timeout,
+        :max_delay,
+        :time_precision
 
-      def ignore_user_agent?(incoming_user_agent)
-        return false if ignored_user_agents.nil?
+      def initialize
+        @client = ClientConfig.new
+        load_defaults
+      end
 
-        ignored_user_agents.any? { |agent| incoming_user_agent =~ /#{agent}/ }
+      def debug?
+        @debug
       end
 
       def ignore_current_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)
-        @custom_exception_data_handler = block
-      end
-
-      def add_custom_exception_data(exception_presenter)
-        @custom_exception_data_handler&.call(exception_presenter)
-      end
-
-      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
-
-      private
-
-      def initialize_http_connection
-        Net::HTTP.new(@app_host, "80")
-      end
     end
-
-    # rubocop:enable Metrics/ClassLength
   end
 end