influxdb-rails 1.0.1.beta1 → 1.0.1.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7bbb899eeb093fce13f1997b9f99eeb4451ca059676cd7b23e44fc29058769
-  data.tar.gz: c05d83cb5fbbb99b1b8a34794a174e1c4a1d6193d4aa2560fa3dba22fa665da1
+  metadata.gz: d47f714f971f95efc094148a585d056fe54cfa5847d30a2e18847ccc87a63f7b
+  data.tar.gz: 16c57b616923500e54755db3116560f7573837cc2c6c663ff1ecaf03b30bc16e
 SHA512:
-  metadata.gz: c1681dc59869917c09f4da05beaa880565814a263df81567c33af9ab6b5b529d49e8c7dbf666a9758e998adf08f2f521b2fa4734b80845381b3672c824040450
-  data.tar.gz: 420b905817df05e25cda3a22dfa05bf32118e94104915a3aba212dc56f39396f1ff1aadf3261a2018b650b56f1431140829b6142a7324022fea8542413872697
+  metadata.gz: 957abc17d22ddb564455fa17c3dbb927715dbf44b004bc53da1c71dc405d3d15ca0b9fa7804c7bd0d30e09f68d68bc7b82dcffea9e4c1dd8d07086065d0f6e8f
+  data.tar.gz: 6a8f535427d62b5b7db4830885a26fb8c4ed64ffce7d8b40d2cae618d130829bb6ee5cffcaad34a1443233e4fec5eca154638511b9adf1d96fb61b91c51dda33

data/.travis.yml

@@ -10,12 +10,9 @@ rvm:
   - "2.7"
   - "2.6"
   - "2.5"
-  - "2.4"
 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
 env:
   - TEST_TASK=spec
 matrix:
@@ -23,9 +20,6 @@ matrix:
     - rvm: ruby-head
   include:
     - { rvm: "2.6",   gemfile: "Gemfile", env: [TEST_TASK=rubocop] }
-  exclude:
-    # 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,12 @@
 
 For the full commit log, [see here](https://github.com/influxdata/influxdb-rails/commits/master).
 
+## 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

data/README.md

@@ -132,6 +132,53 @@ Reported tags:
   name:       "Post Load"
 ```
 
+### 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:
+
+```ruby
+  value: 89.467
+```
+
+Reported tags:
+
+```ruby
+  hook:       ["enqueue", "perform_start", "perform"],
+  state:      ["queued", "running", "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`.
+
+### 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

data/influxdb-rails.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "influxdb", "~> 0.6", ">= 0.6.4"
   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"

data/lib/influxdb-rails.rb

@@ -8,6 +8,7 @@ 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"

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/railtie.rb

@@ -34,6 +34,7 @@ module InfluxDB
           "enqueue.active_job"                   => Middleware::ActiveJobSubscriber,
           "perform_start.active_job"             => Middleware::ActiveJobSubscriber,
           "perform.active_job"                   => Middleware::ActiveJobSubscriber,
+          "deliver.action_mailer"                => Middleware::ActionMailerSubscriber,
           "block_instrumentation.influxdb_rails" => Middleware::BlockInstrumentationSubscriber,
         }.each do |hook_name, subscriber|
           ActiveSupport::Notifications.subscribe(hook_name, subscriber)

data/lib/influxdb/rails/version.rb

@@ -1,5 +1,5 @@
 module InfluxDB
   module Rails
-    VERSION = "1.0.1.beta1".freeze
+    VERSION = "1.0.1.beta2".freeze
   end
 end

data/spec/requests/action_mailer_deliver_metrics_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActionMailer deliver metrics", type: :request do
+  let(:tags_middleware) do
+    lambda do |tags|
+      tags.merge(tags_middleware: :tags_middleware)
+    end
+  end
+  before do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_environments).and_return(%w[development])
+    allow_any_instance_of(ActionDispatch::Request).to receive(:request_id).and_return(:request_id)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:application_name).and_return(:app_name)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:tags_middleware).and_return(tags_middleware)
+  end
+
+  it "writes metric" do
+    get "/metrics"
+
+    expect_metric(
+      tags:   a_hash_including(
+        hook:            "deliver",
+        mailer:          "MetricMailer",
+        location:        "MetricsController#index",
+        additional_tag:  :value,
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware
+      ),
+      values: a_hash_including(
+        additional_value: :value,
+        request_id:       :request_id,
+        value:            1
+      )
+    )
+  end
+
+  it "does not write metric when hook is ignored" do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_hooks).and_return(["deliver.action_mailer"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        hook:   "deliver",
+        mailer: "MetricMailer"
+      )
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -35,5 +35,6 @@ RSpec.configure do |config|
 
   config.include ActiveSupport::Testing::TimeHelpers
   config.include ActiveJob::TestHelper
+
   config.include InfluxDB::Rails::BrokenClient
 end

data/spec/support/rails5/app.rb

@@ -1,6 +1,7 @@
 require "action_controller/railtie"
 require "active_record/railtie"
 require "active_job"
+require "action_mailer"
 
 app = Class.new(Rails::Application)
 app.config.secret_key_base = "1234567890abcdef1234567890abcdef"
@@ -11,6 +12,7 @@ app.config.eager_load = false
 app.config.root = __dir__
 Rails.backtrace_cleaner.remove_silencers!
 ActiveJob::Base.logger = Rails.logger
+ActionMailer::Base.delivery_method = :test
 app.initialize!
 
 app.routes.draw do
@@ -38,6 +40,17 @@ class MetricJob < ActiveJob::Base
   end
 end
 
+class MetricMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+
+  def welcome_mail
+    mail(to: "eisendieter@werder.de", subject: "Welcome to metrics!") do |format|
+      format.text { render plain: "Hello Dieter!" }
+    end
+  end
+end
+
 class Metric < ActiveRecord::Base; end
 class ApplicationController < ActionController::Base; end
 class MetricsController < ApplicationController
@@ -53,6 +66,7 @@ class MetricsController < ApplicationController
       1 + 1
     end
     MetricJob.perform_later
+    MetricMailer.with(user: "eisendieter").welcome_mail.deliver_now
     Metric.create!(name: "name")
   end
 

data/spec/support/rails6/app.rb

@@ -1,6 +1,7 @@
 require "action_controller/railtie"
 require "active_record/railtie"
 require "active_job"
+require "action_mailer"
 
 app = Class.new(Rails::Application)
 app.config.secret_key_base = "1234567890abcdef1234567890abcdef"
@@ -11,6 +12,7 @@ app.config.eager_load = false
 app.config.root = __dir__
 Rails.backtrace_cleaner.remove_silencers!
 ActiveJob::Base.logger = Rails.logger
+ActionMailer::Base.delivery_method = :test
 app.initialize!
 
 app.routes.draw do
@@ -38,6 +40,17 @@ class MetricJob < ActiveJob::Base
   end
 end
 
+class MetricMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+
+  def welcome_mail
+    mail(to: "eisendieter@werder.de", subject: "Welcome to metrics!") do |format|
+      format.text { render plain: "Hello Dieter!" }
+    end
+  end
+end
+
 class Metric < ActiveRecord::Base; end
 class ApplicationController < ActionController::Base; end
 class MetricsController < ApplicationController
@@ -53,6 +66,7 @@ class MetricsController < ApplicationController
       1 + 1
     end
     MetricJob.perform_later
+    MetricMailer.with(user: "eisendieter").welcome_mail.deliver_now
     Metric.create!(name: "name")
   end
 

data/spec/support/views/layouts/mailer.txt.erb

@@ -0,0 +1 @@
+<%= yield %>

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1.beta1
+  version: 1.0.1.beta2
 platform: ruby
 authors:
 - Christian Bruckmayer
 - Henne Vogelsang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -45,6 +45,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
@@ -246,8 +260,6 @@ files:
 - README.md
 - Rakefile
 - config.ru
-- gemfiles/Gemfile.rails-5.0.x
-- gemfiles/Gemfile.rails-5.1.x
 - gemfiles/Gemfile.rails-5.2.x
 - gemfiles/Gemfile.rails-6.0.x
 - influxdb-rails.gemspec
@@ -256,6 +268,7 @@ files:
 - lib/influxdb/rails/context.rb
 - lib/influxdb/rails/helpers/rspec_matchers.rb
 - lib/influxdb/rails/metric.rb
+- lib/influxdb/rails/middleware/action_mailer_subscriber.rb
 - lib/influxdb/rails/middleware/active_job_subscriber.rb
 - lib/influxdb/rails/middleware/active_record_subscriber.rb
 - lib/influxdb/rails/middleware/block_instrumentation_subscriber.rb
@@ -285,6 +298,7 @@ files:
 - sample-dashboard/provisioning/performance-request.json
 - sample-dashboard/provisioning/performance.json
 - spec/requests/action_controller_metrics_spec.rb
+- spec/requests/action_mailer_deliver_metrics_spec.rb
 - spec/requests/action_view_collection_metrics_spec.rb
 - spec/requests/action_view_partial_metrics_spec.rb
 - spec/requests/action_view_template_metrics_spec.rb
@@ -300,6 +314,7 @@ files:
 - spec/support/broken_client.rb
 - spec/support/rails5/app.rb
 - spec/support/rails6/app.rb
+- spec/support/views/layouts/mailer.txt.erb
 - spec/support/views/metrics/_item.html.erb
 - spec/support/views/metrics/index.html.erb
 - spec/support/views/metrics/show.html.erb
@@ -315,7 +330,7 @@ metadata:
   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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -330,13 +345,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: InfluxDB bindings for Ruby on Rails.
 test_files:
 - spec/requests/action_controller_metrics_spec.rb
+- spec/requests/action_mailer_deliver_metrics_spec.rb
 - spec/requests/action_view_collection_metrics_spec.rb
 - spec/requests/action_view_partial_metrics_spec.rb
 - spec/requests/action_view_template_metrics_spec.rb
@@ -352,6 +368,7 @@ test_files:
 - spec/support/broken_client.rb
 - spec/support/rails5/app.rb
 - spec/support/rails6/app.rb
+- spec/support/views/layouts/mailer.txt.erb
 - spec/support/views/metrics/_item.html.erb
 - spec/support/views/metrics/index.html.erb
 - spec/support/views/metrics/show.html.erb

data/gemfiles/Gemfile.rails-5.0.x

@@ -1,9 +0,0 @@
-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-5.1.x

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gem 'actionpack', '~> 5.1.0'
-gem 'activesupport', '~> 5.1.0'
-gem 'activemodel', '~> 5.1.0'
-
-gemspec :path => '../'