experimental-influxdb-rails 1.0.0.beta5

data/lib/influxdb/rails/rack.rb

@@ -0,0 +1,24 @@
+module InfluxDB
+  module Rails
+    class Rack # rubocop:disable Style/Documentation
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        dup._call(env)
+      end
+
+      def _call(env)
+        begin
+          response = @app.call(env)
+        rescue StandardError => e
+          InfluxDB::Rails.transmit_unless_ignorable(e, env)
+          raise(e)
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/influxdb/rails/railtie.rb

@@ -0,0 +1,51 @@
+require "influxdb"
+require "rails"
+
+module InfluxDB
+  module Rails
+    class Railtie < ::Rails::Railtie # :nodoc:
+      initializer "influxdb.insert_rack_middleware" do |app|
+        app.config.middleware.insert 0, InfluxDB::Rails::Rack
+      end
+
+      config.after_initialize do # rubocop:disable Metrics/BlockLength
+        InfluxDB::Rails.configure(true, &:load_rails_defaults)
+
+        ActiveSupport.on_load(:action_controller) do
+          require "influxdb/rails/air_traffic_controller"
+          include InfluxDB::Rails::AirTrafficController
+          require "influxdb/rails/instrumentation"
+          include InfluxDB::Rails::Instrumentation
+        end
+
+        require "influxdb/rails/middleware/hijack_render_exception"
+        ::ActionDispatch::DebugExceptions.prepend InfluxDB::Rails::Middleware::HijackRenderException
+
+        if defined?(ActiveSupport::Notifications)
+          cache = lambda do |_, _, _, _, payload|
+            current = InfluxDB::Rails.current
+            current.controller = payload[:controller]
+            current.action     = payload[:action]
+          end
+          ActiveSupport::Notifications.subscribe "start_processing.action_controller", &cache
+
+          c = InfluxDB::Rails.configuration
+          requests = Middleware::RequestSubscriber.new(c)
+          ActiveSupport::Notifications.subscribe "process_action.action_controller", requests
+
+          templates = Middleware::RenderSubscriber.new(c, c.series_name_for_render_template)
+          ActiveSupport::Notifications.subscribe "render_template.action_view", templates
+
+          partials = Middleware::RenderSubscriber.new(c, c.series_name_for_render_partial)
+          ActiveSupport::Notifications.subscribe "render_partial.action_view", partials
+
+          collections = Middleware::RenderSubscriber.new(c, c.series_name_for_render_collection)
+          ActiveSupport::Notifications.subscribe "render_collection.action_view", collections
+
+          sql = Middleware::SqlSubscriber.new(c, c.series_name_for_sql)
+          ActiveSupport::Notifications.subscribe "sql.active_record", sql
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module InfluxDB
+  module Rails
+    module Sql
+      class Normalizer # :nodoc:
+        def initialize(query)
+          @query = query.dup
+        end
+
+        def perform
+          query.squish!
+          query.gsub!(/(\s(=|>|<|>=|<=|<>|!=)\s)('[^']+'|[\$\+\-\w\.]+)/, '\1xxx')
+          query.gsub!(/(\sIN\s)\([^\(\)]+\)/i, '\1(xxx)')
+          regex = /(\sBETWEEN\s)('[^']+'|[\+\-\w\.]+)(\sAND\s)('[^']+'|[\+\-\w\.]+)/i
+          query.gsub!(regex, '\1xxx\3xxx')
+          query.gsub!(/(\sVALUES\s)\(.+\)/i, '\1(xxx)')
+          query.gsub!(/(\s(LIKE|ILIKE|SIMILAR TO|NOT SIMILAR TO)\s)('[^']+')/i, '\1xxx')
+          query.gsub!(/(\s(LIMIT|OFFSET)\s)(\d+)/i, '\1xxx')
+          query
+        end
+
+        private
+
+        attr_reader :query
+      end
+    end
+  end
+end

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.beta5".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/data.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+RSpec.shared_examples_for "with additional data" do |series_names|
+  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
+
+      series_names.each do |series_name|
+        expect_any_instance_of(InfluxDB::Client).to receive(:write_point).with(series_name, hash_including(values: hash_including(another: :value)))
+      end
+
+      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")
+
+        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(: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)
+
+        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
+end

data/spec/shared_examples/tags.rb

@@ -0,0 +1,45 @@
+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", nil: nil, empty: "") } }
+
+    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(: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)
+
+      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)