instana 1.11.4 → 1.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2f239d9d7286752e2650375e8096e9525db098a7e5b09486e36dbd89758eb1
-  data.tar.gz: 14ebd785f5ef8333360214ad9731583976f96c62980b6d0b7927338d25a0ca90
+  metadata.gz: c3a3d50ffdbca640b2c32a3f51243387eb7a15a3fe5e2810c3d93c2ea98f92be
+  data.tar.gz: f0c0665f06c3e2faa8aa0687e1f3d03e905e18cb4006dac17f50a2868f18ef53
 SHA512:
-  metadata.gz: f2e560309027517414f4358421b5e9f0579254e9479cbe263c7fdd89440d924ef416a90ef2b7ff25eb7cbb3bffb3f630338d590363451de877eb9d9c70a46c32
-  data.tar.gz: 0e8612accc07577a4951fddde76e77789714b67ee2e749b167f18ae39f3b8e4947e65fa3f4d35cd7a9af350e9ce65fcec0119f8494760b5f8be855c792cbe229
+  metadata.gz: 863436a63b5014db4137887f4f223ca8a7ed6759238e009258d2912b0f86328b705d388a61670486a5f194209d83ac23f27825fb0672f59adc0492dd6cf7ee83
+  data.tar.gz: 0e2e0ba614455fcbbddbe376a76e006686a8ef3456c020d5c545ae0d247fad033d99d31815f3ceb7b2a881d4b35388e955d255bc4770e940072c38eb66ae0925

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-<img src="http://www.instana.com/wp-content/uploads/2016/11/Instana-Infrastructure-Map-1-1024x551.png"/>
+<img src="https://disznc.s3.amazonaws.com/Ruby-Dashboard-2020-02-10-at-2.31.36-PM.png"/>
 </div>
 
 # Instana

data/lib/instana/instrumentation/redis.rb

@@ -1,47 +1,29 @@
-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?
+      if !Instana.tracer.tracing? || ::Instana.tracer.tracing_span?(:redis)
         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)
+      ::Instana.tracer.log_entry(:redis)
+
+      begin
+        kv_payload[:redis][:connection] = "#{self.host}:#{self.port}"
+        kv_payload[:redis][:db] = db.to_s
+        kv_payload[:redis][:command] = args[0][0].to_s.upcase
+      rescue
+        nil
+      end
 
       call_without_instana(*args, &block)
     rescue => e
-      kv_payload[:redis][:error] = true
-      ::Instana.tracer.log_info(kv_payload)
+      ::Instana.tracer.log_info({ redis: {error: true} })
       ::Instana.tracer.log_error(e)
       raise
     ensure
-      ::Instana.tracer.log_exit(:redis, {})
+      ::Instana.tracer.log_exit(:redis, kv_payload)
     end
 
     ::Instana.logger.debug "Instrumenting Redis"
@@ -52,28 +34,28 @@ if defined?(::Redis) && ::Instana.config[:redis][:enabled]
     def call_pipeline_with_instana(*args, &block)
       kv_payload = { redis: {} }
 
-      if !Instana.tracer.tracing?
+      if !Instana.tracer.tracing? || ::Instana.tracer.tracing_span?(:redis)
         return call_pipeline_without_instana(*args, &block)
       end
 
+      ::Instana.tracer.log_entry(:redis)
+
       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)
+      begin
+        kv_payload[:redis][:connection] = "#{self.host}:#{self.port}"
+        kv_payload[:redis][:db] = db.to_s
+        kv_payload[:redis][:command] = pipeline.is_a?(::Redis::Pipeline::Multi) ? 'MULTI' : 'PIPELINE'
+      rescue
+        nil
+      end
 
       call_pipeline_without_instana(*args, &block)
     rescue => e
-      kv_payload[:redis][:error] = true
-      ::Instana.tracer.log_info(kv_payload)
+      ::Instana.tracer.log_info({ redis: {error: true} })
       ::Instana.tracer.log_error(e)
       raise
     ensure
-      ::Instana.tracer.log_exit(:redis, {})
+      ::Instana.tracer.log_exit(:redis, kv_payload)
     end
 
     alias call_pipeline_without_instana call_pipeline

data/lib/instana/tracer.rb

@@ -26,7 +26,7 @@ module Instana
     # Will start a new trace or continue an on-going one (such as
     # from incoming remote requests with context headers).
     #
-    # @param name [String] the name of the span to start
+    # @param name [String, Symbol] the name of the span to start
     # @param kvs [Hash] list of key values to be reported in the span
     # @param incoming_context [Hash] specifies the incoming context.  At a
     #   minimum, it should specify :trace_id and :span_id from the following:
@@ -52,7 +52,7 @@ module Instana
     #   @db.select(1)
     # end
     #
-    # @param name [String] the name of the span to start
+    # @param name [String, Symbol] the name of the span to start
     # @param kvs [Hash] list of key values to be reported in this new span
     #
     def trace(name, kvs = {}, &block)
@@ -72,7 +72,7 @@ module Instana
     # Will start a new trace or continue an on-going one (such as
     # from incoming remote requests with context headers).
     #
-    # @param name [String] the name of the span to start
+    # @param name [String, Symbol] the name of the span to start
     # @param kvs [Hash] list of key values to be reported in the span
     # @param incoming_context [SpanContext or Hash] specifies the incoming context.  At a
     #   minimum, it should specify :trace_id and :span_id from the following:
@@ -107,7 +107,7 @@ module Instana
     # Will establish a new span as a child of the current span
     # in an existing trace
     #
-    # @param name [String] the name of the span to create
+    # @param name [String, Symbol] the name of the span to create
     # @param kvs [Hash] list of key values to be reported in the span
     #
     def log_entry(name, kvs = nil, start_time = ::Instana::Util.now_in_ms, child_of = nil)
@@ -145,7 +145,7 @@ module Instana
     # @note `name` isn't really required but helps keep sanity that
     # we're closing out the span that we really want to close out.
     #
-    # @param name [String] the name of the span to exit (close out)
+    # @param name [String, Symbol] the name of the span to exit (close out)
     # @param kvs [Hash] list of key values to be reported in the span
     #
     def log_exit(name, kvs = {})
@@ -263,6 +263,27 @@ module Instana
       new_span
     end
 
+    # Start a new span which is the child of the current span
+    #
+    # @param operation_name [String] The name of the operation represented by the span
+    # @param child_of [Span] A span to be used as the ChildOf reference
+    # @param start_time [Time] the start time of the span
+    # @param tags [Hash] Starting tags for the span
+    #
+    # @return [Span]
+    #
+    def start_active_span(operation_name, child_of: self.current_span, start_time: ::Instana::Util.now_in_ms, tags: nil)
+      self.current_span = start_span(operation_name, child_of: child_of, start_time: start_time, tags: tags)
+    end
+
+    # Returns the currently active span
+    #
+    # @return [Span]
+    #
+    def active_span
+      self.current_span
+    end
+
     # Inject a span into the given carrier
     #
     # @param span_context [SpanContext]

data/lib/instana/version.rb

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

data/test/instrumentation/redis_test.rb

@@ -1,40 +1,44 @@
 require 'test_helper'
 
 class RedisTest < Minitest::Test
+  def setup
+    if ENV.key?('REDIS_URL')
+      @redis_url = ENV['REDIS_URL']
+    else
+      @redis_url = "redis://localhost:6379"
+    end
+    @redis_client = Redis.new(url: @redis_url)
+  end
+
   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')
+      @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
 
     Instana.tracer.start_or_continue_trace(:redis_test) do
       begin
-        redis_client.zadd('hello', 'invalid', 'value')
+        @redis_client.zadd('hello', 'invalid', 'value')
       rescue; end
     end
-    redis_client.disconnect!
 
     assert_redis_trace('ZADD', with_error: 'ERR value is not a valid float')
   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
-        redis_client.set('hello', 'world')
-        redis_client.set('other', 'world')
+      @redis_client.pipelined do
+        @redis_client.set('hello', 'world')
+        @redis_client.set('other', 'world')
       end
     end
 
@@ -43,13 +47,12 @@ class RedisTest < Minitest::Test
 
   def test_pipeline_call_with_error
     clear_all!
-    redis_client = create_redis_client
 
     Instana.tracer.start_or_continue_trace(:redis_test) do
       begin
-        redis_client.pipelined do
-          redis_client.set('other', 'world')
-          redis_client.call('invalid')
+        @redis_client.pipelined do
+          @redis_client.set('other', 'world')
+          @redis_client.call('invalid')
         end
       rescue; end
     end
@@ -59,12 +62,11 @@ class RedisTest < Minitest::Test
 
   def test_multi_call
     clear_all!
-    redis_client = create_redis_client
 
     Instana.tracer.start_or_continue_trace(:redis_test) do
-      redis_client.multi do
-        redis_client.set('hello', 'world')
-        redis_client.set('other', 'world')
+      @redis_client.multi do
+        @redis_client.set('hello', 'world')
+        @redis_client.set('other', 'world')
       end
     end
 
@@ -73,13 +75,12 @@ class RedisTest < Minitest::Test
 
   def test_multi_call_with_error
     clear_all!
-    redis_client = create_redis_client
 
     Instana.tracer.start_or_continue_trace(:redis_test) do
       begin
-        redis_client.multi do
-          redis_client.set('other', 'world')
-          redis_client.call('invalid')
+        @redis_client.multi do
+          @redis_client.set('other', 'world')
+          @redis_client.call('invalid')
         end
       rescue; end
     end
@@ -89,10 +90,6 @@ class RedisTest < Minitest::Test
 
   private
 
-  def create_redis_client
-    Redis.new(url: ENV['I_REDIS_URL'])
-  end
-
   def assert_redis_trace(command, with_error: nil)
     spans = ::Instana.processor.queued_spans
     assert_equal 2, spans.length
@@ -105,10 +102,10 @@ class RedisTest < Minitest::Test
 
     data = second_span[:data]
 
-    uri = URI.parse(ENV['I_REDIS_URL'])
+    uri = URI.parse(@redis_url)
     assert_equal "#{uri.host}:#{uri.port}", data[:redis][:connection]
 
-    assert_equal 0, data[:redis][:db]
+    assert_equal "0", data[:redis][:db]
     assert_equal command, data[:redis][:command]
 
     if with_error

data/test/instrumentation/sidekiq-client_test.rb

@@ -1,6 +1,13 @@
 require 'test_helper'
 
 class SidekiqClientTest < Minitest::Test
+  def setup
+    Sidekiq.configure_client do |config|
+      config.redis = { url: ENV["REDIS_URL"] }
+    end
+    ::Sidekiq::Queue.new('some_random_queue').clear
+  end
+
   def test_config_defaults
     assert ::Instana.config[:'sidekiq-client'].is_a?(Hash)
     assert ::Instana.config[:'sidekiq-client'].key?(:enabled)

data/test/instrumentation/sidekiq-worker_test.rb

@@ -1,6 +1,12 @@
 require 'test_helper'
 
 class SidekiqServerTest < Minitest::Test
+  def setup
+    Sidekiq.configure_client do |config|
+      config.redis = { url: ENV["REDIS_URL"] }
+    end
+  end
+
   def test_config_defaults
     assert ::Instana.config[:'sidekiq-worker'].is_a?(Hash)
     assert ::Instana.config[:'sidekiq-worker'].key?(:enabled)

data/test/test_helper.rb

@@ -56,10 +56,6 @@ when /libraries/
   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
 
 # Used to reset the gem to boot state.  It clears out any queued and/or staged
@@ -68,7 +64,6 @@ Minitest::Reporters.use! MiniTest::Reporters::SpecReporter.new
 def clear_all!
   ::Instana.processor.clear!
   ::Instana.tracer.clear!
-  $redis.flushall if $redis
   nil
 end
 

data/test/tracing/opentracing_test.rb

@@ -332,4 +332,25 @@ class OpenTracerTest < Minitest::Test
     assert_equal({:my_bag=>1}, ac_span.context.baggage)
     assert_equal(nil, av_span.context.baggage)
   end
+
+  def test_start_active_span
+    clear_all!
+
+    span = OpenTracing.start_active_span(:rack)
+    assert_equal ::Instana::Tracer.current_span, span
+
+    sleep 0.1
+
+    span.finish
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.length
+  end
+
+  def test_active_span
+    clear_all!
+
+    span = OpenTracing.start_active_span(:rack)
+    assert_equal OpenTracing.active_span, span
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.11.4
+  version: 1.11.5
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler