instana 1.9.6 → 1.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3d6441f6a619ad0643ea9a9afbcebefd86d57171dc14cc12eccd71dbbbb0db8
-  data.tar.gz: b4b5ea14c821e9a3b53cc9e41b4a0e5e4a9026ec586b8c5753055f292d631cea
+  metadata.gz: 556dea91963ad3942c67bd242df34c6121623f74055a09e88891adbabe7aff5a
+  data.tar.gz: 2de597f123eaf230c7cf6733efe8d4622e59300b69597478c99fe878d665849e
 SHA512:
-  metadata.gz: a416ce7dd571f2eb2dff56d1460dabb528cd0683bd5e9d09534db2bdd352ddd400bbd79c1ddfae804908df725cafa1587e5cc91c5fec26eff5ce44477aa090d8
-  data.tar.gz: c8eff792dba833a94420b58d3a27f55402aa90dd94a99594565c0b4a7610de1fa3c76a7b410d582dac4351783afcff362410e2718c793611fcef203c78dde1e9
+  metadata.gz: 14a5cfc91e47192e928eb6fc407ad0dc5788f8471c593fcfdc34617c9e20f58c7509e3ffaa6eecc4a004f5c9af58d6af9adb9be71794c3bd14cce3ecd110370d
+  data.tar.gz: a3b2301b94d016965d054b66c383edd8823b340390114a1f011a1874281a61e19bd4c0be0aca7ce40f7ced5c36fa2f265e3c67f81bd7bbe836335e8914fbdd25

data/Configuration.md

@@ -108,7 +108,7 @@ end
 
 ### Caveat
 
-In the case of forking webservers such as Unicorn or Puma in clustered mode, the agent detects the pid change and re-spawns the background thread.  If you are managing the background thread yourself with the steps above _and_ you are using a forking webserver (or anything else that may fork the original process), you should also do the following.
+In the case of forking web servers such as Unicorn or Puma in clustered mode, the agent detects the pid change and re-spawns the background thread.  If you are managing the background thread yourself with the steps above _and_ you are using a forking webserver (or anything else that may fork the original process), you should also do the following.
 
 When a fork is detected, the agent handles the re-initialization and then calls `::Agent.instana.spawn_background_thread`.  This by default uses the standard `Thread.new`.  If you wish to control this, you should override this method by re-defining that method.  For example:
 
@@ -145,5 +145,5 @@ The gem can be configured to use your application logger instead:
 
 #### Environment Variable
 
-Setting `INSTANA_GEM_DEV` to a non nil value will enable extra logging output generally useful
+Setting `INSTANA_DEBUG` to a non nil value will enable extra logging output generally useful
 for development.

data/Troubleshooting.md

@@ -11,7 +11,7 @@ supported components can be found in the [documentation](https://docs.instana.io
 # Logging & Environment Variables
 
 By default, the gem will log informational messages on boot that will indicate if any problems were encountered.  If you
-set the `INSTANA_GEM_DEV` environment variable, it will increase the amount of logging output.
+set the `INSTANA_DEBUG` environment variable, it will increase the amount of logging output.
 
 ![instana console output](https://s3.amazonaws.com/instana/Instana+Ruby+boot+console+logging+output.png)
 

data/lib/instana/agent.rb

@@ -156,7 +156,7 @@ module Instana
         end
       end
 
-      loop do
+      while true
         if @state == :unannounced
           @collect_timer.pause
           @announce_timer.resume
@@ -199,7 +199,7 @@ module Instana
       announce_payload[:name] = @process[:name]
       announce_payload[:args] = @process[:arguments]
 
-      if @is_linux && !::Instana.test?
+      if @is_linux && !ENV.key?('INSTANA_TEST')
         # We create an open socket to the host agent in case we are running in a container
         # and the real pid needs to be detected.
         socket = TCPSocket.new @discovered[:agent_host], @discovered[:agent_port]
@@ -329,7 +329,7 @@ module Instana
       false
     rescue => e
       Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-      Instana.logger.debug e.backtrace.join("\r\n") unless ::Instana.test?
+      Instana.logger.debug e.backtrace.join("\r\n") unless ENV.key?('INSTANA_TEST')
       return false
     end
 
@@ -435,7 +435,7 @@ module Instana
       return nil
     rescue => e
       Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-      Instana.logger.debug e.backtrace.join("\r\n") unless ::Instana.test?
+      Instana.logger.debug e.backtrace.join("\r\n") unless ENV.key?('INSTANA_TEST')
       return nil
     end
   end

data/lib/instana/agent/helpers.rb

@@ -42,7 +42,7 @@ module AgentHelpers
   #
   def ready?
     # In test, we're always ready :-)
-    return true if ENV['INSTANA_GEM_TEST']
+    return true if ENV.key?('INSTANA_TEST')
 
     if !@is_resque_worker && forked?
       ::Instana.logger.debug "Instana: detected fork. (this pid: #{Process.pid}/#{Process.ppid})  Calling after_fork"
@@ -52,7 +52,7 @@ module AgentHelpers
     @state == :announced
   rescue => e
     Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-    Instana.logger.debug e.backtrace.join("\r\n") unless ::Instana.test?
+    Instana.logger.debug e.backtrace.join("\r\n") unless ENV.key?('INSTANA_TEST')
     return false
   end
 end

data/lib/instana/base.rb

@@ -25,22 +25,6 @@ module Instana
       @processor = ::Instana::Processor.new
       @collector = ::Instana::Collector.new
     end
-
-    # Indicates whether we are running in a development environment.
-    #
-    # @return Boolean
-    #
-    def debug?
-      ENV.key?('INSTANA_GEM_DEV')
-    end
-
-    # Indicates whether we are running in the test environment.
-    #
-    # @return Boolean
-    #
-    def test?
-      ENV.key?('INSTANA_GEM_TEST')
-    end
   end
 end
 

data/lib/instana/collector.rb

@@ -77,7 +77,7 @@ module Instana
         payload = enforce_deltas(payload, @last_values)
       end
 
-      if ENV['INSTANA_GEM_TEST']
+      if ENV.key?('INSTANA_TEST')
         true
       else
         # Report all the collected goodies

data/lib/instana/config.rb

@@ -28,7 +28,7 @@ module Instana
       # Enable/disable tracing (default: enabled)
       @config[:tracing] = { :enabled => true }
 
-      if ENV.key?('INSTANA_GEM_DEV')
+      if ENV.key?('INSTANA_DEBUG')
         @config[:collector] = { :enabled => true, :interval => 3 }
       else
         @config[:collector] = { :enabled => true, :interval => 1 }

data/lib/instana/instrumentation/net-http.rb

@@ -37,7 +37,7 @@ if defined?(::Net::HTTP) && ::Instana.config[:nethttp][:enabled]
       response = request_without_instana(*args, &block)
 
       # Debug only check: Pickup response headers; convert back to base 10 integer and validate
-      if ::Instana.debug? && response.key?('X-Instana-T')
+      if ENV.key?('INSTANA_DEBUG') && response.key?('X-Instana-T')
         if ::Instana.tracer.trace_id != ::Instana::Util.header_to_id(response.header['X-Instana-T'])
           ::Instana.logger.debug "#{Thread.current}: Trace ID mismatch on net/http response! ours: #{::Instana.tracer.trace_id} theirs: #{their_trace_id}"
         end

data/lib/instana/instrumentation/rack.rb

@@ -24,13 +24,14 @@ module Instana
       end
 
       if ::Instana.agent.extra_headers
-        for custom_header in ::Instana.agent.extra_headers
+        ::Instana.agent.extra_headers.each { |custom_header|
           # Headers are available in this format: HTTP_X_CAPTURE_THIS
-          rack_header = ('HTTP_' + custom_header.upcase).gsub('-', '_')
+          rack_header = 'HTTP_' + custom_header.upcase
+          rack_header.tr!('-', '_')
           if env.key?(rack_header)
             kvs["http.#{custom_header}"] = env[rack_header]
           end
-        end
+        }
       end
 
       # Check incoming context

data/lib/instana/tracer.rb

@@ -37,7 +37,7 @@ module Instana
     #
     def start_or_continue_trace(name, kvs = {}, incoming_context = {}, &block)
       log_start_or_continue(name, kvs, incoming_context)
-      block.call
+      yield
     rescue Exception => e
       log_error(e)
       raise
@@ -58,8 +58,7 @@ module Instana
     #
     def trace(name, kvs = {}, &block)
       log_entry(name, kvs)
-      result = block.call
-      result
+      yield
     rescue Exception => e
       log_error(e)
       raise
@@ -128,7 +127,7 @@ module Instana
     def log_exit(name, kvs = {})
       return unless tracing?
 
-      if ::Instana.debug? || ::Instana.test?
+      if ENV.key?('INSTANA_DEBUG') || ENV.key?('INSTANA_TEST')
         unless current_span_name?(name)
           ::Instana.logger.debug "Span mismatch: Attempt to exit #{name} span but #{current_span.name} is active."
         end
@@ -149,7 +148,7 @@ module Instana
     def log_end(name, kvs = {}, end_time = ::Instana::Util.now_in_ms)
       return unless tracing?
 
-      if ::Instana.debug? || ::Instana.test?
+      if ENV.key?('INSTANA_DEBUG') || ENV.key?('INSTANA_TEST')
         unless current_span_name?(name)
           ::Instana.logger.debug "Span mismatch: Attempt to end #{name} span but #{current_span.name} is active."
         end

data/lib/instana/tracing/processor.rb

@@ -81,7 +81,7 @@ module Instana
     #   - Prevent another run of the timer while this is running
     #
     def send
-      return if @queue.empty? || ENV['INSTANA_GEM_TEST']
+      return if @queue.empty? || ENV.key?('INSTANA_TEST')
 
       size = @queue.size
       if size > 200

data/lib/instana/tracing/trace.rb

@@ -7,6 +7,9 @@ module Instana
     # @return [Set] the collection of spans for this trace
     attr_reader :spans
 
+    # The currently active span
+    attr_reader :current_span
+
     # Initializes a new instance of Trace
     #
     # @param name [String] the name of the span to start
@@ -223,14 +226,6 @@ module Instana
       false
     end
 
-    # Get the current span.
-    #
-    # @return [Span]
-    #
-    def current_span
-      @current_span
-    end
-
     # Get the ID of the current span for this trace.
     # Used often to place in HTTP response headers.
     #

data/lib/instana/version.rb

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

data/test/frameworks/rack_test.rb

@@ -19,6 +19,8 @@ class RackTest < Minitest::Test
 
   def test_basic_get
     clear_all!
+    ::Instana.config[:collect_backtraces] = true
+
     get '/mrlobster'
     assert last_response.ok?
 
@@ -44,7 +46,7 @@ class RackTest < Minitest::Test
     # Backtrace fingerprint validation
     assert first_span.key?(:stack)
     assert_equal 2, first_span[:stack].count
-    refute_nil first_span[:stack].first[:f].match(/instana\/instrumentation\/rack.rb/)
+    refute_nil first_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
   end
 
   def test_basic_get_with_custom_service_name
@@ -157,7 +159,7 @@ class RackTest < Minitest::Test
     get '/mrlobster?blah=2&wilma=1&betty=2;fred=3'
 
     traces = ::Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
 
     trace = traces[0]
     refute_nil trace.spans.first.key?(:data)

data/test/frameworks/rails/actioncontroller_test.rb

@@ -13,10 +13,10 @@ class ActionControllerTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/world'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -34,10 +34,10 @@ class ActionControllerTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/error'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 2, trace.spans.count
+    assert_equal 2, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -62,10 +62,10 @@ class ActionControllerTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/api/world'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -86,10 +86,10 @@ class ActionControllerTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/api/error'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 2, trace.spans.count
+    assert_equal 2, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -111,10 +111,10 @@ class ActionControllerTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/404'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 1, trace.spans.count
+    assert_equal 1, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
 

data/test/frameworks/rails/actionview3_test.rb

@@ -13,10 +13,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_view'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -33,10 +33,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_nothing'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -54,10 +54,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_file'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -75,10 +75,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_json'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -96,10 +96,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_xml'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -117,10 +117,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_rawbody'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -138,10 +138,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_js'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -159,10 +159,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_alternate_layout'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 3, trace.spans.count
+    assert_equal 3, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -180,10 +180,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_partial'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 4, trace.spans.count
+    assert_equal 4, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -204,10 +204,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_partial_that_errors'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 4, trace.spans.count
+    assert_equal 4, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]
@@ -232,10 +232,10 @@ class ActionViewTest < Minitest::Test
     Net::HTTP.get(URI.parse('http://localhost:3205/test/render_collection'))
 
     traces = Instana.processor.queued_traces
-    assert_equal 1, traces.count
+    assert_equal 1, traces.length
     trace = traces.first
 
-    assert_equal 5, trace.spans.count
+    assert_equal 5, trace.spans.length
     spans = trace.spans.to_a
     first_span = spans[0]
     second_span = spans[1]