influxdb-rails 1.0.0 → 1.0.2

data/lib/influxdb/rails/middleware/render_subscriber.rb

@@ -1,31 +1,30 @@
-require "influxdb/rails/middleware/simple_subscriber"
+require "influxdb/rails/middleware/subscriber"
 
 module InfluxDB
   module Rails
     module Middleware
-      class RenderSubscriber < SimpleSubscriber # :nodoc:
-        def short_hook_name
-          return "render_template" if hook_name.include?("render_template")
-          return "render_partial" if hook_name.include?("render_partial")
-          return "render_collection" if hook_name.include?("render_collection")
-        end
-
+      class RenderSubscriber < Subscriber # :nodoc:
         private
 
-        def values(started, finished, payload)
-          super(started, finished, payload).merge(
+        def values
+          {
+            value:      duration,
             count:      payload[:count],
-            cache_hits: payload[:cache_hits]
-          ).reject { |_, value| value.nil? }
+            cache_hits: payload[:cache_hits],
+          }
         end
 
-        def tags(payload)
-          tags = {
-            location: location,
+        def tags
+          {
             hook:     short_hook_name,
             filename: payload[:identifier],
           }
-          super(tags)
+        end
+
+        def short_hook_name
+          return "render_template" if hook_name.include?("render_template")
+          return "render_partial" if hook_name.include?("render_partial")
+          return "render_collection" if hook_name.include?("render_collection")
         end
       end
     end

data/lib/influxdb/rails/middleware/request_subscriber.rb

@@ -4,44 +4,39 @@ module InfluxDB
   module Rails
     module Middleware
       class RequestSubscriber < Subscriber # :nodoc:
-        def call(_name, start, finish, _id, payload)
-          return unless enabled?
-
-          InfluxDB::Rails.client.write_point \
-            configuration.measurement_name,
-            values:    values(start, finish, payload),
-            tags:      tags(payload),
-            timestamp: timestamp(finish)
-        rescue StandardError => e
-          ::Rails.logger.error("[InfluxDB::Rails] Unable to write points: #{e.message}")
+        def write
+          super
         ensure
           InfluxDB::Rails.current.reset
         end
 
         private
 
-        def tags(payload)
-          tags = {
+        def tags
+          {
             method:      "#{payload[:controller]}##{payload[:action]}",
             hook:        "process_action",
             status:      payload[:status],
             format:      payload[:format],
             http_method: payload[:method],
-            server:      Socket.gethostname,
-            app_name:    configuration.application_name,
+            exception:   payload[:exception]&.first,
           }
-          super(tags)
         end
 
-        def values(started, finished, payload)
+        def values
           {
-            controller: ((finished - started) * 1000).ceil,
+            controller: duration,
             view:       (payload[:view_runtime] || 0).ceil,
             db:         (payload[:db_runtime] || 0).ceil,
-            started:    timestamp(started),
-          }.merge(InfluxDB::Rails.current.values).reject do |_, value|
-            value.nil? || value == ""
-          end
+            started:    started,
+          }
+        end
+
+        def started
+          InfluxDB.convert_timestamp(
+            start.utc,
+            configuration.client.time_precision
+          )
         end
       end
     end

data/lib/influxdb/rails/middleware/sql_subscriber.rb

@@ -1,35 +1,35 @@
-require "influxdb/rails/middleware/simple_subscriber"
+require "influxdb/rails/middleware/subscriber"
 require "influxdb/rails/sql/query"
 
 module InfluxDB
   module Rails
     module Middleware
-      class SqlSubscriber < SimpleSubscriber # :nodoc:
-        def call(_name, started, finished, _unique_id, payload)
-          super if InfluxDB::Rails::Sql::Query.new(payload).track?
-        end
-
+      class SqlSubscriber < Subscriber # :nodoc:
         private
 
-        def values(started, finished, payload)
-          super.merge(sql: InfluxDB::Rails::Sql::Normalizer.new(payload[:sql]).perform)
-        end
-
-        def location
-          result = super
-          result.empty? ? :raw : result
+        def values
+          {
+            value: duration,
+            sql:   InfluxDB::Rails::Sql::Normalizer.new(payload[:sql]).perform,
+          }
         end
 
-        def tags(payload)
-          query = InfluxDB::Rails::Sql::Query.new(payload)
-          tags = {
-            location:   location,
+        def tags
+          {
             hook:       "sql",
             operation:  query.operation,
             class_name: query.class_name,
             name:       query.name,
+            location:   :raw,
           }
-          super(tags)
+        end
+
+        def disabled?
+          super || !query.track?
+        end
+
+        def query
+          @query ||= InfluxDB::Rails::Sql::Query.new(payload)
         end
       end
     end

data/lib/influxdb/rails/middleware/subscriber.rb

@@ -1,3 +1,5 @@
+require "influxdb/rails/metric"
+
 module InfluxDB
   module Rails
     module Middleware
@@ -5,49 +7,60 @@ module InfluxDB
       # which are intended as ActiveSupport::Notifications.subscribe
       # consumers.
       class Subscriber
-        attr_reader :configuration
-        attr_reader :hook_name
-
-        def initialize(configuration, hook_name)
+        def initialize(configuration:, hook_name:, start:, finish:, payload:)
           @configuration = configuration
           @hook_name = hook_name
+          @start = start
+          @finish = finish
+          @payload = payload
         end
 
-        def call(*)
-          raise NotImplementedError, "must be implemented in subclass"
+        def self.call(name, start, finish, _id, payload)
+          new(
+            configuration: InfluxDB::Rails.configuration,
+            start:         start,
+            finish:        finish,
+            payload:       payload,
+            hook_name:     name
+          ).write
+        end
+
+        def write
+          return if disabled?
+
+          metric.write
+        rescue StandardError => e
+          ::Rails.logger.error("[InfluxDB::Rails] Unable to write points: #{e.message}")
         end
 
         private
 
-        def timestamp(time)
-          InfluxDB.convert_timestamp(time.utc, client.time_precision)
+        attr_reader :configuration, :hook_name, :start, :finish, :payload
+
+        def metric
+          InfluxDB::Rails::Metric.new(
+            values:        values,
+            tags:          tags,
+            configuration: configuration,
+            timestamp:     finish
+          )
         end
 
-        def client
-          @client = configuration.client
+        def tags
+          raise NotImplementedError, "must be implemented in subclass"
         end
 
-        def tags(tags)
-          result = tags.merge(InfluxDB::Rails.current.tags)
-          result = configuration.tags_middleware.call(result)
-          result.reject! do |_, value|
-            value.nil? || value == ""
-          end
-          result
+        def values
+          raise NotImplementedError, "must be implemented in subclass"
         end
 
-        def enabled?
-          configuration.instrumentation_enabled? &&
-            !configuration.ignore_current_environment? &&
-            !configuration.ignored_hooks.include?(hook_name)
+        def duration
+          ((finish - start) * 1000).ceil
         end
 
-        def location
-          current = InfluxDB::Rails.current
-          [
-            current.controller,
-            current.action,
-          ].reject(&:blank?).join("#")
+        def disabled?
+          configuration.ignore_current_environment? ||
+            configuration.ignored_hooks.include?(hook_name)
         end
       end
     end

data/lib/influxdb/rails/railtie.rb

@@ -11,38 +11,35 @@ module InfluxDB
         end
 
         ActiveSupport.on_load(:action_controller) do
-          require "influxdb/rails/instrumentation"
-          include InfluxDB::Rails::Instrumentation
-
           before_action do
             current = InfluxDB::Rails.current
-            current.request_id = request.request_id if request.respond_to?(:request_id)
+            current.values = { request_id: request.request_id } if request.respond_to?(:request_id)
           end
         end
 
         cache = lambda do |_, _, _, _, payload|
           current = InfluxDB::Rails.current
-          current.controller = payload[:controller]
-          current.action     = payload[:action]
+          location = [payload[:controller], payload[:action]].join("#")
+          current.tags = { location: location }
         end
         ActiveSupport::Notifications.subscribe "start_processing.action_controller", &cache
 
         {
-          "process_action.action_controller" => Middleware::RequestSubscriber,
-          "render_template.action_view"      => Middleware::RenderSubscriber,
-          "render_partial.action_view"       => Middleware::RenderSubscriber,
-          "render_collection.action_view"    => Middleware::RenderSubscriber,
-          "sql.active_record"                => Middleware::SqlSubscriber,
-        }.each do |hook_name, subscriber_class|
-          subscribe_to(hook_name, subscriber_class)
+          "process_action.action_controller"     => Middleware::RequestSubscriber,
+          "render_template.action_view"          => Middleware::RenderSubscriber,
+          "render_partial.action_view"           => Middleware::RenderSubscriber,
+          "render_collection.action_view"        => Middleware::RenderSubscriber,
+          "sql.active_record"                    => Middleware::SqlSubscriber,
+          "instantiation.active_record"          => Middleware::ActiveRecordSubscriber,
+          "enqueue.active_job"                   => Middleware::ActiveJobSubscriber,
+          "perform.active_job"                   => Middleware::ActiveJobSubscriber,
+          "deliver.action_mailer"                => Middleware::ActionMailerSubscriber,
+          "block_instrumentation.influxdb_rails" => Middleware::BlockInstrumentationSubscriber,
+        }.each do |hook_name, subscriber|
+          ActiveSupport::Notifications.subscribe(hook_name, subscriber)
         end
       end
       # rubocop:enable Metrics/BlockLength
-
-      def subscribe_to(hook_name, subscriber_class)
-        subscriber = subscriber_class.new(InfluxDB::Rails.configuration, hook_name)
-        ActiveSupport::Notifications.subscribe hook_name, subscriber
-      end
     end
   end
 end

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

@@ -8,9 +8,9 @@ module InfluxDB
 
         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!(/(\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')

data/lib/influxdb/rails/tags.rb

@@ -0,0 +1,33 @@
+module InfluxDB
+  module Rails
+    class Tags
+      def initialize(config:, tags: {}, additional_tags: InfluxDB::Rails.current.tags)
+        @tags = tags
+        @config = config
+        @additional_tags = additional_tags
+      end
+
+      def to_h
+        expanded_tags.reject do |_, value|
+          value.to_s.blank?
+        end
+      end
+
+      private
+
+      attr_reader :additional_tags, :tags, :config
+
+      def expanded_tags
+        config.tags_middleware.call(tags.merge(default_tags))
+      end
+
+      def default_tags
+        {
+          server:   Socket.gethostname,
+          app_name: config.application_name,
+          location: :raw,
+        }.merge(additional_tags)
+      end
+    end
+  end
+end

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.to_s.blank?
+        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.2".freeze
   end
 end

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

@@ -11,6 +11,10 @@ InfluxDB::Rails.configure do |config|
   # config.client.username = "root"
   # config.client.password = "root"
 
+  ## If your InfluxDB service requires an HTTPS connection then you can
+  ## enable it here.
+  # config.client.use_ssl = true
+
   ## Various other client and connection options. These are used to create
   ## an `InfluxDB::Client` instance (i.e. `InfluxDB::Rails.client`).
   ##

data/sample-dashboard/Dockerfile

@@ -1,11 +1,11 @@
-FROM opensuse/leap:15.1
+FROM opensuse/leap:15.2
 
 ENV NOKOGIRI_USE_SYSTEM_LIBRARIES 1
 RUN useradd -g users -p rails -d /home/rails -m rails
 RUN echo 'rails ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
 
 RUN zypper -n addrepo -f https://dl.yarnpkg.com/rpm/yarn.repo; zypper --gpg-auto-import-keys refresh
-RUN zypper -n install --no-recommends ruby2.5-devel nodejs10 make gcc timezone sudo pkg-config sqlite3-devel libxml2-devel libxslt-devel yarn git-core curl
+RUN zypper -n install --no-recommends ruby2.5-devel nodejs10 make gcc-c++ timezone sudo pkg-config sqlite3-devel libxml2-devel libxslt-devel yarn git-core curl
 RUN zypper -n clean -a
 RUN gem install --no-format-executable --no-document rails -v '~> 6'
 

data/sample-dashboard/README.md

@@ -4,36 +4,42 @@ A dashboard providing Ruby on Rails performance insights based on
 [Free Software](https://www.fsf.org/about/what-is-free-software), ready to
 run inside your data-center.
 
-![Screenshot of the dashboard](https://grafana.com/api/dashboards/10428/images/6557/image)
+![Screenshot of the dashboard](https://grafana.com/api/dashboards/10428/images/10103/image)
 
-By default it measures (in various forms):
+By default it measures (in various forms) performance of:
 
-- Controller Action Runtime
-- View/Partial Render Runtime
-- Database Query Runtime
+- Controller Actions
+- View/Partial Rendering
+- Database Queries
+- ActiveJobs
+- ActionMailers
 
-It provides an overview and you can also drill down into numbers on a per request basis. Of course you can use all the awesome features that Influx (Downsampling/Data Retention), Grafana (Alerts, Annotations) and influxdb-rails (custom tags) provide and extend this to your needs. Use your freedom and run, copy, distribute, study, change and improve this software!
+The dashboards provide an overview and various ways to drill down into numbers on a per request or per action basis. Of course you can use all the awesome features that Influx (Downsampling/Data Retention), Grafana (Alerts, Annotations) and influxdb-rails (custom tags) provide and extend this to your needs. Use your freedom and run, copy, distribute, study, change and improve this software!
 
 ## Requirements
 
-To be able to measure performance you need the following things available:
+To be able to measure performance of your Ruby on Rails application you need to have the following things available:
 
-- [InfluxDB 1.x](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/)
-- [Grafana](https://grafana.com/docs/)
+- [InfluxDB 1.x](https://www.influxdata.com/products/influxdb/)
+- [Grafana](https://grafana.com/)
 - A [Ruby On Rails](https://rubyonrails.org/) application with [influxdb-rails](https://github.com/influxdata/influxdb-rails) enabled
 
 ## Installation
 
-Once you have influx/grafana instances running in your infrastructure just [import both
-dashboards from grafana](https://grafana.com/docs/reference/export_import/#importing-a-dashboard).
+Once you have influx/grafana instances running in your infrastructure just [import the
+dashboards from grafana.com](https://grafana.com/docs/reference/export_import/#importing-a-dashboard).
 
-- [Overview Dashboard](https://grafana.com/dashboards/10428)
-- [Request Dashboard](https://grafana.com/dashboards/10429)
+- [Ruby On Rails Performance Overview](https://grafana.com/dashboards/10428/)
+- Performance insights into individual requests, see [Ruby On Rails Performance per Request](https://grafana.com/dashboards/10429/)
+- Performance of individual actions, see [Ruby On Rails Performance per Action](https://grafana.com/grafana/dashboards/11031)
+- [Ruby On Rails Health Overview](https://grafana.com/grafana/dashboards/14115)
+- [Ruby on Rails ActiveJob Overview](https://grafana.com/grafana/dashboards/14116)
+- [Ruby on Rails Slowlog by Request](https://grafana.com/grafana/dashboards/14118)
+- [Ruby on Rails Slowlog by Action](https://grafana.com/grafana/dashboards/14117)
+- [Ruby on Rails Slowlog by SQL](https://grafana.com/grafana/dashboards/14119)
 
 You can also paste the `.json` files from this repository.
 
-In the unlikely case that you need to change the dashboard *UID*s during import you can configure the *UID* the `Overview` dashboard uses to link to the `Request` dashboard in the [variables](https://grafana.com/docs/reference/templating/#adding-a-variable). Just paste whatever *UID* you've set up for the `Request` dashboard.
-
 ## Demo
 
 This repository includes a [docker-compose](https://docs.docker.com/compose/) demo setup that brings a simple rails app, influxdb and grafana.
@@ -54,19 +60,6 @@ Go to http://0.0.0.0:4000 and do some things. Every request to the rails app wil
 
 You can also use the dashboard with any other rails app you already have. Follow our [install instructions](https://github.com/influxdata/influxdb-rails/#installation), the default configuration works with the demo InfluxDB running on localhost:8086.
 
-To be able to view individual requests you have to enable request ID tags in your application. Something like:
-
-```ruby
-class ApplicationController < ActionController::Base
-
-  before_action :set_influx_data
-
-  def set_influx_data
-    InfluxDB::Rails.current.values = { request: request.request_id }
-  end
-end
-```
-
 ### ...then see the dashboards in action
 
 Just go to http://0.0.0.0:3000 and log in with admin/admin.