instana 1.193.3.pre1 → 1.193.3

data/test/instrumentation/rails_active_record_test.rb

@@ -0,0 +1,121 @@
+require 'test_helper'
+require 'support/apps/active_record/active_record'
+
+require 'irb'
+
+class RailsActiveRecordTest < Minitest::Test
+  def setup
+    skip unless ENV['DATABASE_URL']
+    @connection = ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.run(CreateBlocks, direction: :up)
+    end
+  end
+
+  def teardown
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.run(CreateBlocks, direction: :down)
+    end
+    ActiveRecord::Base.remove_connection(@connection)
+  end
+
+  def test_config_defaults
+    assert ::Instana.config[:sanitize_sql] == true
+    assert ::Instana.config[:active_record].is_a?(Hash)
+    assert ::Instana.config[:active_record].key?(:enabled)
+    assert_equal true, ::Instana.config[:active_record][:enabled]
+  end
+
+  def test_create
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      Block.create(name: 'core', color: 'blue')
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('INSERT INTO')
+    assert 'core', data[:binds][0]
+    assert 'blue', data[:binds][1]
+  end
+
+  def test_read
+    Block.create(name: 'core', color: 'blue')
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      Block.find_by(name: 'core')
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('SELECT')
+    assert 'core', data[:binds][0]
+    assert 1, data[:binds][1]
+  end
+
+  def test_update
+    Block.create(name: 'core', color: 'blue')
+    b = Block.find_by(name: 'core')
+
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      b.color = 'red'
+      b.save
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('UPDATE')
+    assert 'red', data[:binds][0]
+    assert 1, data[:binds][2]
+  end
+
+  def test_delete
+    b = Block.create(name: 'core', color: 'blue')
+
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      b.delete
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('DELETE')
+    assert 1, data[:binds][0]
+  end
+
+  def test_raw
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      ActiveRecord::Base.connection.execute('SELECT 1')
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert 'SELECT 1', data[:sql]
+  end
+
+  def test_raw_error
+    assert_raises ActiveRecord::StatementInvalid do
+      Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+        ActiveRecord::Base.connection.execute('INVALID')
+      end
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+
+    assert_equal 1, span[:ec]
+  end
+end

data/test/support/apps/active_record/active_record.rb

@@ -0,0 +1,21 @@
+require 'rails'
+require 'active_record/railtie'
+
+migration_class = if ActiveRecord::Migration.respond_to?(:[])
+                    ActiveRecord::Migration[4.2]
+                  else
+                    ActiveRecord::Migration
+                  end
+
+class CreateBlocks < migration_class
+  def change
+    create_table :blocks do |t|
+      t.string :name
+      t.string :color
+      t.timestamps
+    end
+  end
+end
+
+class Block < ActiveRecord::Base
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.193.3.pre1
+  version: 1.193.3
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -196,6 +196,10 @@ files:
 - instana.gemspec
 - lib/instana.rb
 - lib/instana/activator.rb
+- lib/instana/activators/action_controller_api.rb
+- lib/instana/activators/action_controller_base.rb
+- lib/instana/activators/action_view.rb
+- lib/instana/activators/active_record.rb
 - lib/instana/activators/cuba.rb
 - lib/instana/activators/dalli.rb
 - lib/instana/activators/excon.rb
@@ -226,17 +230,13 @@ files:
 - lib/instana/eum/eum-test.js.erb
 - lib/instana/eum/eum.js.erb
 - lib/instana/frameworks/cuba.rb
-- lib/instana/frameworks/instrumentation/abstract_mysql_adapter.rb
-- lib/instana/frameworks/instrumentation/action_controller.rb
-- lib/instana/frameworks/instrumentation/action_view.rb
-- lib/instana/frameworks/instrumentation/active_record.rb
-- lib/instana/frameworks/instrumentation/mysql2_adapter.rb
-- lib/instana/frameworks/instrumentation/mysql_adapter.rb
-- lib/instana/frameworks/instrumentation/postgresql_adapter.rb
 - lib/instana/frameworks/rails.rb
 - lib/instana/frameworks/roda.rb
 - lib/instana/frameworks/sinatra.rb
 - lib/instana/helpers.rb
+- lib/instana/instrumentation/action_controller.rb
+- lib/instana/instrumentation/action_view.rb
+- lib/instana/instrumentation/active_record.rb
 - lib/instana/instrumentation/dalli.rb
 - lib/instana/instrumentation/excon.rb
 - lib/instana/instrumentation/graphql.rb
@@ -270,12 +270,6 @@ files:
 - test/benchmarks/bench_opentracing.rb
 - test/config_test.rb
 - test/frameworks/cuba_test.rb
-- test/frameworks/rails/actioncontroller_test.rb
-- test/frameworks/rails/actionview3_test.rb
-- test/frameworks/rails/actionview4_test.rb
-- test/frameworks/rails/actionview5_test.rb
-- test/frameworks/rails/activerecord_test.rb
-- test/frameworks/rails_test.rb
 - test/frameworks/roda_test.rb
 - test/frameworks/sinatra_test.rb
 - test/instana_test.rb
@@ -286,12 +280,16 @@ files:
 - test/instrumentation/net_http_test.rb
 - test/instrumentation/rack_instrumented_request_test.rb
 - test/instrumentation/rack_test.rb
+- test/instrumentation/rails_action_controller_test.rb
+- test/instrumentation/rails_action_view_test.rb
+- test/instrumentation/rails_active_record_test.rb
 - test/instrumentation/redis_test.rb
 - test/instrumentation/resque_test.rb
 - test/instrumentation/rest_client_test.rb
 - test/instrumentation/sidekiq-client_test.rb
 - test/instrumentation/sidekiq-worker_test.rb
 - test/secrets_test.rb
+- test/support/apps/active_record/active_record.rb
 - test/support/apps/grpc/boot.rb
 - test/support/apps/grpc/grpc_server.rb
 - test/support/apps/http_endpoint/boot.rb
@@ -331,9 +329,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.6
 signing_key: 
@@ -351,12 +349,15 @@ test_files:
 - test/secrets_test.rb
 - test/instrumentation/graphql_test.rb
 - test/instrumentation/sidekiq-client_test.rb
+- test/instrumentation/rails_action_controller_test.rb
 - test/instrumentation/rest_client_test.rb
 - test/instrumentation/net_http_test.rb
 - test/instrumentation/resque_test.rb
 - test/instrumentation/sidekiq-worker_test.rb
+- test/instrumentation/rails_action_view_test.rb
 - test/instrumentation/rack_test.rb
 - test/instrumentation/rack_instrumented_request_test.rb
+- test/instrumentation/rails_active_record_test.rb
 - test/instrumentation/redis_test.rb
 - test/instrumentation/dalli_test.rb
 - test/instrumentation/excon_test.rb
@@ -368,6 +369,7 @@ test_files:
 - test/support/apps/sidekiq/worker.rb
 - test/support/apps/grpc/boot.rb
 - test/support/apps/grpc/grpc_server.rb
+- test/support/apps/active_record/active_record.rb
 - test/support/apps/resque/boot.rb
 - test/support/apps/resque/jobs/resque_error_job.rb
 - test/support/apps/resque/jobs/resque_fast_job.rb
@@ -380,11 +382,5 @@ test_files:
 - test/test_helper.rb
 - test/frameworks/cuba_test.rb
 - test/frameworks/roda_test.rb
-- test/frameworks/rails_test.rb
 - test/frameworks/sinatra_test.rb
-- test/frameworks/rails/actionview4_test.rb
-- test/frameworks/rails/activerecord_test.rb
-- test/frameworks/rails/actioncontroller_test.rb
-- test/frameworks/rails/actionview5_test.rb
-- test/frameworks/rails/actionview3_test.rb
 - test/instana_test.rb

data/lib/instana/frameworks/instrumentation/abstract_mysql_adapter.rb

@@ -1,56 +0,0 @@
-module Instana
-  module Instrumentation
-    module AbstractMysqlAdapter
-      IGNORED_PAYLOADS = %w(SCHEMA EXPLAIN CACHE).freeze
-      EXPLAINED_SQLS = /\A\s*(with|select|update|delete|insert)\b/i
-
-      # This module supports instrumenting ActiveRecord with the mysql2 adapter.
-      #
-      def self.prepended(klass)
-        if ActiveRecord::VERSION::STRING >= '3.2'
-          @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
-        end
-      end
-
-      # Collect up this DB connection info for reporting.
-      #
-      # @param sql [String]
-      # @return [Hash] Hash of collected KVs
-      #
-      def collect(sql)
-        payload = { :activerecord => {} }
-        payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
-        payload[:activerecord][:adapter] = @config[:adapter]
-        payload[:activerecord][:host] = @config[:host]
-        payload[:activerecord][:db] = @config[:database]
-        payload[:activerecord][:username] = @config[:username]
-        payload
-      end
-
-      # In the spirit of ::ActiveRecord::ExplainSubscriber.ignore_payload?  There are
-      # only certain calls that we're interested in tracing.  e.g. No use to instrument
-      # framework caches.
-      #
-      # @param payload [String]
-      # @return [Boolean]
-      #
-      def ignore_payload?(name, sql)
-        IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
-      end
-
-      def execute(sql, name = nil)
-        tracing = ::Instana.tracer.tracing?
-        if !tracing || ignore_payload?(name, sql)
-          return super(sql, name)
-        elsif ::Instana.tracer.current_span[:n] == :activerecord
-          return super(sql, name)
-        end
-
-        kv_payload = collect(sql)
-        ::Instana.tracer.trace(:activerecord, kv_payload) do
-          super(sql, name)
-        end
-      end
-    end
-  end
-end

data/lib/instana/frameworks/instrumentation/action_controller.rb

@@ -1,194 +0,0 @@
-module Instana
-  module Instrumentation
-
-    # Contains the methods common to both ::Instana::Instrumentation::ActionController
-    # and ::Instana::Instrumentation::ActionControllerLegacy
-    #
-    module ActionControllerCommon
-
-      # Indicates whether a Controller rescue handler is in place.  If so, this affects
-      # error logging and reporting. (Hence the need for this method).
-      #
-      # @return [Boolean]
-      #
-      def has_rails_handler?(exception)
-        found = false
-        rescue_handlers.detect do |klass_name, _handler|
-          # Rescue handlers can be specified as strings or constant names
-          klass = self.class.const_get(klass_name) rescue nil
-          klass ||= klass_name.constantize rescue nil
-          found = exception.is_a?(klass) if klass
-        end
-        found
-      rescue => e
-        ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" }
-        return false
-      end
-
-      # Render can be called with many options across the various supported
-      # versions of Rails.  This method attempts to make sense and provide
-      # insight into what is happening (rendering a layout, file, nothing,
-      # plaintext etc.)
-      def get_render_topic(opts)
-        if opts.key?(:layout)
-          case opts[:layout]
-          when FalseClass
-            name = "Without layout"
-          when String
-            name = opts[:layout]
-          when Proc
-            name = "Proc"
-          else
-            name = "Default"
-          end
-        end
-
-        return name if name
-
-        if opts.key?(:template)
-          name ||= opts[:template]
-        elsif opts.key?(:file)
-          name ||= opts[:file]
-        elsif opts.key?(:nothing)
-          name = "Nothing"
-        elsif opts.key?(:plain)
-          name = "Plaintext"
-        elsif opts.key?(:json)
-          name = "JSON"
-        elsif opts.key?(:xml)
-          name = "XML"
-        elsif opts.key?(:body)
-          name = "Raw"
-        elsif opts.key?(:js)
-          name = "Javascript"
-        end
-        name
-      end
-      
-      def matched_path_template
-        Rails.application.routes.router.recognize(request) do |route, _, _|
-          path = route.path
-          return path.spec.to_s
-        end
-        
-        nil
-      end
-    end
-
-    # Used in ActionPack versions 5 and beyond, this module provides
-    # instrumentation for ActionController (a part of ActionPack)
-    #
-    module ActionController
-      include ::Instana::Instrumentation::ActionControllerCommon
-
-      # This is the Rails 5 version of the process_action method where we use prepend to
-      # instrument the class method instead of using the older alias_method_chain.
-      #
-      def process_action(*args)
-        kv_payload = { :actioncontroller => {} }
-        kv_payload[:actioncontroller][:controller] = self.class.name
-        kv_payload[:actioncontroller][:action] = action_name
-
-        ::Instana.tracer.log_entry(:actioncontroller, kv_payload)
-
-        super(*args)
-        request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
-      rescue Exception => e
-        ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:actioncontroller)
-      end
-
-      # The Instana wrapper method for ActionController::Base.render
-      # for versions 5+.
-      #
-      def render(*args, &blk)
-        # Figure out what's being rendered
-        if args.length > 0 && args[0].is_a?(Hash)
-          name = get_render_topic(args[0])
-        end
-        name ||= "Default"
-
-        ::Instana.tracer.log_entry(:actionview, :actionview => { :name => name })
-
-        super(*args, &blk)
-      rescue Exception => e
-        ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:actionview)
-      end
-    end
-
-    # Used in ActionPack versions 4 and earlier, this module provides
-    # instrumentation for ActionController (a part of ActionPack)
-    #
-    module ActionControllerLegacy
-      include ::Instana::Instrumentation::ActionControllerCommon
-
-      def self.included(klass)
-        klass.class_eval do
-          alias_method_chain :process_action, :instana
-          alias_method_chain :render, :instana
-        end
-      end
-
-      # The Instana wrapper method for ActionController::Base.process_action
-      # for versions 3 and 4.
-      #
-      def process_action_with_instana(*args)
-        kv_payload = { :actioncontroller => {} }
-        kv_payload[:actioncontroller][:controller] = self.class.name
-        kv_payload[:actioncontroller][:action] = action_name
-
-        ::Instana.tracer.log_entry(:actioncontroller, kv_payload)
-
-        process_action_without_instana(*args)
-        request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
-      rescue Exception => e
-        ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:actioncontroller)
-      end
-
-      # The Instana wrapper method for ActionController::Base.render
-      # for versions 3 and 4.
-      #
-      def render_with_instana(*args, &blk)
-        if args.length > 0 && args[0].is_a?(Hash)
-          name = get_render_topic(args[0])
-        end
-        name ||= "Default"
-        ::Instana.tracer.log_entry(:actionview, :actionview => { :name => name })
-        render_without_instana(*args, &blk)
-      rescue Exception => e
-        ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:actionview)
-      end
-    end
-  end
-end
-
-if defined?(::ActionController) && ::Instana.config[:action_controller][:enabled] && ::ActionPack::VERSION::MAJOR >= 2
-  ::Instana.logger.debug "Instrumenting ActionController"
-  if ActionPack::VERSION::MAJOR >= 5
-    ::ActionController::Base.send(:prepend, ::Instana::Instrumentation::ActionController)
-  else
-    ::ActionController::Base.send(:include, ::Instana::Instrumentation::ActionControllerLegacy)
-  end
-end
-
-# ActionController::API was introduced in Ruby on Rails 5 but was originally an independent project before being
-# rolled into the Rails ActionPack.  In case, someone is using the independent project or potentially backported
-# the rails version to and older Ruby on Rails version, we only limit in a minimal way re: version checking.
-#
-# We allow ActionController::API instrumentation in version of Ruby on Rails 3 and higher.
-#
-if defined?(::ActionController::API) && ::Instana.config[:action_controller][:enabled] && ::ActionPack::VERSION::MAJOR >= 3
-  ::Instana.logger.debug "Instrumenting ActionController API"
-  ::ActionController::API.send(:prepend, ::Instana::Instrumentation::ActionController)
-end