instana 1.213.3 → 1.214.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d41daf6f68e3738199d8b2fca28811cc70f521eb25b25379bd8c185aef0621c
-  data.tar.gz: bd2cc50d91fbaa639f170150c049b9ffd801b9e1ef2953d1ebd4d1c7c8f95434
+  metadata.gz: f17a988f6d3117cee6198d76f4d1d927c78170857122933700352905ddf06382
+  data.tar.gz: 852125ef23731dca4817a18999b9cb1af142d8c62ff8bc5c81c717e370b0a943
 SHA512:
-  metadata.gz: 032ef7a9dc62ead3c64e7ab86420c1f28b093b0ce4f27ccbc4ecd8d6f05f4ccdcd34079c2b5d09f88b4a786977eaa7f3944ea4a97074e96f363f7671baf1b3d1
-  data.tar.gz: c9c2c346dc945b697a65add442e3fbb09c0f9983c7a0ee4601903a961142bbcc55539ee5cc2ba6b71e607d5d86eb8c60d49f3d25c35c17ae1cee4cd077c9e3e4
+  metadata.gz: ce8ce7e27297c544e50e7efa4a0ab79cdafacaa4faf7d0a860c7976a7d4bcf671996079f5f019af33215feabe024f1f495edf584f20cf940923883a65e9550dd
+  data.tar.gz: 3cc3695f26bdb194206e688996027366fed40adfd907c80f2d924209ac0d63a7f53155f277f7edd2180f4ab085d86c8a75c096f9891f83e7b1cc5ade1230de50

data/.circleci/config.yml

@@ -9,7 +9,6 @@ library_gemfile: &library_gemfile
     - "./gemfiles/dalli_20.gemfile"
     - "./gemfiles/dalli_30.gemfile"
     - "./gemfiles/dalli_32.gemfile"
-    - "./gemfiles/excon_02.gemfile"
     - "./gemfiles/excon_079.gemfile"
     - "./gemfiles/excon_100.gemfile"
     - "./gemfiles/graphql_10.gemfile"
@@ -19,6 +18,7 @@ library_gemfile: &library_gemfile
     - "./gemfiles/rack_20.gemfile"
     - "./gemfiles/rack_30.gemfile"
     - "./gemfiles/redis_40.gemfile"
+    - "./gemfiles/redis_50.gemfile"
     - "./gemfiles/rest_client_20.gemfile"
     - "./gemfiles/resque_122.gemfile"
     - "./gemfiles/resque_20.gemfile"
@@ -35,42 +35,6 @@ library_gemfile: &library_gemfile
     - "./gemfiles/mongo_216.gemfile"
     - "./gemfiles/mongo_219.gemfile"
 executors:
-  ruby_27:
-    docker:
-      - image: cimg/ruby:2.7-node
-        environment:
-          MEMCACHED_HOST: '127.0.0.1:11211'
-          REDIS_URL: 'redis://127.0.0.1:6379'
-          DATABASE_URL: 'sqlite3::memory:'
-      - image: memcached
-      - image: redis
-      - image: amazon/dynamodb-local
-      - image: minio/minio:latest
-        command: ["server", "/data"]
-      - image: s12v/sns
-      - image: softwaremill/elasticmq-native
-      - image: mongo:5-focal
-  ruby_27_mysql2:
-    docker:
-      - image: cimg/ruby:2.7-node
-        environment:
-          DATABASE_URL: "mysql2://root:passw0rd@127.0.0.1:3306/ci_test"
-      - image: mariadb
-        environment:
-          MYSQL_DATABASE: 'ci_test'
-          MYSQL_USER: 'root'
-          MYSQL_ROOT_PASSWORD: 'passw0rd'
-          MYSQL_ROOT_HOST: '%'
-  ruby_27_postgres:
-    docker:
-      - image: cimg/ruby:2.7-node
-        environment:
-          DATABASE_URL: "postgres://root:passw0rd@127.0.0.1:5432/ci_test"
-      - image: postgres
-        environment:
-          POSTGRES_DB: 'ci_test'
-          POSTGRES_USER: 'root'
-          POSTGRES_PASSWORD: 'passw0rd'
   ruby_30:
     docker:
       - image: cimg/ruby:3.0-node
@@ -327,7 +291,7 @@ jobs:
     parameters:
       stack:
         type: executor
-        default: ruby_27
+        default: ruby_30
     executor: << parameters.stack >>
     steps:
       - checkout
@@ -337,7 +301,7 @@ jobs:
     parameters:
       stack:
         type: executor
-        default: ruby_27
+        default: ruby_30
       gemfile:
         type: string
         default: "./gemfiles/aws_30.gemfile"
@@ -350,7 +314,7 @@ jobs:
       - setup
       - run_tests
   lint:
-    executor: ruby_27
+    executor: ruby_30
     steps:
       - checkout
       - setup
@@ -361,7 +325,7 @@ jobs:
       - checkout
       - run_sonarqube
   publish:
-    executor: ruby_27
+    executor: ruby_30
     steps:
       - checkout
       - setup
@@ -383,7 +347,6 @@ workflows:
           matrix:
             parameters:
               stack:
-                - ruby_27
                 - ruby_30
                 - ruby_31
                 - ruby_32
@@ -399,27 +362,6 @@ workflows:
                 - ruby_32
                 - ruby_33
               <<: *library_gemfile
-  libraries_ruby_2:
-    jobs:
-      - test_apprisal:
-          matrix:
-            parameters:
-              stack:
-                - ruby_27
-              <<: *library_gemfile
-  rails_ruby_2:
-    jobs:
-      - test_apprisal:
-          matrix:
-            parameters:
-              stack:
-                - ruby_27
-                - ruby_27_postgres
-                - ruby_27_mysql2
-              gemfile:
-                - "./gemfiles/rails_60.gemfile"
-                - "./gemfiles/rails_52.gemfile"
-                - "./gemfiles/rails_50.gemfile"
   rails_ruby_3:
     jobs:
       - test_apprisal:

data/gemfiles/redis_50.gemfile

@@ -0,0 +1,14 @@
+# (c) Copyright IBM Corp. 2024
+
+source "https://rubygems.org"
+
+gem "minitest-reporters"
+gem "webmock"
+gem "puma"
+gem "rubocop", "~> 1.9"
+gem "rack-test"
+gem "simplecov", "~> 0.21.2"
+gem "redis", ">= 5.0.0"
+gem "debug"
+
+gemspec path: "../"

data/instana.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.test_files    = Dir.glob("{test}/**/*.rb")
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
   spec.platform      = defined?(JRUBY_VERSION) ? 'java' : Gem::Platform::RUBY
 
   spec.add_development_dependency "bundler", "~> 2.0"

data/lib/instana/activators/redis.rb

@@ -5,13 +5,18 @@ module Instana
   module Activators
     class Redis < Activator
       def can_instrument?
-        defined?(::Redis) && defined?(::Redis::Client) && ::Instana.config[:redis][:enabled]
+        defined?(::Redis) && defined?(::Redis::Client) && ::Instana.config[:redis][:enabled] &&
+          (Gem::Specification.find_by_name('redis').version < Gem::Version.new('5.0') || defined?(::RedisClient))
       end
 
       def instrument
         require 'instana/instrumentation/redis'
 
-        ::Redis::Client.prepend(::Instana::RedisInstrumentation)
+        if Gem::Specification.find_by_name('redis').version >= Gem::Version.new('5.0')
+          ::RedisClient.prepend(::Instana::RedisInstrumentation)
+        else
+          ::Redis::Client.prepend(::Instana::RedisInstrumentation)
+        end
 
         true
       end

data/lib/instana/instrumentation/redis.rb

@@ -1,58 +1,85 @@
-# (c) Copyright IBM Corp. 2021
+# (c) Copyright IBM Corp. 2024
 # (c) Copyright Instana Inc. 2017
 
 module Instana
   module RedisInstrumentation
-    def call(*args, &block)
-      kv_payload = { redis: {} }
-      dnt_spans = [:redis, :'resque-client', :'sidekiq-client']
+    if Gem::Specification.find_by_name('redis').version >= Gem::Version.new('5.0') && defined?(::RedisClient)
+      ORIGINAL_METHODS = {
+        :call_v => ::RedisClient.instance_method(:call_v),
+        :pipelined => ::RedisClient.instance_method(:pipelined),
+        :multi => ::RedisClient.instance_method(:multi)
+      }.freeze
 
-      if !Instana.tracer.tracing? || dnt_spans.include?(::Instana.tracer.current_span.name) || !Instana.config[:redis][:enabled]
-        return super(*args, &block)
+      def call_v(*args, &block)
+        if skip_instrumentation?
+          super(*args, &block)
+        else
+          call_with_instana(args[0][0].to_s.upcase, ORIGINAL_METHODS[:call_v], *args, &block)
+        end
       end
 
-      begin
-        ::Instana.tracer.log_entry(:redis)
+      def pipelined(*args, &block)
+        if skip_instrumentation?
+          super(*args, &block)
+        else
+          call_with_instana('PIPELINE', ORIGINAL_METHODS[:pipelined], *args, &block)
+        end
+      end
 
-        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
+      # Since, starting with 5.1 redis/client.rb:114:multi takes an unused default argument `watch: nil`
+      # but calls redis_client.rb:442:multi, which doesn't take any argument,
+      # here we have to take arguments but we should not use it.
+      def multi(*_, &block)
+        if skip_instrumentation?
+          super(&block)
+        else
+          call_with_instana('MULTI', ORIGINAL_METHODS[:multi], &block)
         end
+      end
 
-        super(*args, &block)
-      rescue => e
-        ::Instana.tracer.log_info({ redis: {error: true} })
-        ::Instana.tracer.log_error(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:redis, kv_payload)
+    else
+      ORIGINAL_METHODS = {
+        :call => ::Redis::Client.instance_method(:call),
+        :call_pipeline => ::Redis::Client.instance_method(:call_pipeline)
+      }.freeze
+
+      def call(*args, &block)
+        if skip_instrumentation?
+          super(*args, &block)
+        else
+          call_with_instana(args[0][0].to_s.upcase, ORIGINAL_METHODS[:call], *args, &block)
+        end
+      end
+
+      def call_pipeline(*args, &block)
+        if skip_instrumentation?
+          super(*args, &block)
+        else
+          call_with_instana(args.first.is_a?(::Redis::Pipeline::Multi) ? 'MULTI' : 'PIPELINE', ORIGINAL_METHODS[:call_pipeline], *args, &block)
+        end
       end
     end
 
-    def call_pipeline(*args, &block)
-      kv_payload = { redis: {} }
+    def skip_instrumentation?
       dnt_spans = [:redis, :'resque-client', :'sidekiq-client']
+      !Instana.tracer.tracing? || dnt_spans.include?(::Instana.tracer.current_span.name) || !Instana.config[:redis][:enabled]
+    end
 
-      if !Instana.tracer.tracing? || dnt_spans.include?(::Instana.tracer.current_span.name) || !Instana.config[:redis][:enabled]
-        return super(*args, &block)
-      end
+    def call_with_instana(*args, &block)
+      command, original_super, *original_args = *args
+      kv_payload = { redis: {} }
 
       begin
         ::Instana.tracer.log_entry(:redis)
 
-        pipeline = args.first
         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'
+          kv_payload[:redis][:command] = command
         rescue
           nil
         end
-
-        super(*args, &block)
+        original_super.bind(self).call(*original_args, &block)
       rescue => e
         ::Instana.tracer.log_info({ redis: {error: true} })
         ::Instana.tracer.log_error(e)

data/lib/instana/version.rb

@@ -2,6 +2,6 @@
 # (c) Copyright Instana Inc. 2016
 
 module Instana
-  VERSION = "1.213.3"
+  VERSION = "1.214.0"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/test/instrumentation/redis_test.rb

@@ -49,9 +49,9 @@ class RedisTest < Minitest::Test
     clear_all!
 
     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 |pipeline|
+        pipeline.set('hello', 'world')
+        pipeline.set('other', 'world')
       end
     end
 
@@ -63,9 +63,9 @@ class RedisTest < Minitest::Test
 
     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 |pipeline|
+          pipeline.set('other', 'world')
+          pipeline.call('invalid')
         end
       rescue; end
     end
@@ -77,9 +77,9 @@ class RedisTest < Minitest::Test
     clear_all!
 
     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 |multi|
+        multi.set('hello', 'world')
+        multi.set('other', 'world')
       end
     end
 
@@ -91,9 +91,9 @@ class RedisTest < Minitest::Test
 
     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 |multi|
+          multi.set('other', 'world')
+          multi.call('invalid')
         end
       rescue; end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.213.3
+  version: 1.214.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -185,6 +185,7 @@ files:
 - gemfiles/rails_70.gemfile
 - gemfiles/rails_71.gemfile
 - gemfiles/redis_40.gemfile
+- gemfiles/redis_50.gemfile
 - gemfiles/resque_122.gemfile
 - gemfiles/resque_20.gemfile
 - gemfiles/rest_client_20.gemfile
@@ -391,14 +392,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Ruby Distributed Tracing & Metrics Sensor for Instana