instana 1.7.4 → 1.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13bb5e402c5c26c740336cf7e2d8befcad0e51a3
-  data.tar.gz: bc4f70fd52e2b10f9201fb8b8d76a6f50810de68
+  metadata.gz: 968b0d69a6812e078d8e16552798b28005fc9cf1
+  data.tar.gz: 23b3315b9dce25b258156e85e3eebbc221b81396
 SHA512:
-  metadata.gz: 3a6aae1e10996b86988aa78c742cfd301b57d7afca23ef8d0361b2d6312b858517b7756d1254ff4f3e3ac6f308c3f4f8d2c7bd3c79257fe5d63d7e6985bb39fc
-  data.tar.gz: bf262a7804ab27694c86996be1c48b413775a4c9b18211d0930ed1fd968eab9cd35be2f91ee61b8e1b40acc075714a2d6af8c51a70541ec0ed4ed15fea480945
+  metadata.gz: f99acdde5c0fe11ca3ef729c82f43b4f8e28647a67c7f92f3f6ff04ab3c1e3967e7a89ee0466c6fd7d57ef6bc8b18fee4706690bb69c12e33e55a84d08826afb
+  data.tar.gz: d48ea584fd211c9a3533654155610c2ac776ca5a852ac69b34781bca374837f28203ec66d8b17f4a20793eb91a29086e90e6acefdb60ea473edac7839bd07bc3

data/Gemfile

@@ -21,6 +21,7 @@ end
 group :development do
   gem 'ruby-debug',   :platforms => [:mri_18, :jruby]
   gem 'debugger',     :platform  =>  :mri_19
+  gem 'stackprof'
 
   if RUBY_VERSION > '1.8.7'
     gem 'pry'

data/benchmarks/rack_vanilla_vs_traced.rb

@@ -0,0 +1,80 @@
+require "bundler"
+
+require 'rack'
+require 'rack/builder'
+require 'rack/handler/puma'
+require 'net/http'
+require "benchmark"
+require "cgi"
+Bundler.require(:default)
+require "instana/rack"
+
+Thread.new do
+  app = Rack::Builder.new {
+    map "/" do
+      run Proc.new { |env|
+        [200, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"scene!\"]"]]
+      }
+    end
+    map "/error" do
+      run Proc.new { |env|
+        [500, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"error!\"]"]]
+      }
+    end
+  }
+
+  Rack::Handler::Puma.run(app, {:Host => '127.0.0.1', :Port => 7011})
+end
+
+Thread.new do
+  app = Rack::Builder.new {
+    use ::Instana::Rack
+    map "/" do
+      run Proc.new { |env|
+        [200, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"scene!\"]"]]
+      }
+    end
+    map "/error" do
+      run Proc.new { |env|
+        [500, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"error!\"]"]]
+      }
+    end
+  }
+
+  Rack::Handler::Puma.run(app, {:Host => '127.0.0.1', :Port => 7012})
+end
+
+sleep(2)
+puts "Rack server started in background thread on localhost:7011"
+puts "Sleeping for 10 to allow announce"
+sleep(10)
+
+
+puts "Starting benchmarks"
+Benchmark.bm do |x|
+
+  uri = URI.parse("http://127.0.0.1:7011/")
+  ::Net::HTTP.start(uri.host, uri.port) do |hc|
+    x.report("vanilla") {
+      1_000.times {
+        req = Net::HTTP::Get.new(uri.request_uri)
+        hc.request(req)
+      }
+    }
+  end
+
+  uri = URI.parse("http://127.0.0.1:7012/")
+  ::Net::HTTP.start(uri.host, uri.port) do |hc|
+    x.report("traced ") {
+      1_000.times {
+        ::Instana.tracer.start_or_continue_trace(:rack_call) do
+          req = Net::HTTP::Get.new(uri.request_uri)
+          hc.request(req)
+        end
+      }
+    }
+  end
+end
+
+
+sleep 10

data/benchmarks/stackprof_rack_tracing.rb

@@ -0,0 +1,77 @@
+require "bundler"
+require "stackprof"
+require 'rack'
+require 'rack/builder'
+require 'rack/handler/puma'
+require 'net/http'
+require "benchmark"
+require "cgi"
+Bundler.require(:default)
+require "instana/rack"
+
+Thread.new do
+  app = Rack::Builder.new {
+    map "/" do
+      run Proc.new { |env|
+        [200, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"scene!\"]"]]
+      }
+    end
+    map "/error" do
+      run Proc.new { |env|
+        [500, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"error!\"]"]]
+      }
+    end
+  }
+
+  Rack::Handler::Puma.run(app, {:Host => '127.0.0.1', :Port => 7011})
+end
+
+Thread.new do
+  app = Rack::Builder.new {
+    use ::Instana::Rack
+    map "/" do
+      run Proc.new { |env|
+        [200, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"scene!\"]"]]
+      }
+    end
+    map "/error" do
+      run Proc.new { |env|
+        [500, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"error!\"]"]]
+      }
+    end
+  }
+
+  Rack::Handler::Puma.run(app, {:Host => '127.0.0.1', :Port => 7012})
+end
+
+sleep(2)
+puts "Rack server started in background thread on localhost:7011"
+puts "Sleeping for 10 to allow announce"
+sleep(10)
+
+puts "Starting profile"
+uri = URI.parse("http://127.0.0.1:7011/")
+StackProf.run(mode: :wall, out: 'tmp/stackprof-rack-vanilla.dump') do
+  ::Net::HTTP.start(uri.host, uri.port) do |hc|
+    5_000.times {
+      ::Instana.tracer.start_or_continue_trace(:rack_call) do
+        req = Net::HTTP::Get.new(uri.request_uri)
+        hc.request(req)
+      end
+    }
+  end
+end
+puts "stackprof tmp/stackprof-rack-vanilla.dump --text"
+
+uri = URI.parse("http://127.0.0.1:7012/")
+StackProf.run(mode: :wall, out: 'tmp/stackprof-rack-instrumented.dump') do
+  ::Net::HTTP.start(uri.host, uri.port) do |hc|
+    5_000.times {
+      ::Instana.tracer.start_or_continue_trace(:rack_call) do
+        req = Net::HTTP::Get.new(uri.request_uri)
+        hc.request(req)
+      end
+    }
+  end
+end
+puts "stackprof tmp/stackprof-rack-instrumented.dump --text"

data/lib/instana/agent.rb

@@ -162,6 +162,9 @@ module Instana
         end
         @timers.wait
       end
+    rescue Exception => e
+      ::Instana.logger.warn "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      ::Instana.logger.debug e.backtrace.join("\r\n")
     ensure
       if @state == :announced
         # Pause the timers so they don't fire while we are
@@ -169,7 +172,7 @@ module Instana
         @collect_timer.pause
         @announce_timer.pause
 
-        ::Instana.logger.debug "Agent exiting. Reporting final #{::Instana.processor.queue_count} trace(s)."
+        ::Instana.logger.debug "#{Thread.current}: Agent exiting. Reporting final #{::Instana.processor.queue_count} trace(s)."
         ::Instana.processor.send
       end
     end

data/lib/instana/config.rb

@@ -31,7 +31,12 @@ module Instana
       @config[:eum_api_key] = nil
       @config[:eum_baggage] = {}
 
-      # Instrumentation
+      # In Ruby, backtrace collection is very expensive so it's
+      # (unfortunately) disabled by default.  If you still want
+      # backtraces, it can be enabled with this config option.
+      # ::Instana.config[:collect_backtraces] = true
+      @config[:collect_backtraces] = false
+
       @config[:action_controller]  = { :enabled => true }
       @config[:action_view]        = { :enabled => true }
       @config[:active_record]      = { :enabled => true }

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

@@ -35,9 +35,9 @@ if defined?(::Net::HTTP) && ::Instana.config[:nethttp][:enabled]
       # The core call
       response = request_without_instana(*args, &block)
 
-      # Pickup response headers; convert back to base 10 integer
+      # Debug only check: Pickup response headers; convert back to base 10 integer and validate
       if ::Instana.debug? && response.key?('X-Instana-T')
-        if ::Instana.tracer.trace_id != ::Instana.tracer.header_to_id(response.header['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
       end

data/lib/instana/tracing/processor.rb

@@ -18,6 +18,10 @@ module Instana
       # No access to the @staging_queue until this lock
       # is taken.
       @staging_lock = Mutex.new
+
+      # This is the maximum number of spans we send to the host
+      # agent at once.
+      @batch_size = 3000
     end
 
     # Adds a trace to the queue to be processed and
@@ -91,7 +95,12 @@ module Instana
       # Retrieve all spans for queued traces
       spans = queued_spans
 
-      ::Instana.agent.report_spans(spans)
+      # Report spans in batches
+      batch = spans.shift(@batch_size)
+      while !batch.empty? do
+        ::Instana.agent.report_spans(batch)
+        batch = spans.shift(@batch_size)
+      end
     end
 
     # Retrieves all of the traces in @queue and returns

data/lib/instana/tracing/span.rb

@@ -30,11 +30,13 @@ module Instana
 
       @baggage = {}
 
-      # For entry spans, add a backtrace fingerprint
-      add_stack(limit: 2) if ENTRY_SPANS.include?(name)
+      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)
+        # Attach a backtrace to all exit spans
+        add_stack if EXIT_SPANS.include?(name)
+      end
 
       # Check for custom tracing
       if REGISTERED_SPANS.include?(name.to_sym)

data/lib/instana/version.rb

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

data/test/instrumentation/excon_test.rb

@@ -47,8 +47,8 @@ class ExconTest < Minitest::Test
     assert_equal "http://127.0.0.1:6511/", second_span[:data][:http][:url]
     assert_equal 200, second_span[:data][:http][:status]
 
-    # excon backtrace included check
-    assert second_span.key?(:stack)
+    # excon backtrace not included by default check
+    assert !second_span.key?(:stack)
 
     # Rack server trace validation
     assert_equal 1, rs_trace.spans.count
@@ -101,7 +101,7 @@ class ExconTest < Minitest::Test
     assert_equal "http://127.0.0.1:6500/", second_span[:data][:http][:url]
     assert_equal nil, second_span[:data][:http][:status]
 
-    # excon backtrace included check
+    # excon span should include an error backtrace
     assert second_span.key?(:stack)
 
     # error validation
@@ -154,18 +154,18 @@ class ExconTest < Minitest::Test
     refute_nil second_span[:data].key?(:http)
     assert_equal "http://127.0.0.1:6511/", second_span[:data][:http][:url]
     assert_equal 200, second_span[:data][:http][:status]
-    assert second_span.key?(:stack)
+    assert !second_span.key?(:stack)
 
     refute_nil third_span.key?(:data)
     refute_nil third_span[:data].key?(:http)
     assert_equal "http://127.0.0.1:6511/", third_span[:data][:http][:url]
     assert_equal 200, third_span[:data][:http][:status]
-    assert third_span.key?(:stack)
+    assert !third_span.key?(:stack)
 
     refute_nil fourth_span.key?(:data)
     refute_nil fourth_span[:data].key?(:http)
     assert_equal "http://127.0.0.1:6511/", fourth_span[:data][:http][:url]
     assert_equal 200, fourth_span[:data][:http][:status]
-    assert fourth_span.key?(:stack)
+    assert !fourth_span.key?(:stack)
   end
 end

data/test/instrumentation/net-http_test.rb

@@ -46,7 +46,7 @@ class NetHTTPTest < Minitest::Test
     refute_nil second_span[:data].key?(:http)
     assert_equal "http://127.0.0.1:6511/", second_span[:data][:http][:url]
     assert_equal "200", second_span[:data][:http][:status]
-    assert second_span.key?(:stack)
+    assert !second_span.key?(:stack)
 
     # Rack server trace validation
     assert_equal 1, rs_trace.spans.count
@@ -94,7 +94,7 @@ class NetHTTPTest < Minitest::Test
     refute_nil second_span[:data].key?(:http)
     assert_equal "http://127.0.0.1:6511/", second_span[:data][:http][:url]
     assert_equal "200", second_span[:data][:http][:status]
-    assert second_span.key?(:stack)
+    assert !second_span.key?(:stack)
 
     # Rack server trace validation
     assert_equal 1, rs_trace.spans.count
@@ -161,7 +161,7 @@ class NetHTTPTest < Minitest::Test
     assert_equal "http://127.0.0.1:6511/error", http_span[:data][:http][:url]
     assert_equal "500", http_span[:data][:http][:status]
     assert_equal :'net-http', http_span.name
-    assert http_span.key?(:stack)
+    assert !http_span.key?(:stack)
 
     WebMock.disable_net_connect!
   end

data/test/tracing/trace_test.rb

@@ -34,17 +34,34 @@ class TraceTest < Minitest::Test
     end
   end
 
-  def test_entry_span_has_stack_with_limit
+  def test_entry_span_doesnt_have_stack_by_default
+    t = ::Instana::Trace.new(:rack)
+    first_span = t.spans.first
+    assert !first_span.key?(:stack)
+  end
+
+  def test_entry_span_has_stack_by_config
+    ::Instana.config[:collect_backtraces] = true
     t = ::Instana::Trace.new(:rack)
     first_span = t.spans.first
     assert first_span.key?(:stack)
     assert_equal 2, first_span[:stack].count
+    ::Instana.config[:collect_backtraces] = false
+  end
+
+  def test_exit_span_doesnt_have_stack_by_default
+    t = ::Instana::Trace.new(:trace_test)
+    t.new_span(:excon)
+    second_span = t.spans.to_a[1]
+    assert !second_span.key?(:stack)
   end
 
-  def test_exit_span_has_stack
+  def test_exit_span_has_stack_by_config
+    ::Instana.config[:collect_backtraces] = true
     t = ::Instana::Trace.new(:trace_test)
     t.new_span(:excon)
     second_span = t.spans.to_a[1]
     assert second_span.key?(:stack)
+    ::Instana.config[:collect_backtraces] = false
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.7.5
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,6 +173,8 @@ files:
 - benchmarks/Gemfile.lock
 - benchmarks/id_generation.rb
 - benchmarks/opentracing.rb
+- benchmarks/rack_vanilla_vs_traced.rb
+- benchmarks/stackprof_rack_tracing.rb
 - benchmarks/time_processing.rb
 - bin/console
 - bin/setup
@@ -292,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby sensor for Instana