influxdb-rails 1.0.1.beta2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d47f714f971f95efc094148a585d056fe54cfa5847d30a2e18847ccc87a63f7b
-  data.tar.gz: 16c57b616923500e54755db3116560f7573837cc2c6c663ff1ecaf03b30bc16e
+  metadata.gz: 613267c17473f3d84942b39e09a34d6e5797edf9bf3974426aea5d979016f5cb
+  data.tar.gz: afa98b412ac01fca796d23fcd80a838197c503cf76d2bfb5e921068d82db037d
 SHA512:
-  metadata.gz: 957abc17d22ddb564455fa17c3dbb927715dbf44b004bc53da1c71dc405d3d15ca0b9fa7804c7bd0d30e09f68d68bc7b82dcffea9e4c1dd8d07086065d0f6e8f
-  data.tar.gz: 6a8f535427d62b5b7db4830885a26fb8c4ed64ffce7d8b40d2cae618d130829bb6ee5cffcaad34a1443233e4fec5eca154638511b9adf1d96fb61b91c51dda33
+  metadata.gz: af5f5e21271757564eb91176ee0339e385a56dd130e1d6236d46d3515882d00a749f0c38d1e4920dfc6a24385d838ec8c91b1d8b084015f2394e9448a3282d44
+  data.tar.gz: c755671a0160554f0b0012ad32afca0f760f4f98ca49df0854584009fb90c43855e1ce9238189db88482bc2d2ccc00bb06d460e4972d60c75006791c406f4a4f

data/.github/workflows/rubocop.yml

@@ -0,0 +1,18 @@
+name: Rubocop
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle exec rake rubocop

data/.github/workflows/spec.yml

@@ -0,0 +1,32 @@
+name: Specs
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0', 'head' ]
+        rails: [ 'gemfiles/Gemfile.rails-6.1.x', 'gemfiles/Gemfile.rails-6.0.x', 'gemfiles/Gemfile.rails-5.2.x']
+        exclude:
+          - { ruby: '2.7', rails: 'gemfiles/Gemfile.rails-5.2.x' }
+          - { ruby: '3.0', rails: 'gemfiles/Gemfile.rails-5.2.x' }
+          - { ruby: 'head', rails: 'gemfiles/Gemfile.rails-5.2.x' }
+          - { ruby: '2.5', rails: 'gemfiles/Gemfile.rails-6.0.x' }
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.rails }}
+    name: Ruby ${{ matrix.ruby }} ${{ matrix.rails }} specs
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake spec

data/.rubocop.yml

@@ -11,10 +11,8 @@ AllCops:
   - 'vendor/bundle/**/*'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
-
-Rails:
-  Enabled: false
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
 Layout/EmptyLinesAroundArguments:
   Enabled: false
@@ -22,7 +20,7 @@ Layout/EmptyLinesAroundArguments:
 Layout/SpaceBeforeBlockBraces:
   EnforcedStyleForEmptyBraces: space
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
 
@@ -34,7 +32,7 @@ Metrics/BlockLength:
   - 'spec/**/*.rb'
   - 'influxdb-rails.gemspec'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
   Exclude:
   - 'spec/**/*.rb'
@@ -46,7 +44,7 @@ Metrics/ModuleLength:
 Metrics/ParameterLists:
   Max: 6
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames: [io, id, db, ex]
 
 Naming/FileName:
@@ -81,3 +79,34 @@ Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
   Exclude:
   - "spec/**/*.rb"
+
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true

data/CHANGELOG.md

@@ -1,14 +1,33 @@
 # Changelog
 
-For the full commit log, [see here](https://github.com/influxdata/influxdb-rails/commits/master).
+For the full commit log, [see here](https://github.com/influxdata/influxdb-rails/commits/one-stable).
+
+## v1.0.3, released 2021-09-15
+
+- In case of unhandled exceptions, set status in measurements like Rails.logger does
+- Require Ruby 2.5
+
+## v1.0.2, released 2021-04-13
+
+Fix passing booleans to custom tags.
+
+## v1.0.1, released 2021-03-23
+
+The final release, no code changes.
+
+## v1.0.1.beta3, released 2020-10-16
+
+- Drop `perform_start.active_job` subscriber, it's rather useless on dashboards.
 
 ## v1.0.1.beta2, released 2020-09-14
+
 - Implement [`deliver.action_mailer`](https://guides.rubyonrails.org/active_support_instrumentation.html#deliver-action-mailer) subscriber
 - Add missing Active Job documentation
 - Drop support for Ruby 2.4
 - Drop support for Rails < 5.2
 
 ## 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)
@@ -23,9 +42,11 @@ For the full commit log, [see here](https://github.com/influxdata/influxdb-rails
 - 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,16 +1,14 @@
 > :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)
+> See the latest [released version (1.0.1)](https://github.com/influxdata/influxdb-rails/tree/v1.0.1#readme)
 > instead.
 
 # influxdb-rails
 
 [![Gem Version](https://badge.fury.io/rb/influxdb-rails.svg)](https://badge.fury.io/rb/influxdb-rails)
-[![Build Status](https://travis-ci.org/influxdata/influxdb-rails.svg?branch=master)](https://travis-ci.org/influxdata/influxdb-rails)
+[![Build Status](https://github.com/influxdata/influxdb-rails/actions/workflows/spec.yml/badge.svg)](https://github.com/influxdata/influxdb-rails/actions)
 
-Automatically instrument your Ruby on Rails applications and write the
-metrics directly into [InfluxDB](http://influxdb.org/).
-
-This gem is designed for Rails 4.2+, Ruby 2.3+ and InfluxDB 0.9+.
+Automatically instrument your Ruby on Rails applications and write the metrics directly into
+[InfluxDB](https://www.influxdata.com/).
 
 ## Table of contents
 
@@ -41,8 +39,8 @@ configuration of this gem.
 
 ## Usage
 
-Out of the box, you'll automatically get reporting for sql, model, view and
-controller Rails instrumentation for every request.
+Out of the box, you'll automatically get reporting for the Ruby on Rails components mentioned
+below.
 
 ### Action Controller
 
@@ -55,9 +53,9 @@ Reported values:
 
 ```ruby
   controller: 48.467,
-  view: 46.848
+  view: 46.848,
   db: 0.157,
-  started: 1465839830100400200
+  started: 1465839830100400200,
   request_id: "d5bf620b-3494-425b-b7e1-4953597ea744"
 ```
 
@@ -71,14 +69,12 @@ Reported tags:
   method:      "PostsController#index",
   http_method: "GET",
   format:      "html",
-  status:      ["200", ""]
-  exception:   ["", "ArgumentError"]
+  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.
+*Note*: If an exception happens during that particular action the `status` will be blank and the tag `exception` will contain the name of the exception class. The status is blank because we can't know how you handle the exception outside the action.
 
 ### Action View
 
@@ -100,11 +96,11 @@ Reported values:
 Reported tags:
 
 ```ruby
-  hook:       ["render_template", "render_partial", "render_collection"]
+  hook:       ["render_template", "render_partial", "render_collection"],
   server:     Socket.gethostname,
   app_name:   configuration.application_name,
   location:   "PostsController#index",
-  filename:   "/some/file/action.html",
+  filename:   "/some/file/action.html"
 ```
 
 ### Active Record
@@ -112,15 +108,16 @@ Reported tags:
 Reported ActiveSupport instrumentation hooks:
 
 - [sql.active\_record](https://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record)
+- [instantiation.active\_record](https://guides.rubyonrails.org/active_support_instrumentation.html#instantiation-active-record)
 
-Reported values:
+Reported SQL values:
 
 ```ruby
   sql: "SELECT \"posts\".* FROM \"posts\"",
   request_id: "d5bf620b-3494-425b-b7e1-4953597ea744"
 ```
 
-Reported tags:
+Reported SQL tags:
 
 ```ruby
   hook:       "sql",
@@ -132,12 +129,29 @@ Reported tags:
   name:       "Post Load"
 ```
 
+Reported instantiation values:
+
+```ruby
+  record_count: 1,
+  request_id:   "d5bf620b-3494-425b-b7e1-4953597ea744"
+  value:        7.689
+```
+
+Reported instantiation tags:
+
+```ruby
+  hook:       "instantiation",
+  server:     Socket.gethostname,
+  app_name:   configuration.application_name,
+  location:   "PostsController#index",
+  class_name: "POST"
+```
+
 ### Active Job
 
 Reported ActiveSupport instrumentation hooks:
 
 - [enqueue.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-active-job)
-- [perform_start.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-start-active-job)
 - [perform.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)
 
 Reported values:
@@ -149,14 +163,14 @@ Reported values:
 Reported tags:
 
 ```ruby
-  hook:       ["enqueue", "perform_start", "perform"],
-  state:      ["queued", "running", "succeeded", "failed"],
+  hook:       ["enqueue", "perform"],
+  state:      ["queued", "succeeded", "failed"],
   job:        "SomeJobClassName",
   queue:      "queue_name"
 ```
 
 *Note*: Only the measurements with the hook `perform` report a duration in the value.
-The other hooks are counters and always report a value of `1`.
+The enqueue hook is a counter and always reports a value of `1`.
 
 ### Action Mailer
 
@@ -190,9 +204,7 @@ InfluxDB::Rails.configure do |config|
 end
 ```
 
-You'll find *most* of the configuration settings in the initializer file. The
-canonical list of default values is located in `lib/influxdb/rails/configuration.rb`
-(`InfluxDB::Rails::Configuration::DEFAULTS`).
+You'll find all of the configuration settings in the initializer file.
 
 ### Custom Tags
 
@@ -240,7 +252,7 @@ end
 Reported tags:
 
 ```ruby
-  hook:       "block_instrumentation"
+  hook:       "block_instrumentation",
   server:     Socket.gethostname,
   app_name:   configuration.application_name,
   location:   "PostsController#index",
@@ -249,7 +261,7 @@ Reported tags:
 
 Reported values:
 ```ruby
-  value: 100 # execution time of the block
+  value: 100 # execution time of the block in ms
 ```
 
 You can also overwrite the `value`
@@ -332,7 +344,7 @@ might cause performance issues on traffic intensive applications. Disable it in
 the configuration if you are not willing to tolerate this.
 
 By default, this gem performs writes to InfluxDB asynchronously. A single
-hooks usually only performs some time delta calculations, and then enqueues
+hook usually only performs some time delta calculations, and then enqueues
 the data point into a worker queue (which is processed by a background
 thread).
 
@@ -356,8 +368,7 @@ implications, depending on the value of `config.client.async`:
   cycle), it might block all available request threads
 
 In both cases, your application server might become unresponsive and needs
-to be restarted (which can happen automatically in `cgroups` contexts,
-like Docker containers).
+to be restarted.
 
 If you setup a maximum retry value (`Integer === config.client.retry`),
 the client will try up to that amount of times to send the data to the server
@@ -388,13 +399,11 @@ The data points are simply discarded.
     rake test:all
     ```
 
-  - or wait for [Travis][travis-pr] to pick up your changes, *after*
+  - or wait for [our CI](https://github.com/influxdata/influxdb-rails/actions) to pick up your changes, *after*
     you made a pull request.
 - Send a pull request.
 - If your changes are looking good, we'll merge them.
 
-[travis-pr]: https://travis-ci.org/influxdata/influxdb-rails/pull_requests
-
 ### Testing Tasks
 
 ```console

data/gemfiles/Gemfile.rails-6.0.x

@@ -4,7 +4,6 @@ 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'
+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,7 +22,7 @@ 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.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.add_runtime_dependency "influxdb", "~> 0.6", ">= 0.6.4"
   spec.add_runtime_dependency "railties", ">= 5.0"
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   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 "rubocop", "~> 1.9.0"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "tzinfo"
 end

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

@@ -6,6 +6,13 @@ module InfluxDB
       class ActiveJobSubscriber < Subscriber # :nodoc:
         private
 
+        JOB_STATE = {
+          "enqueue"       => "queued",
+          "perform_start" => "running",
+          "perform"       => "succeeded",
+        }.freeze
+        private_constant :JOB_STATE
+
         def values
           {
             value: value,
@@ -24,14 +31,7 @@ module InfluxDB
         def job_state
           return "failed" if failed?
 
-          case short_hook_name
-          when "enqueue"
-            "queued"
-          when "perform_start"
-            "running"
-          when "perform"
-            "succeeded"
-          end
+          JOB_STATE[short_hook_name]
         end
 
         def measure_performance?
@@ -44,8 +44,8 @@ module InfluxDB
 
         def fetch_short_hook_name
           return "enqueue" if hook_name.include?("enqueue")
-          return "perform_start" if hook_name.include?("perform_start")
-          return "perform" if hook_name.include?("perform")
+
+          "perform"
         end
 
         def job
@@ -59,7 +59,7 @@ module InfluxDB
         end
 
         def failed?
-          payload[:exception_object]
+          payload[:aborted]
         end
       end
     end