opentelemetry-instrumentation-mysql2 0.32.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe5802333df89f7d42ff1651e5e5d1fa7831ce91485700921ef097211391d8c7
-  data.tar.gz: 717b432d2bd32839f71f80306b74cb5add836bc470c7f43a871b669768036938
+  metadata.gz: 2135692bfbdd0cca5ed9f3183b27c27764a707e1de9fbb5a40490b1ee17673a5
+  data.tar.gz: 17ec5c108d11bd9408b4deedd4cd287fb4d449999a9fe1a0adbc053803c55a2a
 SHA512:
-  metadata.gz: 4e9c79653d801911e1b41afa3c46638ef57198e9781d3081fa67042fe62530cf600b3357af71536c4da993f363e1de45935395daac409074f2d743ed4aef0a0d
-  data.tar.gz: b9fdf52f2da44ab9c9f706bb0f740b3010741c3d522099ec62343604a531c99b211c1fd5e61b05abd3e4e50a35ee9285e6bfa62e1a5221611a99c410297fb78b
+  metadata.gz: 0ba2b068bb15df851e78ae523d8cd09e04e0d18d9294c37cf2edf24cdfc382d675fa877b594ae144359e4eba1a470caa11f61e504be61bffe513e701f6282dbd
+  data.tar.gz: b93bfc55a087ab7ce59fecb96271d6f601a16fdc4959782c1a534709dea8d65c45dfb81c8ba8f422ada48a1614c1f8e0ad20663b46fdb8606fe3d7e04365642c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### v0.33.0 / 2026-01-13
+
+* ADDED: Add SQL Comment Propagator
+
+### v0.32.1 / 2025-12-03
+
+* FIXED: Update gemspec dependencies to sql-processor
+
 ### v0.32.0 / 2025-12-02
 
 * ADDED: Replace references sql-obfuscation -> sql-processor

data/lib/opentelemetry/instrumentation/mysql2/instrumentation.rb

@@ -10,9 +10,10 @@ module OpenTelemetry
       # The Instrumentation class contains logic to detect and install the Mysql2
       # instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
-        install do |_config|
+        install do |config|
           require_dependencies
           patch_client
+          configure_propagator(config)
         end
 
         present do
@@ -23,6 +24,9 @@ module OpenTelemetry
         option :db_statement, default: :obfuscate, validate: %I[omit include obfuscate]
         option :span_name, default: :statement_type, validate: %I[statement_type db_name db_operation_and_name]
         option :obfuscation_limit, default: 2000, validate: :integer
+        option :propagator, default: 'none', validate: %w[none tracecontext vitess]
+
+        attr_reader :propagator
 
         private
 
@@ -33,6 +37,24 @@ module OpenTelemetry
         def patch_client
           ::Mysql2::Client.prepend(Patches::Client)
         end
+
+        def configure_propagator(config)
+          propagator = config[:propagator]
+          @propagator = case propagator
+                        when 'tracecontext' then OpenTelemetry::Helpers::SqlProcessor::SqlCommenter.sql_query_propagator
+                        when 'vitess' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::Vitess')
+                        when 'none', nil then nil
+                        else
+                          OpenTelemetry.logger.warn "The #{propagator} propagator is unknown and cannot be configured"
+                        end
+        end
+
+        def fetch_propagator(name, class_name, gem_suffix = name)
+          Kernel.const_get(class_name).sql_query_propagator
+        rescue NameError
+          OpenTelemetry.logger.warn "The #{name} propagator cannot be configured - please add opentelemetry-helpers-#{gem_suffix} to your Gemfile"
+          nil
+        end
       end
     end
   end

data/lib/opentelemetry/instrumentation/mysql2/patches/client.rb

@@ -18,8 +18,16 @@ module OpenTelemetry
               _otel_span_name(sql),
               attributes: _otel_span_attributes(sql),
               kind: :client
-            ) do
-              super
+            ) do |_span, context|
+              if propagator && sql.frozen?
+                sql = +sql
+                propagator.inject(sql, context: context)
+                sql.freeze
+              elsif propagator
+                propagator.inject(sql, context: context)
+              end
+
+              super(sql, options)
             end
           end
 
@@ -28,8 +36,16 @@ module OpenTelemetry
               _otel_span_name(sql),
               attributes: _otel_span_attributes(sql),
               kind: :client
-            ) do
-              super
+            ) do |_span, context|
+              if propagator && sql.frozen?
+                sql = +sql
+                propagator.inject(sql, context: context)
+                sql.freeze
+              elsif propagator
+                propagator.inject(sql, context: context)
+              end
+
+              super(sql)
             end
           end
 
@@ -93,6 +109,10 @@ module OpenTelemetry
           def config
             Mysql2::Instrumentation.instance.config
           end
+
+          def propagator
+            Mysql2::Instrumentation.instance.propagator
+          end
         end
       end
     end

data/lib/opentelemetry/instrumentation/mysql2/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '0.32.0'
+      VERSION = '0.33.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-02 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-helpers-mysql
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: opentelemetry-helpers-sql-obfuscation
+  name: opentelemetry-helpers-sql-processor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,10 +87,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.32.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.33.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/mysql2
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.32.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.33.0
 post_install_message:
 rdoc_options: []
 require_paths: