asklytics-influxdb-rails 1.0.0.beta3

data/lib/influxdb/rails/sql/query.rb

@@ -0,0 +1,32 @@
+require "influxdb/rails/sql/normalizer"
+
+module InfluxDB
+  module Rails
+    module Sql
+      class Query # :nodoc:
+        attr_reader :query, :name
+
+        TRACKED_SQL_COMMANDS = %w[SELECT INSERT UPDATE DELETE].freeze
+        UNTRACKED_NAMES = %w[SCHEMA].freeze
+
+        def initialize(payload)
+          @query = payload[:sql].to_s.dup.upcase
+          @name = payload[:name].to_s.dup
+        end
+
+        def operation
+          query.split.first
+        end
+
+        def class_name
+          name.split.first
+        end
+
+        def track?
+          @track ||= query.start_with?(*TRACKED_SQL_COMMANDS) &&
+                     !name.upcase.start_with?(*UNTRACKED_NAMES)
+        end
+      end
+    end
+  end
+end

data/lib/influxdb/rails/version.rb

@@ -0,0 +1,5 @@
+module InfluxDB
+  module Rails
+    VERSION = "1.0.0.beta3".freeze
+  end
+end

data/lib/rails/generators/influxdb/influxdb_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+class InfluxdbGenerator < Rails::Generators::Base # rubocop:disable Style/Documentation
+  desc "Description:\n  This creates a Rails initializer for InfluxDB::Rails."
+
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_initializer_file
+    template "initializer.rb", "config/initializers/influxdb_rails.rb"
+  end
+
+  def install
+    # nothing to do here
+  end
+end

data/lib/rails/generators/influxdb/templates/initializer.rb

@@ -0,0 +1,11 @@
+InfluxDB::Rails.configure do |config|
+  config.influxdb_database = "rails"
+  config.influxdb_username = "root"
+  config.influxdb_password = "root"
+  config.influxdb_hosts    = ["localhost"]
+  config.influxdb_port     = 8086
+
+  # config.series_name_for_controller_runtimes = "rails.controller"
+  # config.series_name_for_view_runtimes       = "rails.view"
+  # config.series_name_for_db_runtimes         = "rails.db"
+end

data/spec/controllers/widgets_controller_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+RSpec.describe WidgetsController, type: :controller do
+  describe "#new" do
+    it "should raise an exception" do
+      expect { get :new }.to raise_error(ZeroDivisionError)
+    end
+  end
+
+  describe "#index" do
+    it "should not raise an exception" do
+      expect { get :index }.to_not raise_error
+    end
+  end
+end

data/spec/integration/exceptions_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + "/integration_helper")
+
+RSpec.describe "exception handling", type: :request do
+  before do
+    InfluxDB::Rails.configure do |config|
+      config.ignored_environments = %w[development]
+      config.instrumentation_enabled = false
+    end
+  end
+
+  describe "in an action that raises an exception" do
+    it "should add an exception to the queue" do
+      expect(InfluxDB::Rails.client).to receive(:write_point)
+      get "/widgets/new"
+    end
+  end
+
+  describe "in an action that does not raise an exception" do
+    it "should not add anything to the queue" do
+      expect(InfluxDB::Rails.client).not_to receive(:write_point)
+      get "/widgets"
+    end
+  end
+
+  describe "for an ignored user agent" do
+    it "should not make an HTTP call to the API" do
+      expect(InfluxDB::Rails.client).not_to receive(:write_point)
+
+      # note: GoogleBot is ignored by default
+      if Rails::VERSION::MAJOR >= 5
+        get "/widgets/new", headers: { "HTTP_USER_AGENT" => "GoogleBot/2.1" }
+      else
+        get "/widgets/new", {}, "HTTP_USER_AGENT" => "GoogleBot/2.1"
+      end
+    end
+  end
+end

data/spec/integration/integration_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../spec_helper"

data/spec/integration/metrics_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + "/integration_helper")
+
+RSpec.describe WidgetsController, type: :controller do
+  render_views
+
+  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
+    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
+
+      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
+      end
+    end
+  end
+end

data/spec/shared_examples/tags.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+RSpec.shared_examples_for "with additional tags" do |series_names|
+  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") } }
+
+    it "processes tags throught the middleware" do
+      tags = data[:tags].merge(static: "value")
+
+      series_names.each do |series_name|
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(series_name, include(tags: tags))
+      end
+
+      subject.call("unused", start, finish, "unused", payload)
+    end
+  end
+
+  context "when tags are set in the current context" do
+    let(:additional_tags) do
+      { another: :value }
+    end
+
+    after do
+      InfluxDB::Rails.current.reset
+    end
+
+    it "does include the tags" do
+      InfluxDB::Rails.current.tags = additional_tags
+      tags = data[:tags].merge(additional_tags)
+
+      series_names.each do |series_name|
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(series_name, include(tags: tags))
+      end
+
+      subject.call("unused", start, finish, "unused", payload)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+ENV["RAILS_ENV"] ||= "test"
+
+require "rails"
+
+if Rails::VERSION::MAJOR < 4 || Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR < 2
+  raise "Sorry, influxdb-rails only supports Rails 4.2 and higher."
+end
+
+require "bundler/setup"
+Bundler.require
+
+require "fakeweb"
+FakeWeb.allow_net_connect = false
+
+puts "Loading Rails v#{Rails.version}..."
+
+require "support/rails#{Rails::VERSION::MAJOR}/app"
+require "rspec/rails"
+
+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(&:load_rails_defaults)
+  end
+end

data/spec/support/rails4/app.rb

@@ -0,0 +1,44 @@
+require "action_controller/railtie"
+require "active_record"
+
+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!
+app.initialize!
+
+app.routes.draw do
+  resources :widgets
+end
+
+InfluxDB::Rails.configure do |config|
+end
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Schema.define do
+  create_table :widgets, force: true do |t|
+    t.string :title
+
+    t.timestamps
+  end
+end
+
+class Widget < ActiveRecord::Base; end
+class ApplicationController < ActionController::Base; end
+class WidgetsController < ApplicationController
+  prepend_view_path File.join(__dir__, "..", "views")
+
+  def index
+    Widget.create!(title: "test")
+  end
+
+  def new
+    1 / 0
+  end
+end
+
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/support/rails5/app.rb

@@ -0,0 +1,44 @@
+require "action_controller/railtie"
+require "active_record"
+
+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!
+app.initialize!
+
+app.routes.draw do
+  resources :widgets
+end
+
+InfluxDB::Rails.configure do |config|
+end
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Schema.define do
+  create_table :widgets, force: true do |t|
+    t.string :title
+
+    t.timestamps
+  end
+end
+
+class Widget < ActiveRecord::Base; end
+class ApplicationController < ActionController::Base; end
+class WidgetsController < ApplicationController
+  prepend_view_path File.join(__dir__, "..", "views")
+
+  def index
+    Widget.create!(title: "test")
+  end
+
+  def new
+    1 / 0
+  end
+end
+
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/support/views/widgets/_item.html.erb

@@ -0,0 +1 @@
+<div>item</div

data/spec/support/views/widgets/index.html.erb

@@ -0,0 +1,5 @@
+<h1>Index page</h1>
+<div>
+  <%= render partial: 'item' %>
+  <%= render partial: 'item', collection: [1,2,3] %>
+</div>

data/spec/unit/backtrace_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Backtrace do
+  before do
+    @raw_backtrace = [
+      "/var/www/current/app/models/foo.rb:10:in `bar'",
+      "/var/www/current/app/models/foo.rb:19:in `baz'",
+      "/var/www/current/app/models/foo.rb:32:in `<main>'"
+    ]
+
+    @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+  end
+
+  it "should accept an exception into the initializer" do
+    expect(@backtrace.lines).not_to be_empty
+    expect(@backtrace.lines.count).to eq(3)
+  end
+
+  it "should correctly parse lines into their elements" do
+    line = @backtrace.lines.first
+
+    expect(line.file).to eq("/var/www/current/app/models/foo.rb")
+    expect(line.number).to eq("10")
+    expect(line.method).to eq("bar")
+  end
+
+  describe "#to_a" do
+    it "should return an array of lines" do
+      expect(@backtrace.to_a.is_a?(Array)).to be_truthy
+    end
+  end
+
+  context "nil backtrace" do
+    before do
+      @raw_backtrace = nil
+      @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+    end
+
+    it "should accept an exception into the initializer" do
+      expect(@backtrace.lines).to be_empty
+      expect(@backtrace.lines.count).to eq(0)
+    end
+
+    describe "#to_a" do
+      it "should return an array of lines" do
+        expect(@backtrace.to_a.is_a?(Array)).to be_truthy
+      end
+    end
+  end
+
+  describe "backtrace filters" do
+    before do
+      InfluxDB::Rails.configure do |config|
+        config.application_root = "/var/www/current"
+      end
+    end
+
+    it "should apply a single default backtrace filter correctly" do
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+
+      line = filtered_backtrace.lines.first
+      expect(line.file).to eq("[APP_ROOT]/app/models/foo.rb")
+    end
+
+    it "should all default backtrace filters correctly" do
+      extended_backtrace = @raw_backtrace.dup
+      extended_backtrace << "#{Gem.path.first}/lib/foo_gem.rb:1:in `blah'"
+
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(extended_backtrace)
+      expect(filtered_backtrace.lines.first.file).to eq("[APP_ROOT]/app/models/foo.rb")
+      expect(filtered_backtrace.lines.last.file).to eq("[GEM_ROOT]/lib/foo_gem.rb")
+    end
+
+    it "should allow the addition of custom backtrace filters" do
+      InfluxDB::Rails.configure do |config|
+        config.backtrace_filters << ->(line) { line.gsub(/foo/, "F00") }
+      end
+
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+
+      line = filtered_backtrace.lines.first
+      expect(line.file).to eq("[APP_ROOT]/app/models/F00.rb")
+    end
+  end
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,125 @@
+require "spec_helper"
+
+RSpec.describe InfluxDB::Rails::Configuration do
+  before 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
+
+    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
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.retry = 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
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.open_timeout = 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
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.read_timeout = 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
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.max_delay = 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
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.time_precision = "ms"
+      end
+      expect(InfluxDB::Rails.configuration.time_precision).to eql("ms")
+    end
+  end
+
+  describe "#rails_app_name" do
+    it "defaults to nil" do
+      expect(InfluxDB::Rails.configuration.rails_app_name).to be(nil)
+    end
+
+    it "can be set to own name" do
+      InfluxDB::Rails.configure do |config|
+        config.rails_app_name = "my-app"
+      end
+
+      expect(InfluxDB::Rails.configuration.rails_app_name).to eq("my-app")
+    end
+  end
+
+  describe "#tags_middleware" do
+    let(:middleware) { InfluxDB::Rails.configuration.tags_middleware }
+    let(:tags_example) { { a: 1, b: 2 } }
+
+    it "by default returns unmodified tags" do
+      expect(middleware.call(tags_example)).to eq tags_example
+    end
+
+    it "can be updated" do
+      InfluxDB::Rails.configure do |config|
+        config.tags_middleware = ->(tags) { tags.merge(c: 3) }
+      end
+
+      expect(middleware.call(tags_example)).to eq(tags_example.merge(c: 3))
+    end
+  end
+end