influxdb-rails 1.0.0.beta4 → 1.0.1

data/spec/requests/block_inistrumentation_spec.rb

@@ -0,0 +1,64 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+RSpec.describe "BlockInstrumentation 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(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(
+        location:        "MetricsController#index",
+        hook:            "block_instrumentation",
+        additional_tag:  :value,
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware,
+        block_tag:       :block_tag,
+        name:            "name"
+      ),
+      values: a_hash_including(
+        additional_value: :value,
+        request_id:       :request_id,
+        block_value:      :block_value,
+        value:            be_between(1, 500)
+      )
+    )
+  end
+
+  it "includes correct timestamps" do
+    travel_to Time.zone.local(2018, 1, 1, 9, 0, 0)
+
+    get "/metrics"
+
+    expect_metric(
+      tags:      a_hash_including(
+        location: "MetricsController#index",
+        hook:     "block_instrumentation"
+      ),
+      timestamp: 1_514_797_200
+    )
+  end
+
+  it "does not write metric when hook is ignored" do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_hooks).and_return(["block_instrumentation.influxdb_rails"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "block_instrumentation"
+      )
+    )
+  end
+end

data/spec/requests/context_spec.rb

@@ -0,0 +1,27 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+RSpec.describe "Context", type: :request do
+  it "resets the context after a request" do
+    get "/metrics"
+
+    expect_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "sql"
+      )
+    )
+
+    expect(InfluxDB::Rails.current.tags).to be_empty
+    expect(InfluxDB::Rails.current.values).to be_empty
+  end
+
+  it "resets the context after a request when exceptioni occurs" do
+    setup_broken_client
+
+    get "/metrics"
+
+    expect_no_metric(hook: "process_action")
+    expect(InfluxDB::Rails.current.tags).to be_empty
+    expect(InfluxDB::Rails.current.values).to be_empty
+  end
+end

data/spec/requests/logger_spec.rb

@@ -0,0 +1,10 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+RSpec.describe "Logger", type: :request do
+  it "logs exception" do
+    setup_broken_client
+    expect(Rails.logger).to receive(:error).with(/message/).at_least(:once)
+
+    get "/metrics"
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+require "active_support"
+require_relative "../lib/influxdb/rails/helpers/rspec_matchers"
+require File.expand_path("#{File.dirname(__FILE__)}/support/broken_client")
+
 ENV["RAILS_ENV"] ||= "test"
 
 require "rails"
@@ -25,9 +29,13 @@ RSpec.configure do |config|
   # use expect syntax
   config.disable_monkey_patching!
 
-  # reset configuration for each spec
-  config.before :each do
-    InfluxDB::Rails.instance_variable_set :@configuration, nil
-    InfluxDB::Rails.configure
+  config.after(:each) do
+    travel_back
   end
+
+  config.include ActiveSupport::Testing::TimeHelpers
+  config.include ActiveSupport::Testing::Assertions
+  config.include ActiveJob::TestHelper
+
+  config.include InfluxDB::Rails::BrokenClient
 end

data/spec/support/broken_client.rb

@@ -0,0 +1,11 @@
+module InfluxDB
+  module Rails
+    module BrokenClient
+      def setup_broken_client
+        client = double
+        allow(client).to receive(:write_point).and_raise("message")
+        allow(InfluxDB::Rails).to receive(:client).and_return(client)
+      end
+    end
+  end
+end

data/spec/support/rails5/app.rb

@@ -1,5 +1,7 @@
 require "action_controller/railtie"
-require "active_record"
+require "active_record/railtie"
+require "active_job"
+require "action_mailer"
 
 app = Class.new(Rails::Application)
 app.config.secret_key_base = "1234567890abcdef1234567890abcdef"
@@ -9,38 +11,71 @@ app.config.active_support.deprecation = :log
 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
-  resources :widgets
+  resources :metrics, only: %i[index show]
+  resources :exceptions, only: :index
 end
 
-InfluxDB::Rails.configure do |config|
-end
-
-ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ENV["DATABASE_URL"] = "sqlite3::memory:"
 ActiveRecord::Schema.define do
-  create_table :widgets, force: true do |t|
-    t.string :title
+  create_table :metrics, force: true do |t|
+    t.string :name
 
     t.timestamps
   end
 end
 
-class Widget < ActiveRecord::Base; end
+class MetricJob < ActiveJob::Base
+  queue_as :default
+
+  def perform
+    # Do something later
+  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 WidgetsController < ApplicationController
+
+class MetricsController < ApplicationController
   prepend_view_path File.join(__dir__, "..", "views")
 
   before_action do
-    InfluxDB::Rails.current.values = { key: :value }
+    InfluxDB::Rails.current.values = { additional_value: :value }
+    InfluxDB::Rails.current.tags = { additional_tag: :value }
   end
 
   def index
-    Widget.create!(title: "test")
+    InfluxDB::Rails.instrument "name", tags: { block_tag: :block_tag }, values: { block_value: :block_value } do
+      1 + 1
+    end
+    MetricJob.perform_later
+    MetricMailer.with(user: "eisendieter").welcome_mail.deliver_now
+    Metric.create!(name: "name")
   end
 
-  def new
+  def show
+    @metric = Metric.find_by(name: "name")
+  end
+end
+
+class ExceptionsController < ApplicationController
+  def index
     1 / 0
   end
 end

data/spec/support/rails6/app.rb

@@ -0,0 +1,83 @@
+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"
+app.config.secret_token = "1234567890abcdef1234567890abcdef"
+app.config.session_store :cookie_store, key: "_myapp_session"
+app.config.active_support.deprecation = :log
+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
+  resources :metrics, only: %i[index show]
+  resources :exceptions, only: :index
+end
+
+ENV["DATABASE_URL"] = "sqlite3::memory:"
+ActiveRecord::Schema.define do
+  create_table :metrics, force: true do |t|
+    t.string :name
+
+    t.timestamps
+  end
+end
+
+class MetricJob < ActiveJob::Base
+  queue_as :default
+
+  def perform
+    # Do something later
+  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
+  prepend_view_path File.join(__dir__, "..", "views")
+
+  before_action do
+    InfluxDB::Rails.current.values = { additional_value: :value }
+    InfluxDB::Rails.current.tags = { additional_tag: :value }
+  end
+
+  def index
+    InfluxDB::Rails.instrument "name", tags: { block_tag: :block_tag }, values: { block_value: :block_value } do
+      1 + 1
+    end
+    MetricJob.perform_later
+    MetricMailer.with(user: "eisendieter").welcome_mail.deliver_now
+    Metric.create!(name: "name")
+  end
+
+  def show
+    @metric = Metric.find_by(name: "name")
+  end
+end
+
+class ExceptionsController < ApplicationController
+  def index
+    1 / 0
+  end
+end
+
+Object.const_set(:ApplicationHelper, Module.new)

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

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

data/spec/support/views/metrics/show.html.erb

@@ -0,0 +1,4 @@
+<h1>Show</h1>
+<div>
+  <%= @metric.name %>
+</div>

data/spec/unit/block_instrumentation_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails do
+  describe ".instrument" do
+    it "supports calling wihout a block" do
+      InfluxDB::Rails.instrument "name", values: { value: 1 }
+
+      expect_metric(
+        values: a_hash_including(value: 1),
+        tags:   a_hash_including(
+          hook:     "block_instrumentation",
+          server:   Socket.gethostname,
+          location: :raw
+        )
+      )
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.1
 platform: ruby
 authors:
 - Christian Bruckmayer
 - Henne Vogelsang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -37,14 +37,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        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
+    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: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +115,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -163,28 +205,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.1
+        version: 1.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.1
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -207,60 +249,88 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/spec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - config.ru
-- gemfiles/Gemfile.rails-4.2.x
-- gemfiles/Gemfile.rails-5.0.x
-- gemfiles/Gemfile.rails-5.1.x
 - gemfiles/Gemfile.rails-5.2.x
+- gemfiles/Gemfile.rails-6.0.x
+- gemfiles/Gemfile.rails-6.1.x
 - influxdb-rails.gemspec
 - lib/influxdb-rails.rb
 - lib/influxdb/rails/configuration.rb
 - lib/influxdb/rails/context.rb
-- lib/influxdb/rails/instrumentation.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
 - lib/influxdb/rails/middleware/render_subscriber.rb
 - lib/influxdb/rails/middleware/request_subscriber.rb
-- lib/influxdb/rails/middleware/simple_subscriber.rb
 - lib/influxdb/rails/middleware/sql_subscriber.rb
 - lib/influxdb/rails/middleware/subscriber.rb
 - lib/influxdb/rails/railtie.rb
 - lib/influxdb/rails/sql/normalizer.rb
 - lib/influxdb/rails/sql/query.rb
+- lib/influxdb/rails/tags.rb
+- lib/influxdb/rails/test_client.rb
+- lib/influxdb/rails/values.rb
 - lib/influxdb/rails/version.rb
 - lib/rails/generators/influxdb/influxdb_generator.rb
 - lib/rails/generators/influxdb/templates/initializer.rb
 - sample-dashboard/Dockerfile
 - sample-dashboard/README.md
 - sample-dashboard/Rakefile
-- sample-dashboard/Ruby On Rails Performance (per Request).json
+- sample-dashboard/Ruby On Rails ActiveJob.json
+- sample-dashboard/Ruby On Rails Performance per Action.json
+- sample-dashboard/Ruby On Rails Performance per Request.json
 - sample-dashboard/Ruby On Rails Performance.json
+- sample-dashboard/Ruby On Rails Requests.json
+- sample-dashboard/Ruby On Rails Slowlog by Action.json
+- sample-dashboard/Ruby On Rails Slowlog by Request.json
+- sample-dashboard/Ruby On Rails Slowlog by SQL.json
 - sample-dashboard/docker-compose.yml
+- sample-dashboard/provisioning/activejob.json
 - sample-dashboard/provisioning/grafana-dashboards.yml
 - sample-dashboard/provisioning/grafana-datasource.yml
+- sample-dashboard/provisioning/performance-action.json
 - sample-dashboard/provisioning/performance-request.json
 - sample-dashboard/provisioning/performance.json
-- spec/controllers/widgets_controller_spec.rb
-- spec/integration/integration_helper.rb
-- spec/integration/metrics_spec.rb
-- spec/shared_examples/data.rb
+- sample-dashboard/provisioning/requests.json
+- sample-dashboard/provisioning/slowlog-action.json
+- sample-dashboard/provisioning/slowlog-requests.json
+- sample-dashboard/provisioning/slowlog-sql.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
+- spec/requests/active_job_enqueue_metrics_spec.rb
+- spec/requests/active_job_perform_metrics_spec.rb
+- spec/requests/active_record_instantiation_metrics_spec.rb
+- spec/requests/active_record_sql_metrics_spec.rb
+- spec/requests/block_inistrumentation_spec.rb
+- spec/requests/context_spec.rb
+- spec/requests/logger_spec.rb
 - spec/spec_helper.rb
-- spec/support/rails4/app.rb
+- spec/support/broken_client.rb
 - spec/support/rails5/app.rb
-- spec/support/views/widgets/_item.html.erb
-- spec/support/views/widgets/index.html.erb
+- 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
+- spec/unit/block_instrumentation_spec.rb
 - spec/unit/configuration_spec.rb
-- spec/unit/context_spec.rb
-- spec/unit/middleware/render_subscriber_spec.rb
-- spec/unit/middleware/request_subscriber_spec.rb
-- spec/unit/middleware/sql_subscriber_spec.rb
 - spec/unit/sql/normalizer_spec.rb
 - spec/unit/sql/query_spec.rb
 homepage: https://influxdata.com
@@ -271,7 +341,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
@@ -279,31 +349,39 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: InfluxDB bindings for Ruby on Rails.
 test_files:
-- spec/controllers/widgets_controller_spec.rb
-- spec/integration/integration_helper.rb
-- spec/integration/metrics_spec.rb
-- spec/shared_examples/data.rb
+- 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
+- spec/requests/active_job_enqueue_metrics_spec.rb
+- spec/requests/active_job_perform_metrics_spec.rb
+- spec/requests/active_record_instantiation_metrics_spec.rb
+- spec/requests/active_record_sql_metrics_spec.rb
+- spec/requests/block_inistrumentation_spec.rb
+- spec/requests/context_spec.rb
+- spec/requests/logger_spec.rb
 - spec/spec_helper.rb
-- spec/support/rails4/app.rb
+- spec/support/broken_client.rb
 - spec/support/rails5/app.rb
-- spec/support/views/widgets/_item.html.erb
-- spec/support/views/widgets/index.html.erb
+- 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
+- spec/unit/block_instrumentation_spec.rb
 - spec/unit/configuration_spec.rb
-- spec/unit/context_spec.rb
-- spec/unit/middleware/render_subscriber_spec.rb
-- spec/unit/middleware/request_subscriber_spec.rb
-- spec/unit/middleware/sql_subscriber_spec.rb
 - spec/unit/sql/normalizer_spec.rb
 - spec/unit/sql/query_spec.rb