scout_apm 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f23c7ac5d4eb5fd3377ec8d9c4aa9f57a5fc356
-  data.tar.gz: 72c4e84ceeae582c401e30343c0f0594c79036cc
+  metadata.gz: 32c7de1b69ce4dfb33779efa5ac201c95d155cf7
+  data.tar.gz: 9179a6163ebe2a3277d589fc9e20a77d715b17e5
 SHA512:
-  metadata.gz: 7ae0882e14379a6a1d87923f20500fa9508cc8e63438788db0d9ee98ae773413a2f3a3d1aef9fee9977447cda1f10593f91de92837b8ee168e7a18c058b023ab
-  data.tar.gz: 93197ba1fdf634b6ccf399ba1e73363abc21d0604ae71f75537f5280e50480855c280b4f11690be2c32d8e780a85011d5f8ac3f49fe6e256a138c7b71c9e5ea6
+  metadata.gz: 85f3023eec77d1884e7beebf3d1d2a08ac0126405c25db4fa3533edd90d40ce4439a6f87029ae5922f4db1063a4a14765b16e4bc9e92a2698423c2556d479321
+  data.tar.gz: a2c3ba865dff42734b1cf6dd7a712ff102e948f53a0f7087fb29be6bca8505d48b7aa73f1b39d7d84685b594c50df52aff1518eb8f8553d893172b52f95b3a42

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 1.4.5
+
+* Instrument Elasticsearch
+* Instrument InfluxDB
+
 # 1.4.4
 
 * Instrument Mongoid

data/lib/scout_apm.rb

@@ -63,6 +63,8 @@ require 'scout_apm/instruments/http_client'
 require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
 require 'scout_apm/instruments/redis'
+require 'scout_apm/instruments/influxdb'
+require 'scout_apm/instruments/elasticsearch'
 require 'scout_apm/instruments/delayed_job'
 require 'scout_apm/instruments/active_record'
 require 'scout_apm/instruments/action_controller_rails_2'

data/lib/scout_apm/agent.rb

@@ -254,6 +254,8 @@ module ScoutApm
       install_instrument(ScoutApm::Instruments::NetHttp)
       install_instrument(ScoutApm::Instruments::HttpClient)
       install_instrument(ScoutApm::Instruments::Redis)
+      install_instrument(ScoutApm::Instruments::InfluxDB)
+      install_instrument(ScoutApm::Instruments::Elasticsearch)
 
       if StackProf.respond_to?(:fake?) && StackProf.fake?
         logger.info 'StackProf not found - add `gem "stackprof"` to your Gemfile to enable advanced code profiling (only for Ruby 2.1+)'

data/lib/scout_apm/instruments/elasticsearch.rb

@@ -0,0 +1,77 @@
+module ScoutApm
+  module Instruments
+    class Elasticsearch
+      attr_reader :logger
+
+      def initalize(logger=ScoutApm::Agent.instance.logger)
+        @logger = logger
+        @installed = false
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install
+        @installed = true
+
+        if defined?(::Elasticsearch) &&
+            defined?(::Elasticsearch::Transport) &&
+            defined?(::Elasticsearch::Transport::Client)
+
+          ScoutApm::Agent.instance.logger.info "Instrumenting Elasticsearch"
+
+          ::Elasticsearch::Transport::Client.class_eval do
+            include ScoutApm::Tracer
+
+            def perform_request_with_scout_instruments(*args, &block)
+              name = _sanitize_name(args[1])
+
+              self.class.instrument("Elasticsearch", name, :ignore_children => true) do
+                perform_request_without_scout_instruments(*args, &block)
+              end
+            end
+
+            alias_method :perform_request_without_scout_instruments, :perform_request
+            alias_method :perform_request, :perform_request_with_scout_instruments
+
+            def _sanitize_name(name)
+              name = name.split("/").last.gsub(/^_/, '')
+              allowed_names = ["bench",
+                               "bulk",
+                               "count",
+                               "exists",
+                               "explain",
+                               "field_stats",
+                               "health",
+                               "mget",
+                               "mlt",
+                               "mpercolate",
+                               "msearch",
+                               "mtermvectors",
+                               "percolate",
+                               "query",
+                               "scroll",
+                               "search_shards",
+                               "source",
+                               "suggest",
+                               "template",
+                               "termvectors",
+                               "update",
+                               "search", ]
+
+              if allowed_names.include?(name)
+                name
+              else
+                "Unknown"
+              end
+            rescue
+              "Unknown"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/scout_apm/instruments/influxdb.rb

@@ -0,0 +1,45 @@
+module ScoutApm
+  module Instruments
+    class InfluxDB
+      attr_reader :logger
+
+      def initalize(logger=ScoutApm::Agent.instance.logger)
+        @logger = logger
+        @installed = false
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install
+        @installed = true
+
+        if defined?(::InfluxDB)
+          ScoutApm::Agent.instance.logger.debug "Instrumenting InfluxDB"
+
+          ::InfluxDB::Client.class_eval do
+            include ScoutApm::Tracer
+          end
+
+          ::InfluxDB::HTTP.module_eval do
+            def do_request_with_scout_instruments(http, req, data = nil)
+              params = req.path[1..-1].split("?").last
+              cleaned_params = CGI.unescape(params).gsub(/(\s{2,})/,' ')
+
+              self.class.instrument("InfluxDB",
+                                    "#{req.path[1..-1].split("?").first.capitalize}",
+                                    :desc => cleaned_params,
+                                    :ignore_children => true) do
+                do_request_without_scout_instruments(http, req, data)
+              end
+            end
+
+            alias_method :do_request_without_scout_instruments, :do_request
+            alias_method :do_request, :do_request_with_scout_instruments
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/tracer.rb

@@ -34,8 +34,8 @@ module ScoutApm
         begin
           yield
         ensure
-          req.stop_layer
           req.acknowledge_children! if options[:ignore_children]
+          req.stop_layer
         end
       end
 

data/lib/scout_apm/tracked_request.rb

@@ -40,14 +40,20 @@ module ScoutApm
     end
 
     def start_layer(layer)
+      if ignoring_children?
+        ScoutApm::Agent.instance.logger.info("Skipping layer because we're ignoring children: #{layer.inspect}")
+        return
+      end
+
       start_request(layer) unless @root_layer
 
-      # ScoutApm::Agent.instance.logger.info("Starting Layer: #{layer.to_s}")
       @layers[-1].add_child(layer) if @layers.any?
       @layers.push(layer)
     end
 
     def stop_layer
+      return if ignoring_children?
+
       layer = @layers.pop
       layer.record_stop_time!
 
@@ -160,6 +166,9 @@ module ScoutApm
     # internally
     #
     # When enabled, new layers won't be added to the current Request.
+    #
+    # Do not forget to turn if off when leaving a layer, it is the
+    # instrumentation's task to do that.
 
     def ignore_children!
       @ignoring_children = true
@@ -168,5 +177,9 @@ module ScoutApm
     def acknowledge_children!
       @ignoring_children = false
     end
+
+    def ignoring_children?
+      @ignoring_children
+    end
   end
 end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.4.4"
+  VERSION = "1.4.5"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -92,7 +92,9 @@ files:
 - lib/scout_apm/instruments/action_controller_rails_3_rails4.rb
 - lib/scout_apm/instruments/active_record.rb
 - lib/scout_apm/instruments/delayed_job.rb
+- lib/scout_apm/instruments/elasticsearch.rb
 - lib/scout_apm/instruments/http_client.rb
+- lib/scout_apm/instruments/influxdb.rb
 - lib/scout_apm/instruments/middleware_detailed.rb
 - lib/scout_apm/instruments/middleware_summary.rb
 - lib/scout_apm/instruments/mongoid.rb