instana 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d5a3d47c55fdc82fdf62db42d36c098cf4e5855
-  data.tar.gz: 8630f17d5794a9f5786fd53e817b1efbcee0ba1d
+  metadata.gz: 2b5079ebac90a5ee51a0a808661dd4ccf2f0a308
+  data.tar.gz: 61284e14d6d709258d7b67e5f0e582cc0fb9d72c
 SHA512:
-  metadata.gz: 4f50211eafb3e77d5a50aa33f81330e5d1d92116e2bb203ad95928ea46a0746ee1a5826052b21d97db1e81199f9686407589f3a0d05c8de58a7e4f021aad572b
-  data.tar.gz: 8cd886516b92ab60f13746816da3b928a69de26bd2d4779436f1423b0db0693c652cc8b46c90c8439e87e98b06511a6d6fbe2076ccaf6002db3c9f3d7831b9cd
+  metadata.gz: 4eb5d83f78ae37c40b3e0d7a959391e67b938876cd13a0d1d07bc6c9b0638e0486626caf03349eb974dd5efc9bf62feb459607d978a57e557fd004709ebb9c74
+  data.tar.gz: adfdead8d412acb7bcaef9a1e51e9bdb70a4dd6aaaf323ffde5ddc4a5aa0950a6653b4015575f0fea65ad10b00b3fc71864d9cf61a5d1d5f2f41d5ab6b7ebba1

data/lib/instana/config.rb

@@ -42,6 +42,7 @@ module Instana
       @config[:grpc]               = { :enabled => true }
       @config[:'sidekiq-client']   = { :enabled => true }
       @config[:'sidekiq-worker']   = { :enabled => true }
+      @config[:redis]              = { :enabled => true }
     end
 
     def [](key)

data/lib/instana/eum/eum-test.js.erb

@@ -2,9 +2,9 @@
   (function(i,s,o,g,r,a,m){i['InstanaEumObject']=r;i[r]=i[r]||function(){
     (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-      })(window,document,'script','//internal-eum.instana.io/eum.min.js','ineum');
+      })(window,document,'script','//eum-test-fullstack-0-us-west-2.instana.io/eum.min.js','ineum');
 
-  ineum('reportingUrl', '//internal-eum.instana.io');
+  ineum('reportingUrl', '//eum-test-fullstack-0-us-west-2.instana.io');
   ineum('apiKey', '<%=::Instana.config[:eum_api_key]%>');
   ineum('traceId', '<%=::Instana.tracer.trace_id_header%>');
 

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

@@ -23,6 +23,6 @@ if defined?(::ActiveRecord) && ::Instana.config[:active_record][:enabled]
     ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:include, ::Instana::Instrumentation::PostgreSQLAdapter)
 
   else
-    ::Instana.logger.warn "Unsupported ActiveRecord adapter: #{ActiveRecord::Base.connection.adapter_name.downcase}"
+    ::Instana.logger.debug "Unsupported ActiveRecord adapter: #{ActiveRecord::Base.connection.adapter_name.downcase}"
   end
 end

data/lib/instana/instrumentation/redis.rb

@@ -0,0 +1,82 @@
+module Instana
+  module Instrumentation
+    class Redis
+      def self.get_host(client)
+        client.host
+      end
+
+      def self.get_port(client)
+        client.port
+      end
+
+      def self.pipeline_command(pipeline)
+        pipeline.is_a?(::Redis::Pipeline::Multi) ? 'MULTI' : 'PIPELINE'
+      end
+    end
+  end
+end
+
+if defined?(::Redis) && ::Instana.config[:redis][:enabled]
+  ::Redis::Client.class_eval do
+    def call_with_instana(*args, &block)
+      kv_payload = { redis: {} }
+
+      if !Instana.tracer.tracing?
+        return call_without_instana(*args, &block)
+      end
+
+      host = ::Instana::Instrumentation::Redis.get_host(self)
+      port = ::Instana::Instrumentation::Redis.get_port(self)
+      kv_payload[:redis] = {
+        connection: "#{host}:#{port}",
+        db: db,
+        command: args[0][0].to_s.upcase
+      }
+      ::Instana.tracer.log_entry(:redis, kv_payload)
+
+      call_without_instana(*args, &block)
+    rescue => e
+      kv_payload[:redis][:error] = true
+      ::Instana.tracer.log_info(kv_payload)
+      ::Instana.tracer.log_error(e)
+      raise
+    ensure
+      ::Instana.tracer.log_exit(:redis, {})
+    end
+
+    ::Instana.logger.info "Instrumenting Redis"
+
+    alias call_without_instana call
+    alias call call_with_instana
+
+    def call_pipeline_with_instana(*args, &block)
+      kv_payload = { redis: {} }
+
+      if !Instana.tracer.tracing?
+        return call_pipeline_without_instana(*args, &block)
+      end
+
+      pipeline = args.first
+      host = ::Instana::Instrumentation::Redis.get_host(self)
+      port = ::Instana::Instrumentation::Redis.get_port(self)
+      kv_payload[:redis] = {
+        connection: "#{host}:#{port}",
+        db: db,
+        command: ::Instana::Instrumentation::Redis.pipeline_command(pipeline)
+      }
+      ::Instana.tracer.log_entry(:redis, kv_payload)
+
+      call_pipeline_without_instana(*args, &block)
+    rescue => e
+      kv_payload[:redis][:error] = true
+      ::Instana.tracer.log_info(kv_payload)
+      ::Instana.tracer.log_error(e)
+      raise
+    ensure
+      ::Instana.tracer.log_exit(:redis, {})
+    end
+
+    alias call_pipeline_without_instana call_pipeline
+    alias call_pipeline call_pipeline_with_instana
+  end
+end

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

@@ -5,9 +5,16 @@ module Instana
         kv_payload = { :'sidekiq-client' => {} }
         kv_payload[:'sidekiq-client'][:queue] = queue
         kv_payload[:'sidekiq-client'][:job] = worker_class
-        kv_payload[:'sidekiq-client'][:retry] = msg['retry']
+        kv_payload[:'sidekiq-client'][:retry] = msg['retry'].to_s
         ::Instana.tracer.log_entry(:'sidekiq-client', kv_payload)
 
+        # Temporary until we move connection collection to redis
+        # instrumentation
+        Sidekiq.redis_pool.with do |conn|
+          opts = conn.client.options
+          kv_payload[:'sidekiq-client'][:'redis-url'] = "#{opts[:host]}:#{opts[:port]}"
+        end
+
         context = ::Instana.tracer.context
         if context
           msg['X-Instana-T'] = context.trace_id_header

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

@@ -6,7 +6,14 @@ module Instana
         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']
+        kv_payload[:'sidekiq-worker'][:retry] = msg['retry'].to_s
+
+        # Temporary until we move connection collection to redis
+        # instrumentation
+        Sidekiq.redis_pool.with do |conn|
+          opts = conn.client.options
+          kv_payload[:'sidekiq-worker'][:'redis-url'] = "#{opts[:host]}:#{opts[:port]}"
+        end
 
         context = {}
         if msg.key?('X-Instana-T')

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', :'sidekiq-client', :'sidekiq-worker' ].freeze
+                         :'rpc-server', :'sidekiq-client', :'sidekiq-worker', :redis].freeze
     ENTRY_SPANS = [ :rack, :'rpc-server', :'sidekiq-worker' ].freeze
-    EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'rpc-client', :'sidekiq-client' ].freeze
+    EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'rpc-client', :'sidekiq-client', :redis ].freeze
     HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
 
     attr_accessor :parent

data/lib/instana/version.rb

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

data/test/instrumentation/redis_test.rb

@@ -0,0 +1,141 @@
+require 'test_helper'
+
+class RedisTest < Minitest::Test
+  def test_normal_call
+    clear_all!
+    redis_client = create_redis_client
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      redis_client.set('hello', 'world')
+    end
+    redis_client.disconnect!
+
+    assert_redis_trace('SET')
+  end
+
+  def test_normal_call_with_error
+    clear_all!
+    redis_client = create_redis_client
+
+    redis_client.client.instance_eval do
+      def read
+        raise 'Something went wrong'
+      end
+    end
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      begin
+        redis_client.set('hello', 'world')
+      rescue; end
+    end
+    redis_client.disconnect!
+
+    assert_redis_trace('SET', with_error: 'Something went wrong')
+  end
+
+  def test_pipeline_call
+    clear_all!
+    redis_client = create_redis_client
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      redis_client.pipelined do
+        exec_sample_pipeline_calls(redis_client)
+      end
+    end
+
+    assert_redis_trace('PIPELINE')
+  end
+
+  def test_pipeline_call_with_error
+    clear_all!
+    redis_client = create_redis_client
+
+    redis_client.client.instance_eval do
+      def read
+        raise 'Something went wrong'
+      end
+    end
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      begin
+        redis_client.pipelined do
+          exec_sample_pipeline_calls(redis_client)
+        end
+      rescue; end
+    end
+
+    assert_redis_trace('PIPELINE', with_error: 'Something went wrong')
+  end
+
+  def test_multi_call
+    clear_all!
+    redis_client = create_redis_client
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      redis_client.multi do
+        exec_sample_pipeline_calls(redis_client)
+      end
+    end
+
+    assert_redis_trace('MULTI')
+  end
+
+  def test_multi_call_with_error
+    clear_all!
+    redis_client = create_redis_client
+
+    redis_client.client.instance_eval do
+      def read
+        raise 'Something went wrong'
+      end
+    end
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      begin
+        redis_client.multi do
+          exec_sample_pipeline_calls(redis_client)
+        end
+      rescue; end
+    end
+
+    assert_redis_trace('MULTI', with_error: 'Something went wrong')
+  end
+
+  private
+
+  def create_redis_client
+    Redis.new(url: ENV['I_REDIS_URL'])
+  end
+
+  def exec_sample_pipeline_calls(redis_client)
+    redis_client.set('hello', 'world')
+    redis_client.set('other', 'world')
+    redis_client.hmset('awesome', 'wonderful', 'world')
+  end
+
+  def assert_redis_trace(command, with_error: nil)
+    assert_equal 1, ::Instana.processor.queue_count
+    trace = ::Instana.processor.queued_traces.first
+
+    assert_equal 2, trace.spans.count
+    first_span, second_span = trace.spans.to_a
+
+    # first_span is the parent of second_span
+    assert_equal first_span.id, second_span[:p]
+    assert_equal :sdk, first_span[:n]
+    assert_equal :redis, second_span[:n]
+
+    data = second_span[:data]
+
+    uri = URI.parse(ENV['I_REDIS_URL'])
+    assert_equal "#{uri.host}:#{uri.port}", data[:redis][:connection]
+
+    assert_equal 0, data[:redis][:db]
+    assert_equal command, data[:redis][:command]
+
+    if with_error
+      assert_equal true, data[:redis][:error]
+      assert_equal with_error, data[:log][:message]
+    end
+  end
+end

data/test/instrumentation/sidekiq-client_test.rb

@@ -9,14 +9,15 @@ class SidekiqClientTest < Minitest::Test
 
   def test_enqueue
     clear_all!
-
     Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      disable_redis_instrumentation
       ::Sidekiq::Client.push(
         'queue' => 'some_random_queue',
         'class' => ::SidekiqJobOne,
         'args' => [1, 2, 3],
         'retry' => false
       )
+      enable_redis_instrumentation
     end
 
     queue = ::Sidekiq::Queue.new('some_random_queue')
@@ -30,6 +31,7 @@ class SidekiqClientTest < Minitest::Test
     clear_all!
 
     Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      disable_redis_instrumentation
       add_sidekiq_exception_middleware
       begin
         ::Sidekiq::Client.push(
@@ -39,6 +41,7 @@ class SidekiqClientTest < Minitest::Test
           'retry' => false
         )
       rescue; end
+      enable_redis_instrumentation
       remove_sidekiq_exception_middleware
     end
 
@@ -78,7 +81,7 @@ class SidekiqClientTest < Minitest::Test
     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 "false", second_span[:data][:'sidekiq-client'][:retry]
     assert_equal job['jid'], second_span[:data][:'sidekiq-client'][:job_id]
   end
 
@@ -102,7 +105,7 @@ class SidekiqClientTest < Minitest::Test
 
     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 "false", second_span[:data][:'sidekiq-client'][:retry]
     assert_equal 'Fail to enqueue job', second_span[:data][:log][:message]
   end
 

data/test/instrumentation/sidekiq-worker_test.rb

@@ -12,6 +12,7 @@ class SidekiqServerTest < Minitest::Test
     $sidekiq_mode = :server
     inject_instrumentation
 
+    disable_redis_instrumentation
     ::Sidekiq.redis_pool.with do |redis|
       redis.sadd('queues'.freeze, 'important')
       redis.lpush(
@@ -26,6 +27,7 @@ class SidekiqServerTest < Minitest::Test
         JSON
       )
     end
+    enable_redis_instrumentation
     sleep 1
 
     assert_equal 1, ::Instana.processor.queue_count
@@ -39,6 +41,7 @@ class SidekiqServerTest < Minitest::Test
     $sidekiq_mode = :server
     inject_instrumentation
 
+    disable_redis_instrumentation
     ::Sidekiq.redis_pool.with do |redis|
       redis.sadd('queues'.freeze, 'important')
       redis.lpush(
@@ -53,6 +56,8 @@ class SidekiqServerTest < Minitest::Test
         JSON
       )
     end
+    enable_redis_instrumentation
+
     sleep 1
     assert_equal 1, ::Instana.processor.queue_count
     assert_failed_worker_trace(::Instana.processor.queued_traces.first)
@@ -66,11 +71,13 @@ class SidekiqServerTest < Minitest::Test
     inject_instrumentation
 
     Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      disable_redis_instrumentation
       ::Sidekiq::Client.push(
         'queue' => 'important',
         'class' => ::SidekiqJobOne,
         'args' => [1, 2, 3]
       )
+      enable_redis_instrumentation
     end
     sleep 1
     assert_equal 2, ::Instana.processor.queue_count
@@ -92,11 +99,13 @@ class SidekiqServerTest < Minitest::Test
     inject_instrumentation
 
     Instana.tracer.start_or_continue_trace(:sidekiqtests) do
+      disable_redis_instrumentation
       ::Sidekiq::Client.push(
         'queue' => 'important',
         'class' => ::SidekiqJobTwo,
         'args' => [1, 2, 3]
       )
+      enable_redis_instrumentation
     end
     sleep 1
     assert_equal 2, ::Instana.processor.queue_count

data/test/servers/helpers/sidekiq_worker_initializer.rb

@@ -0,0 +1,27 @@
+# This is a helper initializer to boot a local instrumented Sidekiq stack
+# for development and testing.
+#
+# export BUNDLE_GEMFILE=/path/to/ruby-sensor/gemfiles/libraries.gemfile
+# bundle install
+# bundle exec sidekiq -c 2 -q important -r ./test/servers/helpers/sidekiq_worker_initializer.rb
+#
+# In another shell, you can boot a console to queue jobs:
+#
+# export BUNDLE_GEMFILE=/path/to/ruby-sensor/gemfiles/libraries.gemfile
+# bundle install
+# bundle exec rake console
+# > require Dir.pwd + '/test/jobs/sidekiq_job_1.rb'
+# > Instana.tracer.start_or_continue_trace(:sidekiq_demo) do
+# >  ::Sidekiq::Client.push( 'queue' => 'important', 'class' => ::SidekiqJobOne,
+# >                          'args' => [1, 2, 3], 'retry' => false)
+# > end
+#
+
+# Load test jobs.
+require Dir.pwd + '/test/jobs/sidekiq_job_1.rb'
+require Dir.pwd + '/test/jobs/sidekiq_job_2.rb'
+
+require "sidekiq"
+require "instana"
+::Instana.logger.info "Booting instrumented sidekiq worker for tests."
+::Sidekiq.logger.level = ::Logger::DEBUG

data/test/test_helper.rb

@@ -65,3 +65,17 @@ def clear_all!
   $redis.flushall if $redis
   nil
 end
+
+def disable_redis_instrumentation
+  ::Redis::Client.class_eval do
+    alias call call_without_instana
+    alias call_pipeline call_pipeline_without_instana
+  end
+end
+
+def enable_redis_instrumentation
+  ::Redis::Client.class_eval do
+    alias call call_with_instana
+    alias call_pipeline call_pipeline_with_instana
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,6 +204,7 @@ files:
 - lib/instana/instrumentation/grpc.rb
 - lib/instana/instrumentation/net-http.rb
 - lib/instana/instrumentation/rack.rb
+- lib/instana/instrumentation/redis.rb
 - lib/instana/instrumentation/rest-client.rb
 - lib/instana/instrumentation/sidekiq-client.rb
 - lib/instana/instrumentation/sidekiq-worker.rb
@@ -245,6 +246,7 @@ files:
 - test/instrumentation/excon_test.rb
 - test/instrumentation/grpc_test.rb
 - test/instrumentation/net-http_test.rb
+- test/instrumentation/redis_test.rb
 - test/instrumentation/rest-client_test.rb
 - test/instrumentation/sidekiq-client_test.rb
 - test/instrumentation/sidekiq-worker_test.rb
@@ -252,6 +254,7 @@ files:
 - test/jobs/sidekiq_job_2.rb
 - test/models/block.rb
 - test/servers/grpc_50051.rb
+- test/servers/helpers/sidekiq_worker_initializer.rb
 - test/servers/rackapp_6511.rb
 - test/servers/rails_3205.rb
 - test/servers/sidekiq/worker.rb
@@ -308,6 +311,7 @@ test_files:
 - test/instrumentation/excon_test.rb
 - test/instrumentation/grpc_test.rb
 - test/instrumentation/net-http_test.rb
+- test/instrumentation/redis_test.rb
 - test/instrumentation/rest-client_test.rb
 - test/instrumentation/sidekiq-client_test.rb
 - test/instrumentation/sidekiq-worker_test.rb
@@ -315,6 +319,7 @@ test_files:
 - test/jobs/sidekiq_job_2.rb
 - test/models/block.rb
 - test/servers/grpc_50051.rb
+- test/servers/helpers/sidekiq_worker_initializer.rb
 - test/servers/rackapp_6511.rb
 - test/servers/rails_3205.rb
 - test/servers/sidekiq/worker.rb