influxdb-rails 1.0.0.beta3 → 1.0.0.beta4

data/spec/integration/metrics_spec.rb

@@ -1,27 +1,26 @@
 require File.expand_path(File.dirname(__FILE__) + "/integration_helper")
 
-RSpec.describe WidgetsController, type: :controller do
-  render_views
-
+RSpec.describe "User visits widgets", type: :request do
   before do
     allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_environments).and_return(%w[development])
   end
 
   describe "in a normal request" do
     it "should result in attempts to write metrics via the client" do
-      expect(InfluxDB::Rails.client).to receive(:write_point).exactly(6).times
-      get :index
+      expect(InfluxDB::Rails.client).to receive(:write_point).exactly(5).times
+      get "/widgets"
     end
 
-    context "with sql reports enabled" do
-      before do
-        allow_any_instance_of(InfluxDB::Rails::Middleware::SqlSubscriber).to receive(:series_name).and_return("rails.sql")
-        get :index # to not count ActiveRecord initialization
-      end
-
+    context "additional values" do
       it "should result in attempts to write metrics via the client" do
-        expect(InfluxDB::Rails.client).to receive(:write_point).exactly(7).times
-        get :index
+        allow_any_instance_of(ActionDispatch::Request).to receive(:request_id).and_return(:request_id)
+        expect(InfluxDB::Rails.client).to receive(:write_point).with(
+          "rails", a_hash_including(
+                     tags:   a_hash_including(method: "WidgetsController#index", hook: "process_action"),
+                     values: a_hash_including(request_id: :request_id, key: :value)
+                   )
+        )
+        get "/widgets"
       end
     end
   end

data/spec/shared_examples/data.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+RSpec.shared_examples_for "with additional data" do
+  context "values" do
+    let(:additional_values) do
+      { another: :value }
+    end
+
+    after do
+      InfluxDB::Rails.current.reset
+    end
+
+    it "does include the tags" do
+      InfluxDB::Rails.current.values = additional_values
+
+      expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(config.measurement_name, hash_including(values: hash_including(another: :value)))
+
+      subject.call("unused", start, finish, "unused", payload)
+    end
+  end
+
+  context "tags" do
+    context "when tags_middleware is overwritten" do
+      before do
+        allow(config).to receive(:tags_middleware).and_return(tags_middleware)
+      end
+
+      let(:tags_middleware) { ->(tags) { tags.merge(static: "value", nil: nil, empty: "") } }
+
+      it "processes tags throught the middleware" do
+        tags = data[:tags].merge(static: "value")
+
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(config.measurement_name, include(tags: tags))
+
+        subject.call("unused", start, finish, "unused", payload)
+      end
+    end
+
+    context "when tags are set in the current context" do
+      let(:input) do
+        { another: :value, nil: nil, empty: "" }
+      end
+      let(:output) do
+        { another: :value }
+      end
+
+      after do
+        InfluxDB::Rails.current.reset
+      end
+
+      it "does include the tags" do
+        InfluxDB::Rails.current.tags = input
+        tags = data[:tags].merge(output)
+
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(config.measurement_name, include(tags: tags))
+
+        subject.call("unused", start, finish, "unused", payload)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -19,6 +19,8 @@ puts "Loading Rails v#{Rails.version}..."
 require "support/rails#{Rails::VERSION::MAJOR}/app"
 require "rspec/rails"
 
+require "pry"
+
 RSpec.configure do |config|
   # use expect syntax
   config.disable_monkey_patching!
@@ -26,6 +28,6 @@ RSpec.configure do |config|
   # reset configuration for each spec
   config.before :each do
     InfluxDB::Rails.instance_variable_set :@configuration, nil
-    InfluxDB::Rails.configure(&:load_rails_defaults)
+    InfluxDB::Rails.configure
   end
 end

data/spec/support/rails4/app.rb

@@ -32,6 +32,10 @@ class ApplicationController < ActionController::Base; end
 class WidgetsController < ApplicationController
   prepend_view_path File.join(__dir__, "..", "views")
 
+  before_action do
+    InfluxDB::Rails.current.values = { key: :value }
+  end
+
   def index
     Widget.create!(title: "test")
   end

data/spec/support/rails5/app.rb

@@ -32,6 +32,10 @@ class ApplicationController < ActionController::Base; end
 class WidgetsController < ApplicationController
   prepend_view_path File.join(__dir__, "..", "views")
 
+  before_action do
+    InfluxDB::Rails.current.values = { key: :value }
+  end
+
   def index
     Widget.create!(title: "test")
   end

data/spec/unit/configuration_spec.rb

@@ -5,90 +5,72 @@ RSpec.describe InfluxDB::Rails::Configuration do
     @configuration = InfluxDB::Rails::Configuration.new
   end
 
-  describe "#ignore_user_agent?" do
-    it "should be true for user agents that have been set as ignorable" do
-      @configuration.ignored_user_agents = %w[Googlebot]
-      expect(@configuration.ignore_user_agent?("Googlebot/2.1")).to be_truthy
-    end
-
-    it "should be false for user agents that have not been set as ignorable" do
-      @configuration.ignored_user_agents = %w[Googlebot]
-      expect(@configuration.ignore_user_agent?("Mozilla/5.0")).to be_falsey
-    end
-
-    it "should be false if the ignored user agents list is empty" do
-      @configuration.ignored_user_agents = []
-      expect(@configuration.ignore_user_agent?("Googlebot/2.1")).to be_falsey
-    end
+  describe "client configuration" do
+    subject { InfluxDB::Rails.configuration.client }
 
-    it "should be false if the ignored user agents list is inadvertently set to nil" do
-      @configuration.ignored_user_agents = nil
-      expect(@configuration.ignore_user_agent?("Googlebot/2.1")).to be_falsey
-    end
-  end
-
-  describe "#retry" do
-    it "defaults to nil" do
-      expect(InfluxDB::Rails.configuration.retry).to be_nil
-    end
+    describe "#retry" do
+      it "defaults to nil" do
+        expect(subject.retry).to be_nil
+      end
 
-    it "can be updated" do
-      InfluxDB::Rails.configure do |config|
-        config.retry = 5
+      it "can be updated" do
+        InfluxDB::Rails.configure do |config|
+          config.client.retry = 5
+        end
+        expect(subject.retry).to eql(5)
       end
-      expect(InfluxDB::Rails.configuration.retry).to eql(5)
     end
-  end
 
-  describe "#open_timeout" do
-    it "defaults to 5" do
-      expect(InfluxDB::Rails.configuration.open_timeout).to eql(5)
-    end
+    describe "#open_timeout" do
+      it "defaults to 5" do
+        expect(subject.open_timeout).to eql(5)
+      end
 
-    it "can be updated" do
-      InfluxDB::Rails.configure do |config|
-        config.open_timeout = 5
+      it "can be updated" do
+        InfluxDB::Rails.configure do |config|
+          config.client.open_timeout = 5
+        end
+        expect(subject.open_timeout).to eql(5)
       end
-      expect(InfluxDB::Rails.configuration.open_timeout).to eql(5)
     end
-  end
 
-  describe "#read_timeout" do
-    it "defaults to 300" do
-      expect(InfluxDB::Rails.configuration.read_timeout).to eql(300)
-    end
+    describe "#read_timeout" do
+      it "defaults to 300" do
+        expect(subject.read_timeout).to eql(300)
+      end
 
-    it "can be updated" do
-      InfluxDB::Rails.configure do |config|
-        config.read_timeout = 5
+      it "can be updated" do
+        InfluxDB::Rails.configure do |config|
+          config.client.read_timeout = 5
+        end
+        expect(subject.read_timeout).to eql(5)
       end
-      expect(InfluxDB::Rails.configuration.read_timeout).to eql(5)
     end
-  end
 
-  describe "#max_delay" do
-    it "defaults to 30" do
-      expect(InfluxDB::Rails.configuration.max_delay).to eql(30)
-    end
+    describe "#max_delay" do
+      it "defaults to 30" do
+        expect(subject.max_delay).to eql(30)
+      end
 
-    it "can be updated" do
-      InfluxDB::Rails.configure do |config|
-        config.max_delay = 5
+      it "can be updated" do
+        InfluxDB::Rails.configure do |config|
+          config.client.max_delay = 5
+        end
+        expect(subject.max_delay).to eql(5)
       end
-      expect(InfluxDB::Rails.configuration.max_delay).to eql(5)
     end
-  end
 
-  describe "#time_precision" do
-    it "defaults to seconds" do
-      expect(InfluxDB::Rails.configuration.time_precision).to eql("s")
-    end
+    describe "#time_precision" do
+      it "defaults to seconds" do
+        expect(subject.time_precision).to eql("s")
+      end
 
-    it "can be updated" do
-      InfluxDB::Rails.configure do |config|
-        config.time_precision = "ms"
+      it "can be updated" do
+        InfluxDB::Rails.configure do |config|
+          config.client.time_precision = "ms"
+        end
+        expect(subject.time_precision).to eql("ms")
       end
-      expect(InfluxDB::Rails.configuration.time_precision).to eql("ms")
     end
   end
 

data/spec/unit/middleware/render_subscriber_spec.rb

@@ -1,5 +1,5 @@
 require "spec_helper"
-require "shared_examples/tags"
+require "shared_examples/data"
 
 RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
   let(:config) { InfluxDB::Rails::Configuration.new }
@@ -8,13 +8,13 @@ RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
   before do
     allow(config).to receive(:application_name).and_return("my-rails-app")
     allow(config).to receive(:ignored_environments).and_return([])
-    allow(config).to receive(:time_precision).and_return("ms")
+    allow(config.client).to receive(:time_precision).and_return("ms")
   end
 
   describe ".call" do
     let(:start)   { Time.at(1_517_567_368) }
     let(:finish)  { Time.at(1_517_567_370) }
-    let(:series_name) { "series_name" }
+    let(:hook_name) { "render_partial.action_view" }
     let(:payload) { { identifier: "index.html", count: 43, cache_hits: 42 } }
     let(:data) do
       {
@@ -26,12 +26,13 @@ RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
         tags:      {
           filename: "index.html",
           location: "Foo#bar",
+          hook:     "render_partial",
         },
         timestamp: 1_517_567_370_000
       }
     end
 
-    subject { described_class.new(config, series_name) }
+    subject { described_class.new(config, hook_name) }
 
     before do
       InfluxDB::Rails.current.controller = "Foo"
@@ -45,12 +46,12 @@ RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
     context "successfully" do
       it "writes to InfluxDB" do
         expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
-          series_name, data
+          config.measurement_name, data
         )
         subject.call("name", start, finish, "id", payload)
       end
 
-      it_behaves_like "with additional tags", ["series_name"]
+      it_behaves_like "with additional data"
 
       context "with an empty value" do
         before do
@@ -60,13 +61,17 @@ RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
 
         it "does not write empty value" do
           expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
-            series_name, data
+            config.measurement_name, data
           )
           subject.call("name", start, finish, "id", payload)
         end
       end
 
       context "disabled" do
+        before do
+          allow(config).to receive(:ignored_hooks).and_return(["render_partial.action_view"])
+        end
+
         subject { described_class.new(config, nil) }
 
         it "does not write a data point" do
@@ -78,13 +83,12 @@ RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
 
     context "unsuccessfully" do
       before do
-        allow(config).to receive(:logger).and_return(logger)
         InfluxDB::Rails.configuration = config
       end
 
       it "does log exceptions" do
         allow_any_instance_of(InfluxDB::Client).to receive(:write_point).and_raise("boom")
-        expect(logger).to receive(:error).with(/boom/)
+        expect(::Rails.logger).to receive(:error).with(/boom/)
         subject.call("name", start, finish, "id", payload)
       end
     end

data/spec/unit/middleware/request_subscriber_spec.rb

@@ -1,14 +1,15 @@
 require "spec_helper"
-require "shared_examples/tags"
+require "shared_examples/data"
 
 RSpec.describe InfluxDB::Rails::Middleware::RequestSubscriber do
   let(:config) { InfluxDB::Rails::Configuration.new }
 
   before do
-    allow(config).to receive(:time_precision).and_return("ms")
+    allow(config.client).to receive(:time_precision).and_return("ms")
+    allow(config).to receive(:environment).and_return("production")
   end
 
-  subject { described_class.new(config) }
+  subject { described_class.new(config, "process_action.action_controller") }
 
   describe "#call" do
     let(:start)   { Time.at(1_517_567_368) }
@@ -17,10 +18,12 @@ RSpec.describe InfluxDB::Rails::Middleware::RequestSubscriber do
     let(:data)    do
       {
         values:    {
-          value: 2
+          controller: 2,
+          started:    InfluxDB.convert_timestamp(start.utc, config.client.time_precision),
         },
         tags:      {
           method:      "MyController#show",
+          hook:        "process_action",
           status:      200,
           format:      "*/*",
           http_method: "GET",
@@ -38,52 +41,61 @@ RSpec.describe InfluxDB::Rails::Middleware::RequestSubscriber do
 
       it "sends metrics with taggings and timestamps" do
         expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
-          "rails.controller", data.merge(values: { value: 2000 })
+          config.measurement_name, data.deep_merge(values: { controller: 2000, db: 2, view: 2 })
         )
-        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with("rails.view", data)
-        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with("rails.db", data)
 
         subject.call("unused", start, finish, "unused", payload)
       end
 
-      it_behaves_like "with additional tags", ["rails.controller", "rails.view", "rails.db"]
+      it_behaves_like "with additional data", ["requests"]
     end
 
     context "application_name is nil" do
-      before do
-        allow(config).to receive(:application_name).and_return(nil)
-      end
-
-      it "does not add the app_name tag to metrics" do
-        tags = {
+      let(:tags) do
+        {
           method:      "MyController#show",
+          hook:        "process_action",
           status:      200,
           format:      "*/*",
           http_method: "GET",
           server:      Socket.gethostname,
         }
+      end
+
+      before do
+        allow(config).to receive(:application_name).and_return(nil)
+      end
 
+      it "does not add the app_name tag to metrics" do
         expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
-          "rails.controller", data.merge(values: { value: 2000 }, tags: tags)
+          config.measurement_name, data.merge(tags: tags).deep_merge(values: { controller: 2000, db: 2, view: 2 })
         )
-        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with("rails.view", data.merge(tags: tags))
-        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with("rails.db", data.merge(tags: tags))
 
         subject.call("unused", start, finish, "unused", payload)
       end
     end
 
     context "not successfull" do
-      let(:logger) { double(:logger) }
-
       before do
-        allow(config).to receive(:logger).and_return(logger)
         InfluxDB::Rails.configuration = config
       end
 
       it "does log an error" do
         allow_any_instance_of(InfluxDB::Client).to receive(:write_point).and_raise("boom")
-        expect(logger).to receive(:error).with(/boom/)
+        expect(::Rails.logger).to receive(:error).with(/boom/)
+        subject.call("name", start, finish, "id", payload)
+      end
+    end
+
+    context "disabled" do
+      before do
+        allow(config).to receive(:ignored_hooks).and_return(["process_action.action_controller"])
+      end
+
+      subject { described_class.new(config, "process_action.action_controller") }
+
+      it "does not write a data point" do
+        expect_any_instance_of(InfluxDB::Client).not_to receive(:write_point)
         subject.call("name", start, finish, "id", payload)
       end
     end

data/spec/unit/middleware/sql_subscriber_spec.rb

@@ -1,5 +1,5 @@
 require "spec_helper"
-require "shared_examples/tags"
+require "shared_examples/data"
 
 RSpec.describe InfluxDB::Rails::Middleware::SqlSubscriber do
   let(:config) { InfluxDB::Rails::Configuration.new }
@@ -8,13 +8,13 @@ RSpec.describe InfluxDB::Rails::Middleware::SqlSubscriber do
   before do
     allow(config).to receive(:application_name).and_return("my-rails-app")
     allow(config).to receive(:ignored_environments).and_return([])
-    allow(config).to receive(:time_precision).and_return("ms")
+    allow(config.client).to receive(:time_precision).and_return("ms")
   end
 
   describe ".call" do
     let(:start)   { Time.at(1_517_567_368) }
     let(:finish)  { Time.at(1_517_567_370) }
-    let(:series_name) { "rails.sql" }
+    let(:hook_name) { "sql.active_record" }
     let(:payload) { { sql: "SELECT * FROM POSTS WHERE id = 1", name: "Post Load", binds: %w[1 2 3] } }
     let(:data) do
       {
@@ -26,13 +26,14 @@ RSpec.describe InfluxDB::Rails::Middleware::SqlSubscriber do
           location:   "Foo#bar",
           operation:  "SELECT",
           class_name: "Post",
+          hook:       "sql",
           name:       "Post Load",
         },
         timestamp: 1_517_567_370_000
       }
     end
 
-    subject { described_class.new(config, series_name) }
+    subject { described_class.new(config, hook_name) }
 
     before do
       InfluxDB::Rails.current.controller = "Foo"
@@ -46,7 +47,7 @@ RSpec.describe InfluxDB::Rails::Middleware::SqlSubscriber do
     context "successfully" do
       it "writes to InfluxDB" do
         expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
-          series_name, data
+          config.measurement_name, data
         )
         subject.call("name", start, finish, "id", payload)
       end
@@ -62,18 +63,44 @@ RSpec.describe InfluxDB::Rails::Middleware::SqlSubscriber do
         end
       end
 
-      it_behaves_like "with additional tags", ["rails.sql"]
+      it_behaves_like "with additional data", ["sql"]
+
+      context "without location" do
+        before do
+          InfluxDB::Rails.current.reset
+        end
+
+        it "does use the default location" do
+          data[:tags] = data[:tags].merge(location: :raw)
+          expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
+            config.measurement_name, data
+          )
+          subject.call("name", start, finish, "id", payload)
+        end
+      end
     end
 
     context "unsuccessfully" do
       before do
-        allow(config).to receive(:logger).and_return(logger)
         InfluxDB::Rails.configuration = config
       end
 
       it "does log exceptions" do
         allow_any_instance_of(InfluxDB::Client).to receive(:write_point).and_raise("boom")
-        expect(logger).to receive(:error).with(/boom/)
+        expect(::Rails.logger).to receive(:error).with(/boom/)
+        subject.call("name", start, finish, "id", payload)
+      end
+    end
+
+    context "disabled" do
+      before do
+        allow(config).to receive(:ignored_hooks).and_return(["sql.active_record"])
+      end
+
+      subject { described_class.new(config, "sql.active_record") }
+
+      it "does not write a data point" do
+        expect_any_instance_of(InfluxDB::Client).not_to receive(:write_point)
         subject.call("name", start, finish, "id", payload)
       end
     end