influxdb-rails 1.0.0.beta4 → 1.0.1

data/Rakefile

@@ -21,12 +21,6 @@ task default: %i[spec rubocop]
 
 task "test:all" => :default do
   Dir.glob("gemfiles/Gemfile.rails-*.x") do |gemfile|
-    if RUBY_VERSION >= "2.6.0" && gemfile == "gemfiles/Gemfile.rails-4.2.x"
-      msg = "ignore #{gemfile} on Ruby #{RUBY_VERSION}"
-      puts RSpec::Core::Formatters::ConsoleCodes.wrap(msg, :yellow)
-      next
-    end
-
     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")

data/gemfiles/Gemfile.rails-6.0.x

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem 'actionpack', '~> 6.0.0'
+gem 'activesupport', '~> 6.0.0'
+gem 'activemodel', '~> 6.0.0'
+gem 'sqlite3', '~> 1.4'
+gem 'rspec-rails'
+
+gemspec :path => '../'

data/gemfiles/Gemfile.rails-6.1.x

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem 'actionpack', '~> 6.1.0'
+gem 'activesupport', '~> 6.1.0'
+gem 'activemodel', '~> 6.1.0'
+gem 'sqlite3', '~> 1.4'
+gem 'rspec-rails'
+
+gemspec :path => '../'

data/influxdb-rails.gemspec

@@ -22,20 +22,23 @@ Gem::Specification.new do |spec|
   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.6", ">= 0.6.4"
-  spec.add_runtime_dependency "railties", ">= 4.2"
+  spec.add_runtime_dependency "railties", ">= 5.0"
 
+  spec.add_development_dependency "actionmailer"
+  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.61.1"
-  spec.add_development_dependency "sqlite3", "1.3.13"
+  spec.add_development_dependency "rubocop", "~> 1.9.0"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "tzinfo"
 end

data/lib/influxdb-rails.rb

@@ -2,9 +2,13 @@ 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/middleware/action_mailer_subscriber"
 require "influxdb/rails/sql/query"
 require "influxdb/rails/version"
 require "influxdb/rails/configuration"
@@ -17,8 +21,7 @@ module InfluxDB
   # InfluxDB and Rails. This is a singleton class.
   module Rails
     class << self
-      attr_writer :configuration
-      attr_writer :client
+      attr_writer :configuration, :client
 
       def configure
         return configuration unless block_given?
@@ -36,6 +39,7 @@ module InfluxDB
             database:       cfg.database,
             username:       cfg.username,
             password:       cfg.password,
+            auth_method:    cfg.auth_method,
             hosts:          cfg.hosts,
             port:           cfg.port,
             async:          cfg.async,
@@ -57,6 +61,13 @@ module InfluxDB
       def current
         @current ||= InfluxDB::Rails::Context.new
       end
+
+      def instrument(name, options = {})
+        ActiveSupport::Notifications.instrument "block_instrumentation.influxdb_rails",
+                                                **options.merge(name: name) do
+          yield if block_given?
+        end
+      end
     end
   end
 end

data/lib/influxdb/rails/configuration.rb

@@ -34,6 +34,7 @@ module InfluxDB
         username:       "root".freeze,
         password:       "root".freeze,
         database:       nil,
+        auth_method:    "params".freeze,
         async:          true,
         use_ssl:        false,
         retry:          nil,
@@ -53,14 +54,13 @@ module InfluxDB
       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,
-        instrumentation_enabled: true
+        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
@@ -83,8 +83,21 @@ module InfluxDB
         :ignored_exceptions,
         :ignored_exception_messages,
         :ignored_user_agents,
+        :application_root,
         :environment_variable_filters,
-        :backtrace_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 initialize
         @client = ClientConfig.new
@@ -95,10 +108,6 @@ module InfluxDB
         @debug
       end
 
-      def instrumentation_enabled?
-        @instrumentation_enabled
-      end
-
       def ignore_current_environment?
         ignored_environments.include?(environment)
       end

data/lib/influxdb/rails/context.rb

@@ -1,59 +1,25 @@
 module InfluxDB
   module Rails
     class Context
-      def controller
-        Thread.current[:_influxdb_rails_controller]
-      end
-
-      def controller=(value)
-        Thread.current[:_influxdb_rails_controller] = value
-      end
-
-      def action
-        Thread.current[:_influxdb_rails_action]
-      end
-
-      def action=(value)
-        Thread.current[:_influxdb_rails_action] = value
-      end
-
-      def request_id=(value)
-        Thread.current[:_influxdb_rails_request_id] = value
-      end
-
-      def request_id
-        Thread.current[:_influxdb_rails_request_id]
-      end
-
-      def location
-        [
-          controller,
-          action,
-        ].reject(&:blank?).join("#")
-      end
-
       def reset
-        Thread.current[:_influxdb_rails_controller] = nil
-        Thread.current[:_influxdb_rails_action] = nil
-        Thread.current[:_influxdb_rails_tags] = nil
-        Thread.current[:_influxdb_rails_values] = nil
-        Thread.current[:_influxdb_rails_request_id] = nil
+        Thread.current[:_influxdb_rails_tags] = {}
+        Thread.current[:_influxdb_rails_values] = {}
       end
 
       def tags
-        Thread.current[:_influxdb_rails_tags] || {}
+        Thread.current[:_influxdb_rails_tags].to_h
       end
 
       def tags=(tags)
-        Thread.current[:_influxdb_rails_tags] = tags
+        Thread.current[:_influxdb_rails_tags] = self.tags.merge(tags)
       end
 
       def values
-        Thread.current[:_influxdb_rails_values].to_h.merge(request_id: request_id)
+        Thread.current[:_influxdb_rails_values].to_h
       end
 
       def values=(values)
-        Thread.current[:_influxdb_rails_values] = values
+        Thread.current[:_influxdb_rails_values] = self.values.merge(values)
       end
     end
   end

data/lib/influxdb/rails/helpers/rspec_matchers.rb

@@ -0,0 +1,48 @@
+require_relative "../test_client"
+require "launchy"
+
+module InfluxDB
+  module Rails
+    module Matchers
+      def expect_metric(name: "rails", **options)
+        expect(metrics).to include(
+          a_hash_including(options.merge(name: name))
+        )
+      end
+
+      def expect_no_metric(name: "rails", **options)
+        expect(metrics).not_to include(
+          a_hash_including(options.merge(name: name))
+        )
+      end
+
+      def save_and_open_metrics
+        dir = File.join(File.dirname(__FILE__), "..", "..", "tmp")
+        FileUtils.mkdir_p(dir)
+        file_path = File.join(dir, "metrics.json")
+        output = JSON.pretty_generate(metrics)
+        File.write(file_path, output, mode: "wb")
+        ::Launchy.open(file_path)
+      end
+
+      def metrics
+        TestClient.metrics
+      end
+
+      RSpec.configure do |config|
+        config.before :each do
+          InfluxDB::Rails.instance_variable_set :@configuration, nil
+          InfluxDB::Rails.configure
+
+          allow(InfluxDB::Rails).to receive(:client).and_return(InfluxDB::Rails::TestClient.new)
+          allow_any_instance_of(InfluxDB::Rails::Configuration)
+            .to receive(:ignored_environments).and_return(%w[development])
+
+          InfluxDB::Rails::TestClient.metrics.clear
+        end
+
+        config.include InfluxDB::Rails::Matchers
+      end
+    end
+  end
+end

data/lib/influxdb/rails/metric.rb

@@ -0,0 +1,39 @@
+require "influxdb/rails/values"
+require "influxdb/rails/tags"
+
+module InfluxDB
+  module Rails
+    class Metric
+      def initialize(configuration:, timestamp:, tags: {}, values: {})
+        @configuration = configuration
+        @timestamp = timestamp
+        @tags = tags
+        @values = values
+      end
+
+      def write
+        client.write_point configuration.measurement_name, options
+      end
+
+      private
+
+      attr_reader :configuration, :tags, :values, :timestamp
+
+      def options
+        {
+          values:    Values.new(values: values).to_h,
+          tags:      Tags.new(tags: tags, config: configuration).to_h,
+          timestamp: timestamp_with_precision,
+        }
+      end
+
+      def timestamp_with_precision
+        InfluxDB.convert_timestamp(timestamp.utc, configuration.client.time_precision)
+      end
+
+      def client
+        InfluxDB::Rails.client
+      end
+    end
+  end
+end

data/lib/influxdb/rails/middleware/action_mailer_subscriber.rb

@@ -0,0 +1,22 @@
+require "influxdb/rails/middleware/subscriber"
+
+module InfluxDB
+  module Rails
+    module Middleware
+      class ActionMailerSubscriber < Subscriber # :nodoc:
+        private
+
+        def values
+          { value: 1 }
+        end
+
+        def tags
+          {
+            hook:   "deliver",
+            mailer: payload[:mailer],
+          }
+        end
+      end
+    end
+  end
+end

data/lib/influxdb/rails/middleware/active_job_subscriber.rb

@@ -0,0 +1,67 @@
+require "influxdb/rails/middleware/subscriber"
+
+module InfluxDB
+  module Rails
+    module Middleware
+      class ActiveJobSubscriber < Subscriber # :nodoc:
+        private
+
+        JOB_STATE = {
+          "enqueue"       => "queued",
+          "perform_start" => "running",
+          "perform"       => "succeeded",
+        }.freeze
+        private_constant :JOB_STATE
+
+        def values
+          {
+            value: value,
+          }
+        end
+
+        def tags
+          {
+            hook:  short_hook_name,
+            state: job_state,
+            job:   job.class.name,
+            queue: job.queue_name,
+          }
+        end
+
+        def job_state
+          return "failed" if failed?
+
+          JOB_STATE[short_hook_name]
+        end
+
+        def measure_performance?
+          short_hook_name == "perform"
+        end
+
+        def short_hook_name
+          @short_hook_name ||= fetch_short_hook_name
+        end
+
+        def fetch_short_hook_name
+          return "enqueue" if hook_name.include?("enqueue")
+
+          "perform"
+        end
+
+        def job
+          @job ||= payload[:job]
+        end
+
+        def value
+          return duration if measure_performance?
+
+          1
+        end
+
+        def failed?
+          payload[:aborted]
+        end
+      end
+    end
+  end
+end

data/lib/influxdb/rails/middleware/active_record_subscriber.rb

@@ -0,0 +1,26 @@
+require "influxdb/rails/middleware/subscriber"
+require "influxdb/rails/sql/query"
+
+module InfluxDB
+  module Rails
+    module Middleware
+      class ActiveRecordSubscriber < Subscriber # :nodoc:
+        private
+
+        def values
+          {
+            value:        duration,
+            record_count: payload[:record_count],
+          }
+        end
+
+        def tags
+          {
+            hook:       "instantiation",
+            class_name: payload[:class_name],
+          }
+        end
+      end
+    end
+  end
+end