experimental-influxdb-rails 1.0.0.beta5

data/spec/unit/middleware/request_subscriber_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+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")
+  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,
+          started: InfluxDB.convert_timestamp(start.utc, config.time_precision),
+        },
+        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.deep_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 data", ["rails.controller", "rails.view", "rails.db"]
+    end
+
+    context "application_name is nil" do
+      let(:tags) do
+        {
+          method:      "MyController#show",
+          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(tags: tags).deep_merge(values: { value: 2000 })
+        )
+        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,95 @@
+require "spec_helper"
+require "shared_examples/data"
+
+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 data", ["rails.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(
+            series_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/)
+        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

metadata

@@ -0,0 +1,300 @@
+--- !ruby/object:Gem::Specification
+name: experimental-influxdb-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta5
+platform: ruby
+authors:
+- Dominik Menke
+- Todd Persen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  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: rake
+  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: rdoc
+  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: rspec
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: tzinfo
+  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'
+description: This gem automatically instruments your Ruby on Rails 4.2/5.x applications
+  using InfluxDB for storage.
+email:
+- dominik.menke@gmail.com
+- todd@influxdb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- experimental-influxdb-rails.gemspec
+- gemfiles/Gemfile.rails-4.2.x
+- gemfiles/Gemfile.rails-5.0.x
+- gemfiles/Gemfile.rails-5.1.x
+- gemfiles/Gemfile.rails-5.2.x
+- lib/experimental-influxdb-rails.rb
+- lib/influxdb/rails/air_traffic_controller.rb
+- lib/influxdb/rails/backtrace.rb
+- lib/influxdb/rails/configuration.rb
+- lib/influxdb/rails/context.rb
+- lib/influxdb/rails/exception_presenter.rb
+- lib/influxdb/rails/instrumentation.rb
+- lib/influxdb/rails/logger.rb
+- lib/influxdb/rails/middleware/hijack_render_exception.rb
+- lib/influxdb/rails/middleware/hijack_rescue_action_everywhere.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/rack.rb
+- lib/influxdb/rails/railtie.rb
+- lib/influxdb/rails/sql/normalizer.rb
+- lib/influxdb/rails/sql/query.rb
+- lib/influxdb/rails/version.rb
+- lib/rails/generators/influxdb/influxdb_generator.rb
+- lib/rails/generators/influxdb/templates/initializer.rb
+- spec/controllers/widgets_controller_spec.rb
+- spec/integration/exceptions_spec.rb
+- spec/integration/integration_helper.rb
+- spec/integration/metrics_spec.rb
+- spec/shared_examples/data.rb
+- spec/shared_examples/tags.rb
+- spec/spec_helper.rb
+- spec/support/rails4/app.rb
+- spec/support/rails5/app.rb
+- spec/support/views/widgets/_item.html.erb
+- spec/support/views/widgets/index.html.erb
+- spec/unit/backtrace_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/context_spec.rb
+- spec/unit/exception_presenter_spec.rb
+- spec/unit/influxdb_rails_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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: InfluxDB bindings for Ruby on Rails.
+test_files:
+- spec/controllers/widgets_controller_spec.rb
+- spec/integration/exceptions_spec.rb
+- spec/integration/integration_helper.rb
+- spec/integration/metrics_spec.rb
+- spec/shared_examples/data.rb
+- spec/shared_examples/tags.rb
+- spec/spec_helper.rb
+- spec/support/rails4/app.rb
+- spec/support/rails5/app.rb
+- spec/support/views/widgets/_item.html.erb
+- spec/support/views/widgets/index.html.erb
+- spec/unit/backtrace_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/context_spec.rb
+- spec/unit/exception_presenter_spec.rb
+- spec/unit/influxdb_rails_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