influxdb-rails 1.0.0 → 1.0.1.beta1

data/spec/requests/active_job_perform_start_metrics_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActiveJob start metrics", type: :request do
+  let(:tags_middleware) do
+    lambda do |tags|
+      tags.merge(tags_middleware: :tags_middleware)
+    end
+  end
+  before do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_environments).and_return(%w[development])
+    allow_any_instance_of(ActionDispatch::Request).to receive(:request_id).and_return(:request_id)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:application_name).and_return(:app_name)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:tags_middleware).and_return(tags_middleware)
+  end
+
+  it "writes metric" do
+    perform_enqueued_jobs do
+      get "/metrics"
+    end
+
+    expect_metric(
+      tags:   a_hash_including(
+        location:        "MetricsController#index",
+        hook:            "perform_start",
+        state:           "running",
+        job:             "MetricJob",
+        queue:           "default",
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware
+      ),
+      values: a_hash_including(
+        value: 1
+      )
+    )
+  end
+
+  it "includes correct timestamps" do
+    travel_to Time.zone.local(2018, 1, 1, 9, 0, 0)
+
+    perform_enqueued_jobs do
+      get "/metrics"
+    end
+
+    expect_metric(
+      tags:      a_hash_including(
+        location: "MetricsController#index",
+        hook:     "perform_start"
+      ),
+      timestamp: 1_514_797_200
+    )
+  end
+
+  it "does not write metric when hook is ignored" do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_hooks).and_return(["perform_start.active_job"])
+
+    perform_enqueued_jobs do
+      get "/metrics"
+    end
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "perform_start"
+      )
+    )
+  end
+end

data/spec/requests/active_record_instantiation_metrics_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActiveRecord instantiation metrics", type: :request do
+  let(:tags_middleware) do
+    lambda do |tags|
+      tags.merge(tags_middleware: :tags_middleware)
+    end
+  end
+  let(:metric) { Metric.create!(name: "name") }
+  before do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_environments).and_return(%w[development])
+    allow_any_instance_of(ActionDispatch::Request).to receive(:request_id).and_return(:request_id)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:application_name).and_return(:app_name)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:tags_middleware).and_return(tags_middleware)
+  end
+
+  it "writes metric" do
+    get metric_path(metric)
+
+    expect_metric(
+      tags:   a_hash_including(
+        location:        "MetricsController#show",
+        hook:            "instantiation",
+        class_name:      "Metric",
+        additional_tag:  :value,
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware
+      ),
+      values: a_hash_including(
+        additional_value: :value,
+        request_id:       :request_id,
+        value:            be_between(1, 30),
+        record_count:     1
+      )
+    )
+  end
+
+  it "includes correct timestamps" do
+    travel_to Time.zone.local(2018, 1, 1, 9, 0, 0)
+
+    get metric_path(metric)
+
+    expect_metric(
+      tags:      a_hash_including(
+        location: "MetricsController#show",
+        hook:     "instantiation"
+      ),
+      timestamp: 1_514_797_200
+    )
+  end
+
+  it "does not write metric when hook is ignored" do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_hooks).and_return(["instantiation.active_record"])
+
+    get metric_path(metric)
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#show",
+        hook:     "instantiation"
+      )
+    )
+  end
+end

data/spec/requests/active_record_sql_metrics_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActiveRecord SQL metrics", type: :request do
+  let(:tags_middleware) do
+    lambda do |tags|
+      tags.merge(tags_middleware: :tags_middleware)
+    end
+  end
+  before do
+    allow_any_instance_of(ActionDispatch::Request).to receive(:request_id).and_return(:request_id)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:application_name).and_return(:app_name)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:tags_middleware).and_return(tags_middleware)
+  end
+
+  it "writes metric" do
+    skip("https://github.com/rails/rails/issues/30586") unless payload_names_fixed_in_rails?
+
+    get "/metrics"
+
+    expect_metric(
+      tags:   a_hash_including(
+        location:        "MetricsController#index",
+        hook:            "sql",
+        name:            "Metric Create",
+        class_name:      "Metric",
+        operation:       "INSERT",
+        additional_tag:  :value,
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware
+      ),
+      values: a_hash_including(
+        additional_value: :value,
+        request_id:       :request_id,
+        value:            be_between(1, 30),
+        sql:              "INSERT INTO \"metrics\" (\"name\", \"created_at\", \"updated_at\") VALUES (xxx)"
+      )
+    )
+  end
+
+  it "writes metric" do
+    skip("https://github.com/rails/rails/issues/30586") if payload_names_fixed_in_rails?
+
+    get "/metrics"
+
+    expect_metric(
+      tags:   a_hash_including(
+        location:        "MetricsController#index",
+        hook:            "sql",
+        name:            "SQL",
+        class_name:      "SQL",
+        operation:       "INSERT",
+        additional_tag:  :value,
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware
+      ),
+      values: a_hash_including(
+        additional_value: :value,
+        request_id:       :request_id,
+        value:            be_between(1, 30),
+        sql:              "INSERT INTO \"metrics\" (\"name\", \"created_at\", \"updated_at\") VALUES (xxx)"
+      )
+    )
+  end
+
+  it "includes correct timestamps" do
+    travel_to Time.zone.local(2018, 1, 1, 9, 0, 0)
+
+    get "/metrics"
+
+    expect_metric(
+      tags:      a_hash_including(
+        location: "MetricsController#index",
+        hook:     "sql"
+      ),
+      timestamp: 1_514_797_200
+    )
+  end
+
+  it "does not write metric when hook is ignored" do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_hooks).and_return(["sql.active_record"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "sql"
+      )
+    )
+  end
+
+  def payload_names_fixed_in_rails?
+    Rails::VERSION::MAJOR > 5 ||
+      rails_after_5_1?
+  end
+
+  def rails_after_5_1?
+    Rails::VERSION::MAJOR == 5 &&
+      Rails::VERSION::MINOR > 1
+  end
+end

data/spec/requests/block_inistrumentation_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "BlockInstrumentation metrics", type: :request do
+  let(:tags_middleware) do
+    lambda do |tags|
+      tags.merge(tags_middleware: :tags_middleware)
+    end
+  end
+  before do
+    allow_any_instance_of(ActionDispatch::Request).to receive(:request_id).and_return(:request_id)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:application_name).and_return(:app_name)
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:tags_middleware).and_return(tags_middleware)
+  end
+
+  it "writes metric" do
+    get "/metrics"
+
+    expect_metric(
+      tags:   a_hash_including(
+        location:        "MetricsController#index",
+        hook:            "block_instrumentation",
+        additional_tag:  :value,
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware,
+        block_tag:       :block_tag,
+        name:            "name"
+      ),
+      values: a_hash_including(
+        additional_value: :value,
+        request_id:       :request_id,
+        block_value:      :block_value,
+        value:            be_between(1, 30)
+      )
+    )
+  end
+
+  it "includes correct timestamps" do
+    travel_to Time.zone.local(2018, 1, 1, 9, 0, 0)
+
+    get "/metrics"
+
+    expect_metric(
+      tags:      a_hash_including(
+        location: "MetricsController#index",
+        hook:     "block_instrumentation"
+      ),
+      timestamp: 1_514_797_200
+    )
+  end
+
+  it "does not write metric when hook is ignored" do
+    allow_any_instance_of(InfluxDB::Rails::Configuration).to receive(:ignored_hooks).and_return(["block_instrumentation.influxdb_rails"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "block_instrumentation"
+      )
+    )
+  end
+end

data/spec/requests/context_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "Context", type: :request do
+  it "resets the context after a request" do
+    get "/metrics"
+
+    expect_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "sql"
+      )
+    )
+
+    expect(InfluxDB::Rails.current.tags).to be_empty
+    expect(InfluxDB::Rails.current.values).to be_empty
+  end
+
+  it "resets the context after a request when exceptioni occurs" do
+    setup_broken_client
+
+    get "/metrics"
+
+    expect_no_metric(hook: "process_action")
+    expect(InfluxDB::Rails.current.tags).to be_empty
+    expect(InfluxDB::Rails.current.values).to be_empty
+  end
+end

data/spec/requests/logger_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "Logger", type: :request do
+  it "logs exception" do
+    setup_broken_client
+    expect(Rails.logger).to receive(:error).with(/message/).at_least(:once)
+
+    get "/metrics"
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+require "active_support"
+require_relative "../lib/influxdb/rails/helpers/rspec_matchers"
+require File.expand_path(File.dirname(__FILE__) + "/support/broken_client")
+
 ENV["RAILS_ENV"] ||= "test"
 
 require "rails"
@@ -25,9 +29,11 @@ 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
+  config.after(:each) do
+    travel_back
   end
+
+  config.include ActiveSupport::Testing::TimeHelpers
+  config.include ActiveJob::TestHelper
+  config.include InfluxDB::Rails::BrokenClient
 end

data/spec/support/broken_client.rb

@@ -0,0 +1,11 @@
+module InfluxDB
+  module Rails
+    module BrokenClient
+      def setup_broken_client
+        client = double
+        allow(client).to receive(:write_point).and_raise("message")
+        allow(InfluxDB::Rails).to receive(:client).and_return(client)
+      end
+    end
+  end
+end

data/spec/support/rails5/app.rb

@@ -1,5 +1,6 @@
 require "action_controller/railtie"
-require "active_record"
+require "active_record/railtie"
+require "active_job"
 
 app = Class.new(Rails::Application)
 app.config.secret_key_base = "1234567890abcdef1234567890abcdef"
@@ -9,38 +10,59 @@ app.config.active_support.deprecation = :log
 app.config.eager_load = false
 app.config.root = __dir__
 Rails.backtrace_cleaner.remove_silencers!
+ActiveJob::Base.logger = Rails.logger
 app.initialize!
 
 app.routes.draw do
-  resources :widgets
+  resources :metrics, only: %i[index show]
+  resources :exceptions, only: :index
 end
 
 InfluxDB::Rails.configure do |config|
 end
 
-ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ENV["DATABASE_URL"] = "sqlite3::memory:"
 ActiveRecord::Schema.define do
-  create_table :widgets, force: true do |t|
-    t.string :title
+  create_table :metrics, force: true do |t|
+    t.string :name
 
     t.timestamps
   end
 end
 
-class Widget < ActiveRecord::Base; end
+class MetricJob < ActiveJob::Base
+  queue_as :default
+
+  def perform
+    # Do something later
+  end
+end
+
+class Metric < ActiveRecord::Base; end
 class ApplicationController < ActionController::Base; end
-class WidgetsController < ApplicationController
+class MetricsController < ApplicationController
   prepend_view_path File.join(__dir__, "..", "views")
 
   before_action do
-    InfluxDB::Rails.current.values = { key: :value }
+    InfluxDB::Rails.current.values = { additional_value: :value }
+    InfluxDB::Rails.current.tags = { additional_tag: :value }
   end
 
   def index
-    Widget.create!(title: "test")
+    InfluxDB::Rails.instrument "name", tags: { block_tag: :block_tag }, values: { block_value: :block_value } do
+      1 + 1
+    end
+    MetricJob.perform_later
+    Metric.create!(name: "name")
   end
 
-  def new
+  def show
+    @metric = Metric.find_by(name: "name")
+  end
+end
+
+class ExceptionsController < ApplicationController
+  def index
     1 / 0
   end
 end