asklytics-influxdb-rails 1.0.0.beta3

data/spec/unit/context_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Context do
+  subject { described_class.new }
+
+  describe "#controller" do
+    it "does set and get" do
+      subject.controller = "Controller"
+      expect(subject.controller).to eq("Controller")
+    end
+  end
+
+  describe "#action" do
+    it "does get and set" do
+      subject.action = "action"
+      expect(subject.action).to eq("action")
+    end
+  end
+
+  describe "#location" do
+    before do
+      subject.controller = "Controller"
+      subject.action = "action"
+    end
+
+    it { expect(subject.location).to eq("Controller#action") }
+  end
+
+  describe "#reset" do
+    before do
+      subject.controller = "Controller"
+      subject.action = "action"
+    end
+
+    it "does reset the location" do
+      subject.reset
+      expect(subject.location).to be_empty
+    end
+  end
+end

data/spec/unit/exception_presenter_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::ExceptionPresenter do
+  before do
+    begin
+      1 / 0
+    rescue ZeroDivisionError => e
+      @exception = e
+    end
+  end
+
+  describe ".new" do
+    it "should create a new ExceptionPresenter" do
+      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
+      expect(exception_presenter).to be_a(InfluxDB::Rails::ExceptionPresenter)
+    end
+
+    it "should accept an exception as a parameter" do
+      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
+      expect(exception_presenter).not_to be_nil
+    end
+  end
+end

data/spec/unit/influxdb_rails_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails do
+  before do
+    InfluxDB::Rails.configure do |config|
+      config.application_name = "my-rails-app"
+      config.ignored_environments = []
+      config.time_precision = "ms"
+    end
+  end
+
+  describe ".current_timestamp" do
+    let(:timestamp) { 1_513_009_229_111 }
+
+    it "should return the current timestamp in the configured precision" do
+      expect(Process).to receive(:clock_gettime)
+        .with(Process::CLOCK_REALTIME, :millisecond)
+        .and_return(timestamp)
+
+      expect(InfluxDB::Rails.current_timestamp).to eq(timestamp)
+    end
+  end
+
+  describe ".ignorable_exception?" do
+    it "should be true for exception types specified in the configuration" do
+      class DummyException < RuntimeError; end
+      exception = DummyException.new
+
+      InfluxDB::Rails.configure do |config|
+        config.ignored_exceptions << "DummyException"
+      end
+
+      expect(InfluxDB::Rails.ignorable_exception?(exception)).to be_truthy
+    end
+
+    it "should be true for exception types specified in the configuration" do
+      exception = ActionController::RoutingError.new("foo")
+      expect(InfluxDB::Rails.ignorable_exception?(exception)).to be_truthy
+    end
+
+    it "should be false for valid exceptions" do
+      exception = ZeroDivisionError.new
+      expect(InfluxDB::Rails.ignorable_exception?(exception)).to be_falsey
+    end
+  end
+
+  describe "rescue" do
+    it "should transmit an exception when passed" do
+      expect(InfluxDB::Rails.client).to receive(:write_point)
+
+      InfluxDB::Rails.rescue do
+        raise ArgumentError, "wrong"
+      end
+    end
+
+    it "should also raise the exception when in an ignored environment" do
+      InfluxDB::Rails.configure do |config|
+        config.ignored_environments = %w[development test]
+      end
+
+      expect do
+        InfluxDB::Rails.rescue do
+          raise ArgumentError, "wrong"
+        end
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "rescue_and_reraise" do
+    it "should transmit an exception when passed" do
+      expect(InfluxDB::Rails.client).to receive(:write_point)
+
+      expect do
+        InfluxDB::Rails.rescue_and_reraise { raise ArgumentError, "wrong" }
+      end.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/unit/middleware/render_subscriber_spec.rb

@@ -0,0 +1,92 @@
+require "spec_helper"
+require "shared_examples/tags"
+
+RSpec.describe InfluxDB::Rails::Middleware::RenderSubscriber do
+  let(:config) { InfluxDB::Rails::Configuration.new }
+  let(:logger) { double(:logger) }
+
+  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")
+  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(:payload) { { identifier: "index.html", count: 43, cache_hits: 42 } }
+    let(:data) do
+      {
+        values:    {
+          value:      2000,
+          count:      43,
+          cache_hits: 42
+        },
+        tags:      {
+          filename: "index.html",
+          location: "Foo#bar",
+        },
+        timestamp: 1_517_567_370_000
+      }
+    end
+
+    subject { described_class.new(config, series_name) }
+
+    before do
+      InfluxDB::Rails.current.controller = "Foo"
+      InfluxDB::Rails.current.action = "bar"
+    end
+
+    after do
+      InfluxDB::Rails.current.reset
+    end
+
+    context "successfully" do
+      it "writes to InfluxDB" do
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
+          series_name, data
+        )
+        subject.call("name", start, finish, "id", payload)
+      end
+
+      it_behaves_like "with additional tags", ["series_name"]
+
+      context "with an empty value" do
+        before do
+          payload[:count] = nil
+          data[:values].delete(:count)
+        end
+
+        it "does not write empty value" do
+          expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
+            series_name, data
+          )
+          subject.call("name", start, finish, "id", payload)
+        end
+      end
+
+      context "disabled" do
+        subject { described_class.new(config, nil) }
+
+        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
+    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/)
+        subject.call("name", start, finish, "id", payload)
+      end
+    end
+  end
+end

data/spec/unit/middleware/request_subscriber_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+require "shared_examples/tags"
+
+RSpec.describe InfluxDB::Rails::Middleware::RequestSubscriber do
+  let(:config) { InfluxDB::Rails::Configuration.new }
+
+  before do
+    allow(config).to receive(:time_precision).and_return("ms")
+  end
+
+  subject { described_class.new(config) }
+
+  describe "#call" do
+    let(:start)   { Time.at(1_517_567_368) }
+    let(:finish)  { Time.at(1_517_567_370) }
+    let(:payload) { { view_runtime: 2, db_runtime: 2, controller: "MyController", action: "show", method: "GET", format: "*/*", status: 200 } }
+    let(:data)    do
+      {
+        values:    {
+          value: 2
+        },
+        tags:      {
+          method:      "MyController#show",
+          status:      200,
+          format:      "*/*",
+          http_method: "GET",
+          server:      Socket.gethostname,
+          app_name:    "my-rails-app",
+        },
+        timestamp: 1_517_567_370_000
+      }
+    end
+
+    context "application_name is set" do
+      before do
+        allow(config).to receive(:application_name).and_return("my-rails-app")
+      end
+
+      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 })
+        )
+        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"]
+    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 = {
+          method:      "MyController#show",
+          status:      200,
+          format:      "*/*",
+          http_method: "GET",
+          server:      Socket.gethostname,
+        }
+
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
+          "rails.controller", data.merge(values: { value: 2000 }, tags: tags)
+        )
+        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/)
+        subject.call("name", start, finish, "id", payload)
+      end
+    end
+  end
+end

data/spec/unit/middleware/sql_subscriber_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+require "shared_examples/tags"
+
+RSpec.describe InfluxDB::Rails::Middleware::SqlSubscriber do
+  let(:config) { InfluxDB::Rails::Configuration.new }
+  let(:logger) { double(:logger) }
+
+  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")
+  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(:payload) { { sql: "SELECT * FROM POSTS WHERE id = 1", name: "Post Load", binds: %w[1 2 3] } }
+    let(:data) do
+      {
+        values:    {
+          value: 2000,
+          sql:   "SELECT * FROM POSTS WHERE id = xxx"
+        },
+        tags:      {
+          location:   "Foo#bar",
+          operation:  "SELECT",
+          class_name: "Post",
+          name:       "Post Load",
+        },
+        timestamp: 1_517_567_370_000
+      }
+    end
+
+    subject { described_class.new(config, series_name) }
+
+    before do
+      InfluxDB::Rails.current.controller = "Foo"
+      InfluxDB::Rails.current.action = "bar"
+    end
+
+    after do
+      InfluxDB::Rails.current.reset
+    end
+
+    context "successfully" do
+      it "writes to InfluxDB" do
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(
+          series_name, data
+        )
+        subject.call("name", start, finish, "id", payload)
+      end
+
+      context "with not relevant queries" do
+        before do
+          payload[:sql] = "SHOW FULL FIELDS FROM `users`"
+        end
+
+        it "does not write to InfluxDB" do
+          expect_any_instance_of(InfluxDB::Client).not_to receive(:write_point)
+          subject.call("name", start, finish, "id", payload)
+        end
+      end
+
+      it_behaves_like "with additional tags", ["rails.sql"]
+    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/)
+        subject.call("name", start, finish, "id", payload)
+      end
+    end
+  end
+end

data/spec/unit/sql/normalizer_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Sql::Normalizer do
+  describe "#perform" do
+    it { expect(described_class.new("SELECT * FROM posts WHERE id = 1").perform).to eq("SELECT * FROM posts WHERE id = xxx") }
+    it { expect(described_class.new("SELECT * FROM posts WHERE id = 1".freeze).perform).to eq("SELECT * FROM posts WHERE id = xxx") }
+    it { expect(described_class.new("SELECT * FROM posts LIMIT 10").perform).to eq("SELECT * FROM posts LIMIT xxx") }
+    it { expect(described_class.new("SELECT * FROM posts OFFSET 10").perform).to eq("SELECT * FROM posts OFFSET xxx") }
+    it { expect(described_class.new("SELECT * FROM posts WHERE name LIKE '%foobar%'").perform).to eq("SELECT * FROM posts WHERE name LIKE xxx") }
+    it { expect(described_class.new("SELECT * FROM posts WHERE id IN (1,2,3)").perform).to eq("SELECT * FROM posts WHERE id IN (xxx)") }
+    it { expect(described_class.new("SELECT * FROM products WHERE price BETWEEN 10 AND 20").perform).to eq("SELECT * FROM products WHERE price BETWEEN xxx AND xxx") }
+    it { expect(described_class.new("INSERT INTO products (title, price) VALUES ('Computer', 100)").perform).to eq("INSERT INTO products (title, price) VALUES (xxx)") }
+    it { expect(described_class.new("   SELECT * FROM   POSTS    ").perform).to eq("SELECT * FROM POSTS") }
+  end
+end

data/spec/unit/sql/query_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Sql::Query do
+  let(:payload) do
+    {
+      sql:  "select * from users where user_id = 42;",
+      name: "User Load",
+    }
+  end
+  subject { described_class.new(payload) }
+
+  describe "#class_name" do
+    it { expect(subject.class_name).to eq("User") }
+  end
+
+  describe "#operation" do
+    it { expect(subject.operation).to eq("SELECT") }
+  end
+
+  describe "#track?" do
+    it { expect(described_class.new(sql: "INSERT").track?).to be true }
+    it { expect(described_class.new(sql: "UPDATE").track?).to be true }
+    it { expect(described_class.new(sql: "SELECT").track?).to be true }
+    it { expect(described_class.new(sql: "DELETE").track?).to be true }
+    it { expect(described_class.new(sql: "SCHEMA").track?).to be false }
+    it { expect(described_class.new(sql: "BEGIN").track?).to be false }
+    it { expect(described_class.new(sql: "SELECT", name: "SCHEMA").track?).to be false }
+  end
+end