instana 1.193.0 → 1.193.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fa2d34630db364163860954f67e65c38f76b6534e34b857cacaa2bc5fb06697
-  data.tar.gz: d458b50ec707675d06c5891b92af7e2efe1bb7c60d19713721e439a158060be9
+  metadata.gz: e0c2b0b0e44a5aa72f401d7ab7009125c25d182c01aa01aade80a8ca9f9fc55b
+  data.tar.gz: d147f265753ba3397773197b366f8a24f53a4e928ca8e08a929664c7d5029a1e
 SHA512:
-  metadata.gz: f6ac5ae188ddd4217d2f378690b88080c7cb3dd92375eac1feae16cd37dd9607b9332dce11c2df1408a7f0b4a24a5f79b6f3a26057a539ccb2a8c37963f900b7
-  data.tar.gz: e27dd436e1d4e0f7fdfdec35c1dcb252e32dce84d3eb8a06143d03bbb49dd839179da8d056c46080167cc9b9d940474a8678b341667c723006b1a9528a8c4b53
+  metadata.gz: 5bb4b908097b92adf0169f9ca71a43f82df4349b3257cc30cdbc2b8ba3ec13b62171e9c3ed14c1233421801795ebaba4c697c43776e9e31983af900db95d56ff
+  data.tar.gz: f7d415705c052ab4c85d446da325569a9940c1d7bfdeb782f17d263d78152585364203120e50c91737d29e992a146710df434874c46c58ce0107df14b5bc7cab

data/lib/instana/config.rb

@@ -42,6 +42,16 @@ 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 }

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

@@ -24,7 +24,13 @@ module Instana
       #
       def collect(sql)
         payload = { :activerecord => {} }
-        payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+
+        if ::Instana.config[:sanitize_sql]
+          payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+        else
+          payload[:activerecord][:sql] = sql
+        end
+
         payload[:activerecord][:adapter] = @config[:adapter]
         payload[:activerecord][:host] = @config[:host]
         payload[:activerecord][:db] = @config[:database]

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

@@ -21,7 +21,13 @@ module Instana
       #
       def collect(sql)
         payload = { :activerecord => {} }
-        payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+
+        if ::Instana.config[:sanitize_sql]
+          payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+        else
+          payload[:activerecord][:sql] = sql
+        end
+
         payload[:activerecord][:adapter] = @config[:adapter]
         payload[:activerecord][:host] = @config[:host]
         payload[:activerecord][:db] = @config[:database]

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

@@ -17,7 +17,6 @@ module Instana
           Instana::Util.method_alias(klass, :exec_delete)
           Instana::Util.method_alias(klass, :execute)
 
-
           @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
         end
       end
@@ -27,14 +26,33 @@ module Instana
       # @param sql [String]
       # @return [Hash] Hash of collected KVs
       #
-      def collect(sql)
+      def collect(sql, binds = nil)
         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]
+
+        if ::Instana.config[:sanitize_sql]
+          payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+        else
+          # No sanitization so raw SQL and collect up binds
+          payload[:activerecord][:sql] = sql
+
+          # FIXME: Only works on Rails 5 as the bind format varied in previous versions of Rails
+          if binds.is_a?(Array)
+            raw_binds = []
+            binds.each { |x| raw_binds << x.value_before_type_cast }
+            payload[:activerecord][:binds] = raw_binds
+          end
+        end
+
         payload
+      rescue Exception => e
+        ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" }
+      ensure
+        return payload
       end
 
       # In the spirit of ::ActiveRecord::ExplainSubscriber.ignore_payload?  There are
@@ -53,7 +71,7 @@ module Instana
           return exec_query_without_instana(sql, name, binds, *args)
         end
 
-        kv_payload = collect(sql)
+        kv_payload = collect(sql, binds)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
           exec_query_without_instana(sql, name, binds, *args)
         end
@@ -64,7 +82,7 @@ module Instana
           return exec_delete_without_instana(sql, name, binds)
         end
 
-        kv_payload = collect(sql)
+        kv_payload = collect(sql, binds)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
           exec_delete_without_instana(sql, name, binds)
         end

data/lib/instana/tracing/span.rb

@@ -57,9 +57,6 @@ module Instana
       end
 
       if ::Instana.config[:collect_backtraces]
-        # For entry spans, add a backtrace fingerprint
-        add_stack(limit: 2) if ENTRY_SPANS.include?(name)
-
         # Attach a backtrace to all exit spans
         add_stack if EXIT_SPANS.include?(name)
       end
@@ -76,9 +73,11 @@ module Instana
     #
     # @param limit [Integer] Limit the backtrace to the top <limit> frames
     #
-    def add_stack(limit: nil, stack: Kernel.caller)
+    def add_stack(limit: 30, stack: Kernel.caller)
       frame_count = 0
+      sanitized_stack = []
       @data[:stack] = []
+      limit = 40 if limit > 40
 
       stack.each do |i|
         # If the stack has the full instana gem version in it's path
@@ -86,18 +85,23 @@ module Instana
         if !i.match(/instana\/instrumentation\/rack.rb/).nil? ||
           (i.match(::Instana::VERSION_FULL).nil? && i.match('lib/instana/').nil?)
 
-          break if limit && frame_count >= limit
-
           x = i.split(':')
 
-          @data[:stack] << {
+          sanitized_stack << {
             :c => x[0],
             :n => x[1],
             :m => x[2]
           }
-         frame_count = frame_count + 1 if limit
         end
       end
+
+      if sanitized_stack.length > limit
+        # (limit * -1) gives us negative form of <limit> used for
+        # slicing from the end of the list. e.g. stack[-30, 30]
+        @data[:stack] = sanitized_stack[limit*-1, limit]
+      else
+        @data[:stack] = sanitized_stack
+      end
     end
 
     # Log an error into the span

data/lib/instana/version.rb

@@ -1,4 +1,4 @@
 module Instana
-  VERSION = "1.193.0"
+  VERSION = "1.193.1"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/test/frameworks/rack_test.rb

@@ -57,11 +57,7 @@ class RackTest < Minitest::Test
     assert rack_span[:f].key?(:e)
     assert rack_span[:f].key?(:h)
     assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
-
-    # Backtrace fingerprint validation
-    assert rack_span.key?(:stack)
-    assert_equal 2, rack_span[:stack].count
-    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert !rack_span.key?(:stack)
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false
@@ -233,11 +229,7 @@ class RackTest < Minitest::Test
     assert rack_span[:data][:http][:header].key?(:"X-Capture-This")
     assert !rack_span[:data][:http][:header].key?(:"X-Capture-That")
     assert_equal "ThereYouGo", rack_span[:data][:http][:header][:"X-Capture-This"]
-
-    # Backtrace fingerprint validation
-    assert rack_span.key?(:stack)
-    assert_equal 2, rack_span[:stack].count
-    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert !rack_span.key?(:stack)
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false

data/test/frameworks/rails/activerecord_test.rb

@@ -2,7 +2,14 @@ require 'test_helper'
 require 'active_record'
 
 class ActiveRecordTest < Minitest::Test
+
+  def teardown
+    # Make sure defaults are back in place
+    ::Instana.config[:sanitize_sql] = true
+  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]
@@ -28,19 +35,14 @@ class ActiveRecordTest < Minitest::Test
       assert span[:data][:activerecord].key?(:username)
     end
 
-
-    found = false
     if ::Rails::VERSION::MAJOR < 4
       sql = "INSERT INTO \"blocks\" (\"color\", \"created_at\", \"name\", \"updated_at\") VALUES ($?, $?, $?, $?) RETURNING \"id\""
     else
       sql = "INSERT INTO \"blocks\" (\"name\", \"color\", \"created_at\", \"updated_at\") VALUES ($?, $?, $?, $?) RETURNING \"id\""
     end
-    ar_spans.each do |span|
-      if span[:data][:activerecord][:sql] ==
-        found = true
-      end
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == sql
     end
-    assert found
 
     found = false
     if ::Rails::VERSION::MAJOR >= 5
@@ -50,12 +52,9 @@ class ActiveRecordTest < Minitest::Test
     else
       sql = "SELECT  \"blocks\".* FROM \"blocks\"  WHERE \"blocks\".\"name\" = ? LIMIT ?"
     end
-    ar_spans.each do |span|
-      if span[:data][:activerecord][:sql] == sql
-        found = true
-      end
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == sql
     end
-    assert found
 
     found = false
     if ::Rails::VERSION::MAJOR == 3
@@ -63,12 +62,73 @@ class ActiveRecordTest < Minitest::Test
     else
       sql = "DELETE FROM \"blocks\" WHERE \"blocks\".\"id\" = $?"
     end
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == sql
+    end
+  end
+
+  def test_postgresql_without_sanitize
+    skip unless ::Instana::Test.postgresql?
+
+    # Shut SQL sanitization off
+    ::Instana.config[:sanitize_sql] = false
+    # Pause so the thread can syncronize values
+    sleep 1
+
+    clear_all!
+
+    Net::HTTP.get(URI.parse('http://localhost:3205/test/db'))
+
+    spans = Instana.processor.queued_spans
+    assert_equal 6, spans.length
+    rack_span = find_first_span_by_name(spans, :rack)
+
+    ar_spans = find_spans_by_name(spans, :activerecord)
+    assert_equal 3, ar_spans.length
+
     ar_spans.each do |span|
-      if span[:data][:activerecord][:sql] == sql
-        found = true
-      end
+      assert_equal "postgresql", span[:data][:activerecord][:adapter]
+      assert span[:data][:activerecord].key?(:host)
+      assert span[:data][:activerecord].key?(:username)
+    end
+
+    if ::Rails::VERSION::MAJOR < 4
+      sql = "INSERT INTO \"blocks\" (\"color\", \"created_at\", \"name\", \"updated_at\") VALUES ($1, $2, $3, $4) RETURNING \"id\""
+    else
+      sql = "INSERT INTO \"blocks\" (\"name\", \"color\", \"created_at\", \"updated_at\") VALUES ($1, $2, $3, $4) RETURNING \"id\""
     end
-    assert found
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == sql
+    end
+    assert ar_span[:data][:activerecord].key?(:binds)
+    assert ar_span[:data][:activerecord][:binds].is_a?(Array)
+    assert_equal 4, ar_span[:data][:activerecord][:binds].length
+
+    if ::Rails::VERSION::MAJOR >= 5
+      sql = "SELECT  \"blocks\".* FROM \"blocks\" WHERE \"blocks\".\"name\" = $1 ORDER BY \"blocks\".\"id\" ASC LIMIT $2"
+    elsif ::Rails::VERSION::MAJOR == 4
+      sql = "SELECT  \"blocks\".* FROM \"blocks\" WHERE \"blocks\".\"name\" = $?  ORDER BY \"blocks\".\"id\" ASC LIMIT ?"
+    else
+      sql = "SELECT  \"blocks\".* FROM \"blocks\"  WHERE \"blocks\".\"name\" = ? LIMIT ?"
+    end
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == sql
+    end
+    assert ar_span[:data][:activerecord].key?(:binds)
+    assert ar_span[:data][:activerecord][:binds].is_a?(Array)
+    assert_equal 2, ar_span[:data][:activerecord][:binds].length
+
+    if ::Rails::VERSION::MAJOR == 3
+      sql = "DELETE FROM \"blocks\" WHERE \"blocks\".\"id\" = 1"
+    else
+      sql = "DELETE FROM \"blocks\" WHERE \"blocks\".\"id\" = $1"
+    end
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == sql
+    end
+    assert ar_span[:data][:activerecord].key?(:binds)
+    assert ar_span[:data][:activerecord][:binds].is_a?(Array)
+    assert_equal 1, ar_span[:data][:activerecord][:binds].length
   end
 
   def test_postgresql_lock_table
@@ -93,21 +153,13 @@ class ActiveRecordTest < Minitest::Test
       assert_equal "postgres", ar_span[:data][:activerecord][:username]
     end
 
-    found = false
-    ar_spans.each do |span|
-      if span[:data][:activerecord][:sql] == "LOCK blocks IN ACCESS EXCLUSIVE MODE"
-        found = true
-      end
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == "LOCK blocks IN ACCESS EXCLUSIVE MODE"
     end
-    assert found
 
-    found = false
-    ar_spans.each do |span|
-      if span[:data][:activerecord][:sql] == "SELECT ?"
-        found = true
-      end
+    ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+      span[:data][:activerecord][:sql] == "SELECT ?"
     end
-    assert found
   end
 
   def test_postgresql_raw_execute

data/test/instrumentation/excon_test.rb

@@ -116,8 +116,6 @@ class ExconTest < Minitest::Test
     assert_equal 3, rack_spans.length
     assert_equal 3, excon_spans.length
 
-    # ::Instana::Util.pry!
-
     for rack_span in rack_spans
       # data keys/values
       refute_nil rack_span.key?(:data)

data/test/instrumentation/redis_test.rb

@@ -20,6 +20,16 @@ class RedisTest < Minitest::Test
     assert_redis_trace('SET')
   end
 
+  def test_georadius
+    clear_all!
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      @redis_client.georadius('Sicily', '15', '37', '200', 'km', 'WITHCOORD', 'WITHDIST')
+    end
+
+    assert_redis_trace('GEORADIUS')
+  end
+
   def test_normal_call_with_error
     clear_all!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.193.0
+  version: 1.193.1
 platform: ruby
 authors:
 - Peter Giacomo Lombardo