influxdb-rails 1.0.0 → 1.0.1.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63aa7cd5948c23cbde98aef16b1e6655e1e27e94211aa743626345e07d11db26
-  data.tar.gz: 64218acdb06b4e28749388c382fb41c7bf1375926d5f0e297740d2735e79530d
+  metadata.gz: 0c7bbb899eeb093fce13f1997b9f99eeb4451ca059676cd7b23e44fc29058769
+  data.tar.gz: c05d83cb5fbbb99b1b8a34794a174e1c4a1d6193d4aa2560fa3dba22fa665da1
 SHA512:
-  metadata.gz: db7242ce0f9a22088340b3f8c708d41e3f60ee3d5e71215f9221e9036c08c8e813eaf75e41f28a1488561ea30a2ae173cbbf92426fcd6de40bdc102399a8e533
-  data.tar.gz: c1037d0c4df07bc0b4c4ddefab93919e1d2775eb0fea1fcff128c7975fdc6edff4a5d6f419159eb5737add1fc54f0902a9516004b5001d6cde4037979bb39ccb
+  metadata.gz: c1681dc59869917c09f4da05beaa880565814a263df81567c33af9ab6b5b529d49e8c7dbf666a9758e998adf08f2f521b2fa4734b80845381b3672c824040450
+  data.tar.gz: 420b905817df05e25cda3a22dfa05bf32118e94104915a3aba212dc56f39396f1ff1aadf3261a2018b650b56f1431140829b6142a7324022fea8542413872697

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # Enable version updates for bundler
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-type: "all"
+    labels:
+      - "dependencies"

data/.gitignore

@@ -8,3 +8,4 @@ pkg/*
 spec/support/rails*/log/*
 .ruby-*
 vendor/bundle
+tmp

data/.rubocop.yml

@@ -11,7 +11,7 @@ AllCops:
   - 'vendor/bundle/**/*'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Rails:
   Enabled: false

data/.travis.yml

@@ -7,15 +7,15 @@ before_install:
   - gem update bundler --no-doc
 rvm:
   - ruby-head
+  - "2.7"
   - "2.6"
   - "2.5"
   - "2.4"
-  - "2.3"
 gemfile:
+  - gemfiles/Gemfile.rails-6.0.x
   - gemfiles/Gemfile.rails-5.2.x
   - gemfiles/Gemfile.rails-5.1.x
   - gemfiles/Gemfile.rails-5.0.x
-  - gemfiles/Gemfile.rails-4.2.x
 env:
   - TEST_TASK=spec
 matrix:
@@ -24,11 +24,8 @@ matrix:
   include:
     - { rvm: "2.6",   gemfile: "Gemfile", env: [TEST_TASK=rubocop] }
   exclude:
-    # Rails < 5 not on MRI 2.4+
-    - { rvm: ruby-head, gemfile: "gemfiles/Gemfile.rails-4.2.x" }
-    - { rvm: "2.6",   gemfile: "gemfiles/Gemfile.rails-4.2.x" }
-    - { rvm: "2.5",   gemfile: "gemfiles/Gemfile.rails-4.2.x" }
-    - { rvm: "2.4",   gemfile: "gemfiles/Gemfile.rails-4.2.x" }
+    # Rails > 5 not on MRI 2.4+
+    - { rvm: "2.4",   gemfile: "gemfiles/Gemfile.rails-6.0.x" }
 addons:
   apt:
     packages:

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 For the full commit log, [see here](https://github.com/influxdata/influxdb-rails/commits/master).
 
+## v1.0.1.beta1, released 2020-08-21
+- Drop support for Ruby 2.3
+- Drop support for Rails 4.x
+- Add `auth_method` to client configuration (#96, @anlek)
+- Drop undocumented `instrumentation_enabled` setting, use
+  `ignored_environments` do disable instrumentation
+- Simplified spec with a PORO test client
+- Implement `instantiation.active_record` subscriber (https://guides.rubyonrails.org/active_support_instrumentation.html#instantiation-active-record)
+- Implement `enqueue.active_job` subscriber (https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-active-job)
+- Implement `perform_start.active_job` subscriber (https://guides.rubyonrails.org/active_support_instrumentation.html#perform-start-active-job)
+- Implement `perform.active_job` subscriber (https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)
+- Implement block instrumentation `InfluxDB::Rails.instrument do; 1 + 1; end`
+- Record unhandled exceptions as tags for process_action.action_controller
+
+## v1.0.0, released 2019-10-23
+The Final release, no code changes.
+
 ## v1.0.0.beta5, unreleased
 - Silently eat all dropped configuration options and do not crash
 - Add per action view to the sample dashboard

data/README.md

@@ -1,7 +1,6 @@
-> You are looking at the README for the master branch of this gem.
-> The latest released version lives in the stable-04 branch,
-> [see here](https://github.com/influxdata/influxdb-rails/tree/stable-04#readme)
-> for an online version.
+> :warning: You are looking at the README for the master branch of this gem.
+> See the latest [released version (1.0.0)](https://github.com/influxdata/influxdb-rails/tree/v1.0.0#readme)
+> instead.
 
 # influxdb-rails
 
@@ -72,10 +71,15 @@ Reported tags:
   method:      "PostsController#index",
   http_method: "GET",
   format:      "html",
-  status:      "200"
+  status:      ["200", ""]
+  exception:   ["", "ArgumentError"]
 }
 ```
 
+*Note*: If an exception happens during that particular instrumentation the
+`status` will be blank and the tag `exception` will contain the name of the
+exception class.
+
 ### Action View
 
 Reported ActiveSupport instrumentation hooks:
@@ -177,6 +181,44 @@ class ApplicationController
 end
 ```
 
+### Block Instrumentation
+If you want to add custom instrumentation, you can wrap any code into a block instrumentation
+
+```ruby
+InfluxDB::Rails.instrument "expensive_operation", tags: { }, values: { } do
+  expensive_operation
+end
+```
+
+Reported tags:
+
+```ruby
+  hook:       "block_instrumentation"
+  server:     Socket.gethostname,
+  app_name:   configuration.application_name,
+  location:   "PostsController#index",
+  name:       "expensive_operation"
+```
+
+Reported values:
+```ruby
+  value: 100 # execution time of the block
+```
+
+You can also overwrite the `value`
+
+```ruby
+InfluxDB::Rails.instrument "user_count", values: { value: 1 } do
+  User.create(name: 'mickey', surname: 'mouse')
+end
+```
+
+or call it even without a block
+
+```ruby
+InfluxDB::Rails.instrument "temperature", values: { value: 25 }
+```
+
 ### Custom client configuration
 
 The settings named `config.client.*` are used to construct an `InfluxDB::Client`

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-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

@@ -22,20 +22,22 @@ 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 "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 "sqlite3"
   spec.add_development_dependency "tzinfo"
 end

data/lib/influxdb-rails.rb

@@ -2,9 +2,12 @@ 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/configuration"
@@ -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
@@ -108,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