Feat add support for bunny

.circleci/config.yml

@@ -16,6 +16,8 @@ library_gemfile: &library_gemfile
     - "./gemfiles/graphql_20.gemfile"
     - "./gemfiles/grpc_10.gemfile"
     - "./gemfiles/net_http_01.gemfile"
+    - "./gemfiles/bunny_223.gemfile"
+    - "./gemfiles/bunny_224.gemfile"
     - "./gemfiles/rack_20.gemfile"
     - "./gemfiles/rack_30.gemfile"
     - "./gemfiles/redis_40.gemfile"
@@ -56,6 +58,7 @@ executors:
       - image: quay.io/minio/minio
         command: ["server", "/data"]
       - image: s12v/sns
+      - image: public.ecr.aws/docker/library/rabbitmq:latest
       - image: public.ecr.aws/sprig/elasticmq-native
       - image: public.ecr.aws/docker/library/mongo:5-focal
   mysql2:

Appraisals

@@ -122,3 +122,11 @@ end
 appraise 'mongo-216' do
   gem 'mongo', '>= 2.16', '< 3'
 end
+
+appraise 'bunny-223' do
+  gem 'bunny', '~> 2.23.0'
+end
+
+appraise 'bunny-224' do
+  gem 'bunny', '>= 2.24', '< 3.0'
+end

extras/license_header.rb

@@ -14,7 +14,6 @@ class LicenseHeader < Base
         HEADER = '(c) Copyright IBM Corp.'.freeze
         HEADER_TEMPLATE = <<~HERE.freeze
           # (c) Copyright IBM Corp. %d
-          # (c) Copyright Instana Inc. %d
         HERE
 
         def on_new_investigation

gemfiles/bunny_223.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+# (c) Copyright IBM Corp. 2025
+
+source "https://rubygems.org"
+
+gem "minitest-reporters"
+gem "webmock"
+gem "puma"
+gem "rack"
+gem "rackup"
+gem "rack-test"
+gem "simplecov", "~> 0.21.2"
+gem "bunny", "~> 2.23.0"
+
+gemspec path: "../"

gemfiles/bunny_224.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+# (c) Copyright IBM Corp. 2025
+
+source "https://rubygems.org"
+
+gem "minitest-reporters"
+gem "webmock"
+gem "puma"
+gem "rack"
+gem "rackup"
+gem "rack-test"
+gem "simplecov", "~> 0.21.2"
+gem "bunny", '>= 2.24', '< 3.0'
+
+gemspec path: "../"

instana.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0'
   spec.platform      = defined?(JRUBY_VERSION) ? 'java' : Gem::Platform::RUBY
 
-  spec.add_development_dependency "bundler", "~> 2.0"
+  # spec.add_development_dependency "bundler", "=> 2.0"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "minitest", "~> 5.20"
   spec.add_development_dependency "appraisal"

lib/instana/activators/bunny.rb

@@ -0,0 +1,23 @@
+# (c) Copyright IBM Corp. 2025
+
+module Instana
+  module Activators
+    class Bunny < Activator
+      def can_instrument?
+        defined?(::Bunny) &&
+          defined?(::Bunny::Queue) &&
+          defined?(::Bunny::Exchange) &&
+          ::Instana.config[:bunny][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/bunny'
+
+        ::Bunny::Exchange.prepend(::Instana::Instrumentation::BunnyProducer)
+        ::Bunny::Queue.prepend(::Instana::Instrumentation::BunnyConsumer)
+
+        true
+      end
+    end
+  end
+end

lib/instana/config.rb

@@ -64,6 +64,7 @@ def initialize(logger: ::Instana.logger, agent_host: ENV['INSTANA_AGENT_HOST'],
       @config[:action_controller]  = { :enabled => true }
       @config[:action_view]        = { :enabled => true }
       @config[:active_record]      = { :enabled => true }
+      @config[:bunny]              = { :enabled => true }
       @config[:dalli]              = { :enabled => true }
       @config[:excon]              = { :enabled => true }
       @config[:grpc]               = { :enabled => true }

lib/instana/instrumentation/bunny.rb

@@ -0,0 +1,128 @@
+# (c) Copyright IBM Corp. 2025
+
+module Instana
+  module Instrumentation
+    module BunnyProducer
+      def publish(payload, options = {})
+        if ::Instana.tracer.tracing?
+          exchange_name = name.empty? ? 'default' : name
+          routing_key = options[:routing_key] || ''
+
+          kvs = {
+            rabbitmq: {
+              sort: 'publish',
+              address: channel.connection.host,
+              key: routing_key,
+              exchange: exchange_name
+            }
+          }
+
+          ::Instana.tracer.in_span(:rabbitmq, attributes: kvs) do |span|
+            # Inject trace context into message headers
+            options[:headers] ||= {}
+            options[:headers]['X-Instana-T'] = span.context.trace_id
+            options[:headers]['X-Instana-S'] = span.context.span_id
+            options[:headers]['X-Instana-L'] = span.context.level.to_s
+
+            super(payload, options)
+          end
+        else
+          super(payload, options)
+        end
+      rescue => e
+        ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" }
+        raise
+      end
+    end
+
+    module BunnyConsumer
+      def pop(options = {})
+        delivery_info, properties, payload = super(options)
+
+        return [delivery_info, properties, payload] unless delivery_info
+
+        trace_rabbitmq_consume(delivery_info, properties) do
+          [delivery_info, properties, payload]
+        end
+      rescue => e
+        log_error(e)
+        raise
+      end
+
+      def subscribe(options = {}, &block)
+        if block_given?
+          wrapped_block = lambda do |delivery_info, properties, payload|
+            trace_rabbitmq_consume(delivery_info, properties) do
+              block.call(delivery_info, properties, payload)
+            end
+          end
+
+          super(options, &wrapped_block)
+        else
+          super(options, &block)
+        end
+      rescue => e
+        log_error(e)
+        raise
+      end
+
+      private
+
+      def trace_rabbitmq_consume(delivery_info, properties, &block)
+        return yield unless ::Instana.tracer.tracing? || extract_context_from_headers(properties)
+
+        kvs = build_consume_attributes(delivery_info)
+        context = extract_context_from_headers(properties)
+
+        if context[:trace_id]
+          trace_with_context(context, kvs, &block)
+        else
+          ::Instana.tracer.in_span(:rabbitmq, attributes: kvs, &block)
+        end
+      end
+
+      def build_consume_attributes(delivery_info)
+        queue_name = name
+        exchange_name = delivery_info.exchange.empty? ? 'default' : delivery_info.exchange
+
+        {
+          rabbitmq: {
+            sort: 'consume',
+            address: channel.connection.host,
+            queue: queue_name,
+            exchange: exchange_name,
+            key: delivery_info.routing_key
+          }
+        }
+      end
+
+      def trace_with_context(context, kvs, &block)
+        instana_context = ::Instana::SpanContext.new(
+          trace_id: context[:trace_id],
+          span_id: context[:span_id],
+          level: context[:level]
+        )
+        span = OpenTelemetry::Trace.non_recording_span(instana_context)
+
+        Trace.with_span(span) do
+          ::Instana.tracer.in_span(:rabbitmq, attributes: kvs, &block)
+        end
+      end
+
+      def extract_context_from_headers(properties)
+        return {} unless properties && properties.headers
+
+        headers = properties.headers
+        {
+          trace_id: headers['X-Instana-T'],
+          span_id: headers['X-Instana-S'],
+          level: headers['X-Instana-L']&.to_i
+        }.reject { |_, v| v.nil? }
+      end
+
+      def log_error(error)
+        ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{error.message}" }
+      end
+    end
+  end
+end

lib/instana/trace/span_kind.rb

@@ -9,13 +9,13 @@ module Instana
   module SpanKind
     # Instana specific spans
     REGISTERED_SPANS = [:actioncontroller, :actionview, :activerecord, :excon,
-                        :memcache, :'net-http', :rack, :render, :'rpc-client',
+                        :memcache, :'net-http', :rack, :rabbitmq, :render, :'rpc-client',
                         :'rpc-server', :'sidekiq-client', :'sidekiq-worker',
                         :redis, :'resque-client', :'resque-worker', :'graphql.server', :dynamodb, :s3, :sns, :sqs, :'aws.lambda.entry', :activejob, :log, :"mail.actionmailer",
                         :"aws.lambda.invoke", :mongo, :sequel].freeze
-    ENTRY_SPANS = [:rack, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server', :sqs,
+    ENTRY_SPANS = [:rack, :rabbitmq, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server', :sqs,
                    :'aws.lambda.entry'].freeze
-    EXIT_SPANS = [:activerecord, :excon, :'net-http', :'resque-client',
+    EXIT_SPANS = [:activerecord, :excon, :'net-http', :rabbitmq, :'resque-client',
                   :'rpc-client', :'sidekiq-client', :redis, :dynamodb, :s3, :sns, :sqs, :log, :"mail.actionmailer",
                   :"aws.lambda.invoke", :mongo, :sequel].freeze
     HTTP_SPANS = [:rack, :excon, :'net-http'].freeze

test/activator_test.rb

@@ -43,7 +43,7 @@ def test_unlimited_activated_set
     ENV.delete('INSTANA_ACTIVATE_SET')
     subject = activated_set
     assert_instance_of Set, subject
-    assert_equal 32, subject.length
+    assert_equal 33, subject.length
   ensure
     ENV.delete('INSTANA_ACTIVATE_SET')
   end