influxdb-rails 1.0.0 → 1.0.1.beta1

data/lib/influxdb/rails/test_client.rb

@@ -0,0 +1,13 @@
+module InfluxDB
+  module Rails
+    class TestClient
+      cattr_accessor :metrics do
+        []
+      end
+
+      def write_point(name, options = {})
+        metrics << options.merge(name: name)
+      end
+    end
+  end
+end

data/lib/influxdb/rails/values.rb

@@ -0,0 +1,24 @@
+module InfluxDB
+  module Rails
+    class Values
+      def initialize(values: {}, additional_values: InfluxDB::Rails.current.values)
+        @values = values
+        @additional_values = additional_values
+      end
+
+      def to_h
+        expanded_values.reject do |_, value|
+          value.nil? || value == ""
+        end
+      end
+
+      private
+
+      attr_reader :additional_values, :values
+
+      def expanded_values
+        values.merge(additional_values)
+      end
+    end
+  end
+end

data/lib/influxdb/rails/version.rb

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

data/sample-dashboard/README.md

@@ -18,7 +18,7 @@ It provides an overview and you can also drill down into numbers on a per reques
 
 To be able to measure performance you need the following things available:
 
-- [InfluxDB 1.x](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/)
+- [InfluxDB 1.x](https://docs.influxdata.com/influxdb/v1.8/introduction/install/)
 - [Grafana](https://grafana.com/docs/)
 - A [Ruby On Rails](https://rubyonrails.org/) application with [influxdb-rails](https://github.com/influxdata/influxdb-rails) enabled
 

data/spec/requests/action_controller_metrics_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActionController 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(
+      name:   "rails",
+      tags:   a_hash_including(
+        method:          "MetricsController#index",
+        hook:            "process_action",
+        status:          200,
+        format:          :html,
+        http_method:     "GET",
+        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,
+        view:             be_between(1, 30),
+        db:               be_between(1, 30),
+        controller:       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(
+      name:      "rails",
+      tags:      a_hash_including(
+        method: "MetricsController#index",
+        hook:   "process_action"
+      ),
+      values:    a_hash_including(
+        started: 1_514_797_200
+      ),
+      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(["process_action.action_controller"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        method: "MetricsController#index",
+        hook:   "process_action"
+      )
+    )
+  end
+
+  it "does not crash when controller throws and exception" do
+    get "/exceptions"
+
+    expect_metric(
+      tags: a_hash_including(
+        method:    "ExceptionsController#index",
+        hook:      "process_action",
+        exception: "ZeroDivisionError"
+      )
+    )
+  end
+end

data/spec/requests/action_view_collection_metrics_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActionView collection 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(
+      name:   "rails",
+      tags:   a_hash_including(
+        location:        "MetricsController#index",
+        hook:            "render_collection",
+        additional_tag:  :value,
+        filename:        include("spec/support/views/metrics/_item.html.erb"),
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware
+      ),
+      values: a_hash_including(
+        additional_value: :value,
+        count:            3,
+        request_id:       :request_id,
+        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(
+      name:      "rails",
+      tags:      a_hash_including(
+        location: "MetricsController#index",
+        hook:     "render_collection"
+      ),
+      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(["render_collection.action_view"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      name: "rails",
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "render_collection"
+      )
+    )
+  end
+end

data/spec/requests/action_view_partial_metrics_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActionView partial 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:            "render_partial",
+        additional_tag:  :value,
+        filename:        include("spec/support/views/metrics/_item.html.erb"),
+        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)
+      )
+    )
+  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:     "render_partial"
+      ),
+      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(["render_partial.action_view"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "render_partial"
+      )
+    )
+  end
+end

data/spec/requests/action_view_template_metrics_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActionView template 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:            "render_template",
+        additional_tag:  :value,
+        filename:        include("spec/support/views/metrics/index.html.erb"),
+        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)
+      )
+    )
+  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:     "render_template"
+      ),
+      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(["render_template.action_view"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "render_template"
+      )
+    )
+  end
+end

data/spec/requests/active_job_enqueue_metrics_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActiveJob enqueue 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
+    get "/metrics"
+
+    expect_metric(
+      tags:   a_hash_including(
+        location:        "MetricsController#index",
+        hook:            "enqueue",
+        job:             "MetricJob",
+        queue:           "default",
+        state:           "queued",
+        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:            1
+      )
+    )
+  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:     "enqueue"
+      ),
+      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(["enqueue.active_job"])
+
+    get "/metrics"
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "enqueue"
+      )
+    )
+  end
+end

data/spec/requests/active_job_perform_metrics_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+RSpec.describe "ActiveJobs perform 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",
+        state:           "succeeded",
+        job:             "MetricJob",
+        queue:           "default",
+        server:          Socket.gethostname,
+        app_name:        :app_name,
+        tags_middleware: :tags_middleware
+      ),
+      values: a_hash_including(
+        value: be_between(0, 30)
+      )
+    )
+  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"
+      ),
+      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.active_job"])
+
+    perform_enqueued_jobs do
+      get "/metrics"
+    end
+
+    expect_no_metric(
+      tags: a_hash_including(
+        location: "MetricsController#index",
+        hook:     "perform"
+      )
+    )
+  end
+end