influxdb-rails 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63aa7cd5948c23cbde98aef16b1e6655e1e27e94211aa743626345e07d11db26
-  data.tar.gz: 64218acdb06b4e28749388c382fb41c7bf1375926d5f0e297740d2735e79530d
+  metadata.gz: bd28d1ed1a585a6ad1aef9945e693b2b1d20668de731e35ab0066c2c09ed50a5
+  data.tar.gz: df3e81593ce080e308018b2f94ea4ff4e3094f3584843051c60d6219ed9fe7aa
 SHA512:
-  metadata.gz: db7242ce0f9a22088340b3f8c708d41e3f60ee3d5e71215f9221e9036c08c8e813eaf75e41f28a1488561ea30a2ae173cbbf92426fcd6de40bdc102399a8e533
-  data.tar.gz: c1037d0c4df07bc0b4c4ddefab93919e1d2775eb0fea1fcff128c7975fdc6edff4a5d6f419159eb5737add1fc54f0902a9516004b5001d6cde4037979bb39ccb
+  metadata.gz: 8cbea1f68ee5ad8b68f9b8a4ee953999215bf62f6300aff3fb7b679f6d5fa797a49a2c28f9d0d2f0594f14cc15955d34291b6344371ad141d107d6dc8ff7a8c2
+  data.tar.gz: 6723fc68b1ba75a1efd39e820e9752e757bbb34007763b832ea565942716606a6ee388bfdb967dbabd4790eefb9b7414e6dc0697b7d6388454713b4b879700f6

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/.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/.gitignore

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

data/.rubocop.yml

@@ -11,10 +11,7 @@ AllCops:
   - 'vendor/bundle/**/*'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.3
-
-Rails:
-  Enabled: false
+  TargetRubyVersion: 2.4
 
 Layout/EmptyLinesAroundArguments:
   Enabled: false
@@ -22,7 +19,7 @@ Layout/EmptyLinesAroundArguments:
 Layout/SpaceBeforeBlockBraces:
   EnforcedStyleForEmptyBraces: space
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
 
@@ -34,7 +31,7 @@ Metrics/BlockLength:
   - 'spec/**/*.rb'
   - 'influxdb-rails.gemspec'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
   Exclude:
   - 'spec/**/*.rb'
@@ -46,7 +43,7 @@ Metrics/ModuleLength:
 Metrics/ParameterLists:
   Max: 6
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames: [io, id, db, ex]
 
 Naming/FileName:
@@ -81,3 +78,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,8 +1,47 @@
 # 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.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)
+- 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,17 +1,14 @@
-> 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.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
 
@@ -42,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
 
@@ -56,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"
 ```
 
@@ -72,10 +69,13 @@ Reported tags:
   method:      "PostsController#index",
   http_method: "GET",
   format:      "html",
-  status:      "200"
+  status:      ["200", ""],
+  exception:   "ArgumentError"
 }
 ```
 
+*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
 
 Reported ActiveSupport instrumentation hooks:
@@ -96,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
@@ -108,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",
@@ -128,6 +129,70 @@ 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.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)
+
+Reported values:
+
+```ruby
+  value: 89.467
+```
+
+Reported tags:
+
+```ruby
+  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 enqueue hook is a counter and always reports a value of `1`.
+
+### Action Mailer
+
+Reported ActiveSupport instrumentation hooks:
+
+- [deliver.action\_mailer](https://guides.rubyonrails.org/active_support_instrumentation.html#deliver-action-mailer)
+
+Reported values:
+
+```ruby
+  value: 1
+```
+
+Reported tags:
+
+```ruby
+  hook:               "deliver",
+  mailer:             "SomeMailerClassName"
+```
+
+*Note*: The hook is just a counter and always report a value of `1`.
+
 ## Configuration
 
 The only setting you actually need to configure is the name of the database
@@ -139,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
 
@@ -177,6 +240,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 in ms
+```
+
+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`
@@ -243,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).
 
@@ -267,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
@@ -299,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