instana 1.13.0 → 1.193.3

data/lib/instana/activators/rack.rb

@@ -0,0 +1,13 @@
+module Instana
+  module Activators
+    class Rack < Activator
+      def can_instrument?
+        defined?(::Rack)
+      end
+
+      def instrument
+        require 'instana/instrumentation/rack'
+      end
+    end
+  end
+end

data/lib/instana/activators/rails.rb

@@ -0,0 +1,15 @@
+module Instana
+  module Activators
+    class Rails < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) &&
+          defined?(::Rails) &&
+          defined?(::Rails::VERSION)
+      end
+
+      def instrument
+        require 'instana/frameworks/rails'
+      end
+    end
+  end
+end

data/lib/instana/activators/redis.rb

@@ -0,0 +1,17 @@
+module Instana
+  module Activators
+    class Redis < Activator
+      def can_instrument?
+        defined?(::Redis) && ::Instana.config[:redis][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/redis'
+
+        ::Redis::Client.prepend(::Instana::RedisInstrumentation)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/resque_client.rb

@@ -0,0 +1,18 @@
+module Instana
+  module Activators
+    class ResqueClient < Activator
+      def can_instrument?
+        defined?(::Resque) &&
+          ::Instana.config[:'resque-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/resque'
+
+        ::Resque.prepend(::Instana::Instrumentation::ResqueClient)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/resque_worker.rb

@@ -0,0 +1,30 @@
+module Instana
+  module Activators
+    class ResqueWorker < Activator
+      def can_instrument?
+        defined?(::Resque::Worker) &&
+          defined?(::Resque::Job) &&
+          ::Instana.config[:'resque-worker'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/resque'
+
+        ::Resque::Worker.prepend(::Instana::Instrumentation::ResqueWorker)
+        ::Resque::Job.prepend(::Instana::Instrumentation::ResqueJob)
+
+        ::Resque.before_fork do |_job|
+          ::Instana.agent.before_resque_fork
+        end
+        ::Resque.after_fork do |_job|
+          ::Instana.agent.after_resque_fork
+        end
+
+        # Set this so we assure that any remaining collected traces are reported at_exit
+        ENV['RUN_AT_EXIT_HOOKS'] = "1"
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/rest_client.rb

@@ -0,0 +1,17 @@
+module Instana
+  module Activators
+    class RestClient < Activator
+      def can_instrument?
+        defined?(::RestClient::Request) && ::Instana.config[:'rest-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/rest-client'
+
+        ::RestClient::Request.prepend ::Instana::Instrumentation::RestClientRequest
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/roda.rb

@@ -0,0 +1,18 @@
+module Instana
+  module Activators
+    class Roda < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) && defined?(::Roda)
+      end
+
+      def instrument
+        require 'instana/frameworks/roda'
+
+        ::Roda.use ::Instana::Rack
+        ::Roda.plugin ::Instana::RodaPathTemplateExtractor
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sidekiq_client.rb

@@ -0,0 +1,21 @@
+module Instana
+  module Activators
+    class SidekiqClient < Activator
+      def can_instrument?
+        defined?(::Sidekiq) && ::Instana.config[:'sidekiq-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/sidekiq-client'
+
+        ::Sidekiq.configure_client do |cfg|
+          cfg.client_middleware do |chain|
+            chain.add ::Instana::Instrumentation::SidekiqClient
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sidekiq_worker.rb

@@ -0,0 +1,21 @@
+module Instana
+  module Activators
+    class SidekiqWorker < Activator
+      def can_instrument?
+        defined?(::Sidekiq) && ::Instana.config[:'sidekiq-worker'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/sidekiq-worker'
+
+        ::Sidekiq.configure_server do |cfg|
+          cfg.server_middleware do |chain|
+            chain.add ::Instana::Instrumentation::SidekiqWorker
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sinatra.rb

@@ -0,0 +1,18 @@
+module Instana
+  module Activators
+    class Sinatra < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) && defined?(::Sinatra)
+      end
+
+      def instrument
+        require 'instana/frameworks/sinatra'
+
+        ::Sinatra::Base.use ::Instana::Rack
+        ::Sinatra::Base.register ::Instana::SinatraPathTemplateExtractor
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/config.rb

@@ -42,12 +42,23 @@ module Instana
       # ::Instana.config[:collect_backtraces] = true
       @config[:collect_backtraces] = false
 
+      # By default, collected SQL will be sanitized to remove potentially sensitive bind params such as:
+      #   > SELECT  "blocks".* FROM "blocks"  WHERE "blocks"."name" = "Mr. Smith"
+      #
+      # ...would be sanitized to be:
+      #   > SELECT  "blocks".* FROM "blocks"  WHERE "blocks"."name" = ?
+      #
+      # This sanitization step can be disabled by setting the following value to false.
+      # ::Instana.config[:sanitize_sql] = false
+      @config[:sanitize_sql] = true
+
       @config[:action_controller]  = { :enabled => true }
       @config[:action_view]        = { :enabled => true }
       @config[:active_record]      = { :enabled => true }
       @config[:dalli]              = { :enabled => true }
       @config[:excon]              = { :enabled => true }
       @config[:grpc]               = { :enabled => true }
+      @config[:graphql]            = { :enabled => true }
       @config[:nethttp]            = { :enabled => true }
       @config[:redis]              = { :enabled => true }
       @config[:'resque-client']    = { :enabled => true }

data/lib/instana/frameworks/cuba.rb

@@ -3,23 +3,23 @@ require "instana/rack"
 module Instana
   module CubaPathTemplateExtractor
     REPLACE_TARGET = /:(?<term>[^\/]+)/i
-    
+
     def self.prepended(base)
       ::Instana.logger.debug "#{base} prepended #{self}"
     end
-    
-    def on(*args, &blk) 
+
+    def on(*args, &blk)
       wrapper = lambda do |*caputres|
         env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] << args
           .select { |a| a.is_a?(String) }
           .join('/')
-      
+
         blk.call(*captures)
       end
-      
+
       super(*args, &wrapper)
     end
-    
+
     def call!(env)
       env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] = []
       response = super(env)
@@ -30,10 +30,3 @@ module Instana
     end
   end
 end
-
-
-if defined?(::Cuba)
-  ::Instana.logger.debug "Instrumenting Cuba"
-  Cuba.use ::Instana::Rack
-  Cuba.prepend ::Instana::CubaPathTemplateExtractor
-end

data/lib/instana/frameworks/rails.rb

@@ -1,40 +1,27 @@
-require "instana/rack"
+if ::Rails::VERSION::MAJOR < 3
+  ::Rails.configuration.after_initialize do
+    # In Rails, let's use the Rails logger
+    ::Instana.logger = ::Rails.logger if ::Rails.logger
 
-if defined?(::Rails)
-
-  if ::Rails::VERSION::MAJOR < 3
-    ::Rails.configuration.after_initialize do
-      # In Rails, let's use the Rails logger
-      ::Instana.logger = ::Rails.logger if ::Rails.logger
-
-      if ::Instana.config[:tracing][:enabled]
-        ::Instana.logger.debug "Instrumenting Rack"
-        ::Rails.configuration.middleware.insert 0, ::Instana::Rack
-      else
-        ::Instana.logger.info "Rack: Tracing disabled via config.  Not enabling middleware."
-      end
+    if ::Instana.config[:tracing][:enabled]
+      ::Instana.logger.debug "Instrumenting Rack"
+      ::Rails.configuration.middleware.insert 0, ::Instana::Rack
+    else
+      ::Instana.logger.info "Rack: Tracing disabled via config.  Not enabling middleware."
     end
-  else
-    module ::Instana
-      class Railtie < ::Rails::Railtie
-        initializer 'instana.rack' do |app|
-          # In Rails, let's use the Rails logger
-          ::Instana.logger = ::Rails.logger if ::Rails.logger
-
-          if ::Instana.config[:tracing][:enabled]
-            ::Instana.logger.debug "Instrumenting Rack"
-            app.config.middleware.insert 0, ::Instana::Rack
-          else
-            ::Instana.logger.info "Rack: Tracing disabled via config.  Not enabling middleware."
-          end
-        end
+  end
+else
+  module ::Instana
+    class Railtie < ::Rails::Railtie
+      initializer 'instana.rack' do |app|
+        # In Rails, let's use the Rails logger
+        ::Instana.logger = ::Rails.logger if ::Rails.logger
 
         if ::Instana.config[:tracing][:enabled]
-          config.after_initialize do
-            require "instana/frameworks/instrumentation/active_record"
-            require "instana/frameworks/instrumentation/action_controller"
-            require "instana/frameworks/instrumentation/action_view"
-          end
+          ::Instana.logger.debug "Instrumenting Rack"
+          app.config.middleware.insert 0, ::Instana::Rack
+        else
+          ::Instana.logger.info "Rack: Tracing disabled via config.  Not enabling middleware."
         end
       end
     end

data/lib/instana/frameworks/roda.rb

@@ -4,11 +4,11 @@ module Instana
   module RodaPathTemplateExtractor
     module RequestMethods
       TERM = defined?(::Roda) ? ::Roda::RodaPlugins::Base::RequestMethods::TERM : Object
-      
+
       def if_match(args, &blk)
         path = @remaining_path
         captures = @captures.clear
-  
+
         if match_all(args)
           (env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] ||= []).concat(named_args(args, blk))
           block_result(blk.(*captures))
@@ -21,10 +21,10 @@ module Instana
           false
         end
       end
-      
-      def named_args(args, blk)  
-        parameters = blk.parameters      
-        args.map do |a| 
+
+      def named_args(args, blk)
+        parameters = blk.parameters
+        args.map do |a|
           case a
           when String
             a
@@ -35,13 +35,7 @@ module Instana
             "{#{name}}"
           end
         end.compact
-      end  
+      end
     end
   end
 end
-
-if defined?(::Roda)
-  ::Instana.logger.debug "Instrumenting Roda"
-  Roda.use ::Instana::Rack
-  Roda.plugin ::Instana::RodaPathTemplateExtractor
-end

data/lib/instana/frameworks/sinatra.rb

@@ -6,10 +6,9 @@ require "instana/rack"
 module Instana
   module SinatraPathTemplateExtractor
     def self.extended(base)
-      ::Instana.logger.debug "#{base} extended #{self}"
       base.store_path_template
     end
-    
+
     def store_path_template
       after do
         @env["INSTANA_HTTP_PATH_TEMPLATE"] = @env["sinatra.route"]
@@ -18,9 +17,3 @@ module Instana
     end
   end
 end
-
-if defined?(::Sinatra)
-  ::Instana.logger.debug "Instrumenting Sinatra"
-  ::Sinatra::Base.use ::Instana::Rack
-  ::Sinatra::Base.register ::Instana::SinatraPathTemplateExtractor
-end

data/lib/instana/instrumentation/action_controller.rb

@@ -0,0 +1,81 @@
+module Instana
+  module Instrumentation
+    module ActionController
+      def process_action(*args)
+        call_payload = {
+          actioncontroller: {
+            controller: self.class.name,
+            action: action_name
+          }
+        }
+
+        request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
+        ::Instana::Tracer.trace(:actioncontroller, call_payload) { super(*args) }
+      end
+
+      def render(*args, &block)
+        call_payload = {
+          actionview: {
+            name: describe_render_options(args.first) || 'Default'
+          }
+        }
+
+        ::Instana::Tracer.trace(:actionview, call_payload) { super(*args, &block) }
+      end
+
+      private
+
+      def matched_path_template
+        Rails.application.routes.router.recognize(request) do |route, _, _|
+          path = route.path
+          return path.spec.to_s
+        end
+
+        nil
+      end
+
+      def describe_render_options(options)
+        return unless options
+
+        describe_layout(options[:layout]) ||
+          describe_direct(options)
+      end
+
+      def describe_layout(layout)
+        return unless layout
+
+        case layout
+        when FalseClass
+          'Without layout'
+        when String
+          layout
+        when Proc
+          'Proc'
+        else
+          'Default'
+        end
+      end
+
+      def describe_direct(options)
+        case options
+        when ->(o) { o.key?(:nothing) }
+          'Nothing'
+        when ->(o) { o.key?(:plain) }
+          'Plaintext'
+        when ->(o) { o.key?(:json) }
+          'JSON'
+        when ->(o) { o.key?(:xml) }
+          'XML'
+        when ->(o) { o.key?(:body) }
+          'Raw'
+        when ->(o) { o.key?(:js) }
+          'Javascript'
+        when ->(o) { o.key?(:template) }
+          options[:template]
+        when ->(o) { o.key?(:file) }
+          options[:file]
+        end
+      end
+    end
+  end
+end