instana 1.193.3.pre1 → 1.193.3

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

data/lib/instana/instrumentation/action_view.rb

@@ -0,0 +1,27 @@
+module Instana
+  module Instrumentation
+    module ActionView
+      def render_partial(*args)
+        call_payload = {
+          render: {
+            type: :partial,
+            name: @options.is_a?(Hash) ? @options[:partial].to_s : 'Unknown'
+          }
+        }
+
+        ::Instana::Tracer.trace(:render, call_payload) { super(*args) }
+      end
+
+      def render_collection(*args)
+        call_payload = {
+          render: {
+            type: :collection,
+            name: @path.to_s
+          }
+        }
+
+        ::Instana::Tracer.trace(:render, call_payload) { super(*args) }
+      end
+    end
+  end
+end

data/lib/instana/instrumentation/active_record.rb

@@ -0,0 +1,47 @@
+module Instana
+  module Instrumentation
+    module ActiveRecord
+      IGNORED_NAMES = %w[SCHEMA EXPLAIN CACHE].freeze
+      IGNORED_SQL = %w[BEGIN COMMIT SET].freeze
+      SANITIZE_REGEXP = /('[\s\S][^']*'|\d*\.\d+|\d+|NULL)/i.freeze
+
+      def log(sql, name = 'SQL', binds = [], *args)
+        call_payload = {
+          activerecord: {
+            adapter: @config[:adapter],
+            host: @config[:host],
+            username: @config[:username],
+            db: @config[:database],
+            sql: maybe_sanitize(sql)
+          }
+        }
+
+        if binds.all? { |b| b.respond_to?(:value_before_type_cast) }
+          mapped = binds.map(&:value_before_type_cast)
+          call_payload[:activerecord][:binds] = mapped
+        end
+
+        maybe_trace(call_payload, name) { super(sql, name, binds, *args) }
+      end
+
+      private
+
+      def maybe_sanitize(sql)
+        ::Instana.config[:sanitize_sql] ? sql.gsub(SANITIZE_REGEXP, '?') : sql
+      end
+
+      def maybe_trace(call_payload, name, &blk)
+        if ::Instana.tracer.tracing? && !ignored?(call_payload, name)
+          ::Instana.tracer.trace(:activerecord, call_payload, &blk)
+        else
+          yield
+        end
+      end
+
+      def ignored?(call_payload, name)
+        IGNORED_NAMES.include?(name) ||
+          IGNORED_SQL.any? { |s| call_payload[:activerecord][:sql].upcase.start_with?(s) }
+      end
+    end
+  end
+end

data/lib/instana/version.rb

@@ -1,4 +1,4 @@
 module Instana
-  VERSION = "1.193.3.pre1"
+  VERSION = "1.193.3"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/test/{frameworks/rails/actioncontroller_test.rb → instrumentation/rails_action_controller_test.rb}

@@ -1,6 +1,13 @@
 require 'test_helper'
 
-class ActionControllerTest < Minitest::Test
+class RailsActionControllerTest < Minitest::Test
+  include Rack::Test::Methods
+  APP = Rack::Builder.parse_file('test/support/apps/action_controller/config.ru').first
+
+  def app
+    APP
+  end
+
   def test_config_defaults
     assert ::Instana.config[:action_controller].is_a?(Hash)
     assert ::Instana.config[:action_controller].key?(:enabled)
@@ -10,33 +17,35 @@ class ActionControllerTest < Minitest::Test
   def test_controller_reporting
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/test/world'))
+    get '/base/world'
+    assert last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 3, spans.length
 
     ac_span = find_first_span_by_name(spans, :actioncontroller)
 
-    assert_equal "TestController", ac_span[:data][:actioncontroller][:controller]
+    assert_equal "TestBaseController", ac_span[:data][:actioncontroller][:controller]
     assert_equal "world", ac_span[:data][:actioncontroller][:action]
   end
 
   def test_controller_error
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/test/error'))
+    get '/base/error'
+    refute last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 2, spans.length
 
     ac_span = find_first_span_by_name(spans, :actioncontroller)
 
-    assert_equal "TestController", ac_span[:data][:actioncontroller][:controller]
+    assert_equal "TestBaseController", ac_span[:data][:actioncontroller][:controller]
     assert_equal "error", ac_span[:data][:actioncontroller][:action]
     assert ac_span.key?(:error)
     assert ac_span.key?(:stack)
     assert_equal "Warning: This is a simulated Error", ac_span[:data][:log][:message]
-    assert_equal "Exception", ac_span[:data][:log][:parameters]
+    assert_equal "StandardError", ac_span[:data][:log][:parameters]
   end
 
   def test_api_controller_reporting
@@ -45,7 +54,8 @@ class ActionControllerTest < Minitest::Test
 
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/api/world'))
+    get '/api/world'
+    assert last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 3, spans.length
@@ -53,7 +63,7 @@ class ActionControllerTest < Minitest::Test
     ac_span = find_first_span_by_name(spans, :actioncontroller)
 
     assert_equal :actioncontroller, ac_span[:n]
-    assert_equal "SocketController", ac_span[:data][:actioncontroller][:controller]
+    assert_equal "TestApiController", ac_span[:data][:actioncontroller][:controller]
     assert_equal "world", ac_span[:data][:actioncontroller][:action]
   end
 
@@ -63,28 +73,30 @@ class ActionControllerTest < Minitest::Test
 
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/api/error'))
+    get '/api/error'
+    refute last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 2, spans.length
 
     ac_span = find_first_span_by_name(spans, :actioncontroller)
 
-    assert_equal "SocketController", ac_span[:data][:actioncontroller][:controller]
+    assert_equal "TestApiController", ac_span[:data][:actioncontroller][:controller]
     assert_equal "error", ac_span[:data][:actioncontroller][:action]
     assert ac_span.key?(:error)
     assert ac_span.key?(:stack)
     assert_equal "Warning: This is a simulated Socket API Error", ac_span[:data][:log][:message]
-    assert_equal "Exception", ac_span[:data][:log][:parameters]
+    assert_equal "StandardError", ac_span[:data][:log][:parameters]
   end
 
-  def test_api_controller_404
+  def test_api_controller_not_found
     # Run only when ActionController::API is used/defined
     skip unless defined?(::ActionController::API)
 
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/api/thispathdoesnotexist'))
+    get '/api/thispathdoesnotexist'
+    refute last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 1, spans.length
@@ -103,7 +115,8 @@ class ActionControllerTest < Minitest::Test
 
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/api/raise_route_error'))
+    get '/api/raise_route_error'
+    refute last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 2, spans.length
@@ -121,10 +134,11 @@ class ActionControllerTest < Minitest::Test
     assert 1, ac_span[:ec]
   end
 
-  def test_404
+  def test_not_found
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/test/404'))
+    get '/base/404'
+    refute last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 1, spans.length
@@ -138,7 +152,8 @@ class ActionControllerTest < Minitest::Test
   def test_raise_routing_error
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/test/raise_route_error'))
+    get '/base/raise_route_error'
+    refute last_response.ok?
 
     spans = ::Instana.processor.queued_spans
     assert_equal 2, spans.length
@@ -153,16 +168,17 @@ class ActionControllerTest < Minitest::Test
     assert ac_span.key?(:stack)
     assert 1, ac_span[:ec]
   end
-  
+
   def test_path_template
     clear_all!
 
-    Net::HTTP.get(URI.parse('http://localhost:3205/test/world'))
-    
+    get '/base/world'
+    assert last_response.ok?
+
     spans = ::Instana.processor.queued_spans
     rack_span = find_first_span_by_name(spans, :rack)
 
     assert_equal false, rack_span.key?(:error)
-    assert_equal '/test/world(.:format)', rack_span[:data][:http][:path_tpl]
+    assert_equal '/base/world(.:format)', rack_span[:data][:http][:path_tpl]
   end
 end

data/test/instrumentation/rails_action_view_test.rb

@@ -0,0 +1,138 @@
+require 'test_helper'
+
+class RailsActionViewTest < Minitest::Test
+  include Rack::Test::Methods
+  APP = Rack::Builder.parse_file('test/support/apps/action_view/config.ru').first
+
+  def app
+    APP
+  end
+
+  def setup
+    clear_all!
+  end
+
+  def test_config_defaults
+    assert ::Instana.config[:action_view].is_a?(Hash)
+    assert ::Instana.config[:action_view].key?(:enabled)
+    assert_equal true, ::Instana.config[:action_view][:enabled]
+  end
+
+  def test_render_view
+    get '/render_view'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'Default', span[:data][:actionview][:name]
+  end
+
+  def test_render_nothing
+    # `render nothing: true` was removed in 5.1
+    skip unless Rails::VERSION::MAJOR <= 5 && Rails::VERSION::MINOR <= 1
+    get '/render_nothing'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'Nothing', span[:data][:actionview][:name]
+  end
+
+  def test_render_file
+    get '/render_file'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'test/support/apps/action_view/config.ru', span[:data][:actionview][:name]
+  end
+
+  def test_render_json
+    get '/render_json'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'JSON', span[:data][:actionview][:name]
+  end
+
+  def test_render_xml
+    get '/render_xml'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'XML', span[:data][:actionview][:name]
+  end
+
+  def test_render_body
+    get '/render_rawbody'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'Raw', span[:data][:actionview][:name]
+  end
+
+  def test_render_js
+    get '/render_js'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'Javascript', span[:data][:actionview][:name]
+  end
+
+  def test_render_alternate_layout
+    get '/render_alternate_layout'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :actionview)
+
+    assert_equal 'layouts/mobile', span[:data][:actionview][:name]
+  end
+
+  def test_render_partial
+    get '/render_partial'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :render)
+
+    assert_equal 'message', span[:data][:render][:name]
+  end
+
+  def test_render_partial_that_errors
+    get '/render_partial_that_errors'
+    refute last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :render)
+
+    assert_equal :partial, span[:data][:render][:type]
+    assert_equal 'syntax_error', span[:data][:render][:name]
+    assert span[:data][:log].key?(:message)
+    assert span[:data][:log][:parameters].include?('SyntaxError')
+    assert span[:error]
+    assert span[:stack]
+  end
+
+  def test_render_collection
+    get '/render_collection'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    span = find_first_span_by_name(spans, :render)
+
+    assert_equal :collection, span[:data][:render][:type]
+    assert_equal 'blocks/block', span[:data][:render][:name]
+  end
+end