instana 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f4bc2a5ccafd6784e94f221a85e0fba6834fe23
-  data.tar.gz: f23e89da1122a87d34206ffaaa213aef0833c692
+  metadata.gz: 8d5a3d47c55fdc82fdf62db42d36c098cf4e5855
+  data.tar.gz: 8630f17d5794a9f5786fd53e817b1efbcee0ba1d
 SHA512:
-  metadata.gz: f653bfd0c09c1a1bd878b809b475c668d91c7c7bc759fbd306801d49a1bf18bea66b89747176043c72102e98e439005205170e8d2bfa63ecdf21e2dbbc225f27
-  data.tar.gz: 497fa0cd4b43d55260eceb7c34bbc66b6e0b8a497283b607a05761cfb1cf9afd0ad67bc849f0bb28ba7ea84aa7263849ce7239f33a3a9a7b07939a081acdc873
+  metadata.gz: 4f50211eafb3e77d5a50aa33f81330e5d1d92116e2bb203ad95928ea46a0746ee1a5826052b21d97db1e81199f9686407589f3a0d05c8de58a7e4f021aad572b
+  data.tar.gz: 8cd886516b92ab60f13746816da3b928a69de26bd2d4779436f1423b0db0693c652cc8b46c90c8439e87e98b06511a6d6fbe2076ccaf6002db3c9f3d7831b9cd

data/.gitignore

@@ -10,3 +10,4 @@
 /log/
 .ruby-version
 gemfiles/*.lock
+/test/tmp/*.pid

data/.travis.yml

@@ -24,6 +24,7 @@ script: "bundle exec rake test"
 
 services:
   - memcached
+  - redis
 
 gemfile:
   - Gemfile

data/gemfiles/libraries.gemfile

@@ -42,6 +42,13 @@ gem 'excon'
 # Memcache
 gem 'dalli'
 
+# Background Job queuing and processing
+if RUBY_VERSION < '2.2'
+  gem 'sidekiq', '~> 4.2.10'
+else
+  gem 'sidekiq', '> 5.0'
+end
+
 # Rack v2 dropped support for Ruby 2.2 and higher.
 if RUBY_VERSION < '2.2'
   gem 'rack', '< 2.0'

data/lib/instana/config.rb

@@ -40,6 +40,8 @@ module Instana
       @config[:nethttp]            = { :enabled => true }
       @config[:'rest-client']      = { :enabled => true }
       @config[:grpc]               = { :enabled => true }
+      @config[:'sidekiq-client']   = { :enabled => true }
+      @config[:'sidekiq-worker']   = { :enabled => true }
     end
 
     def [](key)

data/lib/instana/instrumentation/sidekiq-client.rb

@@ -0,0 +1,38 @@
+module Instana
+  module Instrumentation
+    class SidekiqClient
+      def call(worker_class, msg, queue, _redis_pool)
+        kv_payload = { :'sidekiq-client' => {} }
+        kv_payload[:'sidekiq-client'][:queue] = queue
+        kv_payload[:'sidekiq-client'][:job] = worker_class
+        kv_payload[:'sidekiq-client'][:retry] = msg['retry']
+        ::Instana.tracer.log_entry(:'sidekiq-client', kv_payload)
+
+        context = ::Instana.tracer.context
+        if context
+          msg['X-Instana-T'] = context.trace_id_header
+          msg['X-Instana-S'] = context.span_id_header
+        end
+
+        result = yield
+
+        kv_payload[:'sidekiq-client'][:job_id] = result['jid']
+        result
+      rescue => e
+        ::Instana.tracer.log_error(e)
+        raise
+      ensure
+        ::Instana.tracer.log_exit(:'sidekiq-client', kv_payload)
+      end
+    end
+  end
+end
+
+if defined?(::Sidekiq) && ::Instana.config[:'sidekiq-client'][:enabled]
+  ::Sidekiq.configure_client do |cfg|
+    cfg.client_middleware do |chain|
+      ::Instana.logger.warn "Instrumenting Sidekiq client"
+      chain.add ::Instana::Instrumentation::SidekiqClient
+    end
+  end
+end

data/lib/instana/instrumentation/sidekiq-worker.rb

@@ -0,0 +1,43 @@
+module Instana
+  module Instrumentation
+    class SidekiqWorker
+      def call(_worker, msg, _queue)
+        kv_payload = { :'sidekiq-worker' => {} }
+        kv_payload[:'sidekiq-worker'][:job_id] = msg['jid']
+        kv_payload[:'sidekiq-worker'][:queue] = msg['queue']
+        kv_payload[:'sidekiq-worker'][:job] = msg['class']
+        kv_payload[:'sidekiq-worker'][:retry] = msg['retry']
+
+        context = {}
+        if msg.key?('X-Instana-T')
+          trace_id = msg.delete('X-Instana-T')
+          span_id = msg.delete('X-Instana-S')
+          context[:trace_id] = ::Instana::Util.header_to_id(trace_id)
+          context[:span_id] = ::Instana::Util.header_to_id(span_id) if span_id
+        end
+
+        ::Instana.tracer.log_start_or_continue(
+          :'sidekiq-worker', kv_payload, context
+        )
+
+        yield
+      rescue => e
+        kv_payload[:'sidekiq-worker'][:error] = true
+        ::Instana.tracer.log_info(kv_payload)
+        ::Instana.tracer.log_error(e)
+        raise
+      ensure
+        ::Instana.tracer.log_end(:'sidekiq-worker', {}) if ::Instana.tracer.tracing?
+      end
+    end
+  end
+end
+
+if defined?(::Sidekiq) && ::Instana.config[:'sidekiq-worker'][:enabled]
+  ::Sidekiq.configure_server do |cfg|
+    cfg.server_middleware do |chain|
+      ::Instana.logger.warn "Instrumenting Sidekiq worker"
+      chain.add ::Instana::Instrumentation::SidekiqWorker
+    end
+  end
+end

data/lib/instana/tracing/span.rb

@@ -2,9 +2,9 @@ module Instana
   class Span
     REGISTERED_SPANS = [ :actioncontroller, :actionview, :activerecord, :excon,
                          :memcache, :'net-http', :rack, :render, :'rpc-client',
-                         :'rpc-server' ].freeze
-    ENTRY_SPANS = [ :rack, :'rpc-server' ].freeze
-    EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'rpc-client' ].freeze
+                         :'rpc-server', :'sidekiq-client', :'sidekiq-worker' ].freeze
+    ENTRY_SPANS = [ :rack, :'rpc-server', :'sidekiq-worker' ].freeze
+    EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'rpc-client', :'sidekiq-client' ].freeze
     HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
 
     attr_accessor :parent

data/lib/instana/version.rb

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

data/test/instrumentation/grpc_test.rb

@@ -76,6 +76,7 @@ class GrpcTest < Minitest::Test
         PingPongService::PingRequest.new(message: 'Hello World')
       )
     end
+    sleep 1
 
     assert 'Hello World', response.message
 
@@ -111,6 +112,7 @@ class GrpcTest < Minitest::Test
         end
       )
     end
+    sleep 1
 
     assert '01234', response.message
 

data/test/instrumentation/sidekiq-client_test.rb

@@ -0,0 +1,130 @@
+require 'test_helper'
+
+class SidekiqClientTest < Minitest::Test
+  def test_config_defaults
+    assert ::Instana.config[:'sidekiq-client'].is_a?(Hash)
+    assert ::Instana.config[:'sidekiq-client'].key?(:enabled)
+    assert_equal true, ::Instana.config[:'sidekiq-client'][:enabled]
+  end
+
+  def test_enqueue
+    clear_all!
+
+    Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      ::Sidekiq::Client.push(
+        'queue' => 'some_random_queue',
+        'class' => ::SidekiqJobOne,
+        'args' => [1, 2, 3],
+        'retry' => false
+      )
+    end
+
+    queue = ::Sidekiq::Queue.new('some_random_queue')
+    job = queue.first
+
+    assert_job_enqueued(job)
+    assert_normal_trace_recorded(job)
+  end
+
+  def test_enqueue_failure
+    clear_all!
+
+    Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      add_sidekiq_exception_middleware
+      begin
+        ::Sidekiq::Client.push(
+          'queue' => 'some_random_queue',
+          'class' => ::SidekiqJobTwo,
+          'args' => [1, 2, 3],
+          'retry' => false
+        )
+      rescue; end
+      remove_sidekiq_exception_middleware
+    end
+
+    queue = ::Sidekiq::Queue.new('some_random_queue')
+    assert_equal 0, queue.size
+
+    assert_failure_trace_recorded
+  end
+
+  private
+
+  def assert_job_enqueued(job)
+    job_message = JSON.parse(job.value)
+
+    assert_equal 'some_random_queue', job_message['queue']
+    assert_equal 'SidekiqJobOne', job_message['class']
+    assert_equal [1, 2, 3], job_message['args']
+    assert_equal false, job_message['retry']
+    assert_equal false, job_message['X-Instana-T'].nil?
+    assert_equal false, job_message['X-Instana-S'].nil?
+  end
+
+  def assert_normal_trace_recorded(job)
+    assert_equal 1, ::Instana.processor.queue_count
+    client_trace = Instana.processor.queued_traces.first
+
+    assert_equal 2, client_trace.spans.count
+    spans = client_trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    assert_equal :sdk, first_span[:n]
+    assert_equal :sidekiqtests, first_span[:data][:sdk][:name]
+
+    assert_equal first_span.id, second_span[:p]
+
+    assert_equal :'sidekiq-client', second_span[:n]
+    assert_equal 'some_random_queue', second_span[:data][:'sidekiq-client'][:queue]
+    assert_equal 'SidekiqJobOne', second_span[:data][:'sidekiq-client'][:job]
+    assert_equal false, second_span[:data][:'sidekiq-client'][:retry]
+    assert_equal job['jid'], second_span[:data][:'sidekiq-client'][:job_id]
+  end
+
+  def assert_failure_trace_recorded
+    assert_equal 1, ::Instana.processor.queue_count
+    client_trace = Instana.processor.queued_traces.first
+
+    assert_equal 2, client_trace.spans.count
+    spans = client_trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    assert_equal :sdk, first_span[:n]
+    assert_equal :sidekiqtests, first_span[:data][:sdk][:name]
+
+    assert_equal first_span.id, second_span[:p]
+
+    assert_equal :'sidekiq-client', second_span[:n]
+    assert_equal true, second_span[:error]
+    assert_equal false, second_span[:stack].nil?
+
+    assert_equal 'some_random_queue', second_span[:data][:'sidekiq-client'][:queue]
+    assert_equal 'SidekiqJobTwo', second_span[:data][:'sidekiq-client'][:job]
+    assert_equal false, second_span[:data][:'sidekiq-client'][:retry]
+    assert_equal 'Fail to enqueue job', second_span[:data][:log][:message]
+  end
+
+  SidekiqMiddlewareException = Class.new do
+    def call(*_args)
+      raise 'Fail to enqueue job'
+    end
+  end
+
+  def add_sidekiq_exception_middleware
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add SidekiqMiddlewareException
+      end
+    end
+  end
+
+  def remove_sidekiq_exception_middleware
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.remove SidekiqMiddlewareException
+      end
+    end
+  end
+end

data/test/instrumentation/sidekiq-worker_test.rb

@@ -0,0 +1,179 @@
+require 'test_helper'
+
+class SidekiqServerTest < Minitest::Test
+  def test_config_defaults
+    assert ::Instana.config[:'sidekiq-worker'].is_a?(Hash)
+    assert ::Instana.config[:'sidekiq-worker'].key?(:enabled)
+    assert_equal true, ::Instana.config[:'sidekiq-worker'][:enabled]
+  end
+
+  def test_successful_worker_starts_new_trace
+    clear_all!
+    $sidekiq_mode = :server
+    inject_instrumentation
+
+    ::Sidekiq.redis_pool.with do |redis|
+      redis.sadd('queues'.freeze, 'important')
+      redis.lpush(
+        'queue:important',
+        <<-JSON
+        {
+          "class":"SidekiqJobOne",
+          "args":[1,2,3],
+          "queue":"important",
+          "jid":"123456789"
+        }
+        JSON
+      )
+    end
+    sleep 1
+
+    assert_equal 1, ::Instana.processor.queue_count
+    assert_successful_worker_trace(::Instana.processor.queued_traces.first)
+
+    $sidekiq_mode = :client
+  end
+
+  def test_failed_worker_starts_new_trace
+    clear_all!
+    $sidekiq_mode = :server
+    inject_instrumentation
+
+    ::Sidekiq.redis_pool.with do |redis|
+      redis.sadd('queues'.freeze, 'important')
+      redis.lpush(
+        'queue:important',
+        <<-JSON
+        {
+          "class":"SidekiqJobTwo",
+          "args":[1,2,3],
+          "queue":"important",
+          "jid":"123456789"
+        }
+        JSON
+      )
+    end
+    sleep 1
+    assert_equal 1, ::Instana.processor.queue_count
+    assert_failed_worker_trace(::Instana.processor.queued_traces.first)
+
+    $sidekiq_mode = :client
+  end
+
+  def test_successful_worker_continues_previous_trace
+    clear_all!
+    $sidekiq_mode = :server
+    inject_instrumentation
+
+    Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      ::Sidekiq::Client.push(
+        'queue' => 'important',
+        'class' => ::SidekiqJobOne,
+        'args' => [1, 2, 3]
+      )
+    end
+    sleep 1
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, worker_trace = differentiate_trace(
+      Instana.processor.queued_traces.to_a
+    )
+    assert_client_trace(client_trace, ::SidekiqJobOne)
+    assert_successful_worker_trace(worker_trace)
+
+    # Worker trace and client trace are in the same trace
+    assert_equal client_trace.spans.first['t'], worker_trace.spans.first['t']
+
+    $sidekiq_mode = :client
+  end
+
+  def test_failed_worker_continues_previous_trace
+    clear_all!
+    $sidekiq_mode = :server
+    inject_instrumentation
+
+    Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      ::Sidekiq::Client.push(
+        'queue' => 'important',
+        'class' => ::SidekiqJobTwo,
+        'args' => [1, 2, 3]
+      )
+    end
+    sleep 1
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, worker_trace = differentiate_trace(
+      Instana.processor.queued_traces.to_a
+    )
+    assert_client_trace(client_trace, ::SidekiqJobTwo)
+    assert_failed_worker_trace(worker_trace)
+
+    # Worker trace and client trace are in the same trace
+    assert_equal client_trace.spans.first['t'], worker_trace.spans.first['t']
+
+    $sidekiq_mode = :client
+  end
+
+  private
+
+  def inject_instrumentation
+    # Add the instrumentation again to ensure injection in server mode
+    ::Sidekiq.configure_server do |cfg|
+      cfg.server_middleware do |chain|
+        chain.add ::Instana::Instrumentation::SidekiqWorker
+      end
+    end
+  end
+
+  def differentiate_trace(traces)
+    trying_client = traces[0]
+    trying_server = traces[1]
+
+    try_successfully = trying_client.spans.any? do |span|
+      span.name == :'sidekiq-client'
+    end
+
+    if try_successfully
+      [trying_client, trying_server]
+    else
+      [trying_server, trying_client]
+    end
+  end
+
+  def assert_successful_worker_trace(worker_trace)
+    assert_equal 1, worker_trace.spans.count
+    span = worker_trace.spans.first
+
+    assert_equal :'sidekiq-worker', span[:n]
+
+    assert_equal 'important', span[:data][:'sidekiq-worker'][:queue]
+    assert_equal 'SidekiqJobOne', span[:data][:'sidekiq-worker'][:job]
+    assert_equal false, span[:data][:'sidekiq-worker'][:job_id].nil?
+  end
+
+  def assert_failed_worker_trace(worker_trace)
+    assert_equal 1, worker_trace.spans.count
+    span = worker_trace.spans.first
+
+    assert_equal :'sidekiq-worker', span[:n]
+
+    assert_equal 'important', span[:data][:'sidekiq-worker'][:queue]
+    assert_equal 'SidekiqJobTwo', span[:data][:'sidekiq-worker'][:job]
+    assert_equal false, span[:data][:'sidekiq-worker'][:job_id].nil?
+
+    assert_equal true, span[:data][:'sidekiq-worker'][:error]
+    assert_equal 'Fail to execute the job', span[:data][:log][:message]
+  end
+
+  def assert_client_trace(client_trace, job)
+    assert_equal 2, client_trace.spans.count
+    first_span, second_span = client_trace.spans.to_a
+
+    assert_equal :sdk, first_span[:n]
+    assert_equal :sidekiqtests, first_span[:data][:sdk][:name]
+
+    assert_equal first_span.id, second_span[:p]
+
+    assert_equal :'sidekiq-client', second_span[:n]
+    assert_equal 'important', second_span[:data][:'sidekiq-client'][:queue]
+    assert_equal job.name, second_span[:data][:'sidekiq-client'][:job]
+  end
+end

data/test/jobs/sidekiq_job_1.rb

@@ -0,0 +1,6 @@
+class SidekiqJobOne
+  include Sidekiq::Worker
+
+  def perform(a, b, c)
+  end
+end

data/test/jobs/sidekiq_job_2.rb

@@ -0,0 +1,7 @@
+class SidekiqJobTwo
+  include Sidekiq::Worker
+
+  def perform(a, b, c)
+    raise 'Fail to execute the job'
+  end
+end

data/test/servers/sidekiq/worker.rb

@@ -0,0 +1,29 @@
+require 'sidekiq/launcher'
+require 'sidekiq/cli'
+require 'sidekiq/api'
+require 'sidekiq/processor'
+
+require Dir.pwd + '/test/jobs/sidekiq_job_1.rb'
+require Dir.pwd + '/test/jobs/sidekiq_job_2.rb'
+
+::Instana.logger.info "Booting instrumented sidekiq worker for tests."
+::Sidekiq.logger.level = ::Logger::FATAL
+
+sidekiq_thread = Thread.new do
+  launcher = ::Sidekiq::Launcher.new(
+    ::Sidekiq.options.merge(
+      queues: ['important'],
+      concurrency: 2
+    )
+  )
+  launcher.run
+  Thread.current[:worker] = launcher
+end
+
+Minitest.after_run do
+  ::Instana.logger.info "Killing Sidekiq worker"
+  sidekiq_thread[:worker].stop
+  sleep 2
+end
+
+sleep 5

data/test/test_helper.rb

@@ -22,7 +22,36 @@ when /rails50|rails42|rails32/
   ::WebMock.disable_net_connect!(allow_localhost: true)
   require './test/servers/rails_3205'
 when /libraries/
+  # Configure gRPC
   require './test/servers/grpc_50051.rb'
+
+  # Hook into sidekiq to control the current mode
+  $sidekiq_mode = :client
+  class << Sidekiq
+    def server?
+      $sidekiq_mode == :server
+    end
+  end
+
+  ENV['I_REDIS_URL'] ||= 'redis://127.0.0.1:6379'
+
+  # Configure redis for sidekiq client
+  Sidekiq.configure_client do |config|
+    config.redis = { url: ENV['I_REDIS_URL'] }
+  end
+
+  # Configure redis for sidekiq worker
+  $sidekiq_mode = :server
+  ::Sidekiq.configure_server do |config|
+    config.redis = { url: ENV['I_REDIS_URL'] }
+  end
+  $sidekiq_mode = :client
+
+  require './test/servers/sidekiq/worker'
+end
+
+if defined?(::Redis)
+  $redis = Redis.new(url: ENV['I_REDIS_URL'])
 end
 
 Minitest::Reporters.use! MiniTest::Reporters::SpecReporter.new
@@ -33,5 +62,6 @@ Minitest::Reporters.use! MiniTest::Reporters::SpecReporter.new
 def clear_all!
   ::Instana.processor.clear!
   ::Instana.tracer.clear!
+  $redis.flushall if $redis
   nil
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-19 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -205,6 +205,8 @@ files:
 - lib/instana/instrumentation/net-http.rb
 - lib/instana/instrumentation/rack.rb
 - lib/instana/instrumentation/rest-client.rb
+- lib/instana/instrumentation/sidekiq-client.rb
+- lib/instana/instrumentation/sidekiq-worker.rb
 - lib/instana/logger.rb
 - lib/instana/opentracing/carrier.rb
 - lib/instana/opentracing/tracer.rb
@@ -244,10 +246,15 @@ files:
 - test/instrumentation/grpc_test.rb
 - test/instrumentation/net-http_test.rb
 - test/instrumentation/rest-client_test.rb
+- test/instrumentation/sidekiq-client_test.rb
+- test/instrumentation/sidekiq-worker_test.rb
+- test/jobs/sidekiq_job_1.rb
+- test/jobs/sidekiq_job_2.rb
 - test/models/block.rb
 - test/servers/grpc_50051.rb
 - test/servers/rackapp_6511.rb
 - test/servers/rails_3205.rb
+- test/servers/sidekiq/worker.rb
 - test/test_helper.rb
 - test/tracing/custom_test.rb
 - test/tracing/id_management_test.rb
@@ -302,10 +309,15 @@ test_files:
 - test/instrumentation/grpc_test.rb
 - test/instrumentation/net-http_test.rb
 - test/instrumentation/rest-client_test.rb
+- test/instrumentation/sidekiq-client_test.rb
+- test/instrumentation/sidekiq-worker_test.rb
+- test/jobs/sidekiq_job_1.rb
+- test/jobs/sidekiq_job_2.rb
 - test/models/block.rb
 - test/servers/grpc_50051.rb
 - test/servers/rackapp_6511.rb
 - test/servers/rails_3205.rb
+- test/servers/sidekiq/worker.rb
 - test/test_helper.rb
 - test/tracing/custom_test.rb
 - test/tracing/id_management_test.rb