opentelemetry-instrumentation-mysql2 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dd5337ce5e46679d577e51b807122cb037299d844ab8405d46c2043d2484931
-  data.tar.gz: c5df05b92be367a4c4397cfcb9eb76c5b5ca0f4fd0b6ee21d61a7bfafa1f1611
+  metadata.gz: 0ad3ae6b6610cf9d0556d5bf4dceef82d4b3707806a61fb0216042e4aa00d255
+  data.tar.gz: 5091b545504f3d953650f5a84d0ff2397852e4b578f3019d7e329c998c4d97b7
 SHA512:
-  metadata.gz: 8f183aee9dd0938d0c59928cafa9dd146fafaddb10a246b8486e333139abef478decd4fa1cea0c493012ab300c508302446102b15653092ead1e91d6a739e275
-  data.tar.gz: 4fc278b6756d5f744bf532999da01d95328eca700594e572039c2e51d81df668fc7674b040dbc2d8f350232a3fc267566974d40f393aef35428f1e308dc364be
+  metadata.gz: 16da6501db3c0b84afc847fc42f7280211c6716a63912a9dff00febb18c75c854348713ceb7fae4a1579ee28f6a02b880e0e2255716c8a3d2297a49a663e686c
+  data.tar.gz: f59648d2163a0867a7726ad05bedf61b6dccd47493cdf8bcdafec6ccb85b3e61aaa2c45656281763a7b3787a93787d34490ed05809641ee4668a133615dad83a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### v0.27.0 / 2024-02-15
+
+* ADDED: Instrument mysql2 prepare statement
+
+### v0.26.1 / 2024-02-08
+
+* FIXED: Add missing requires for sql-helpers to mysql, pg, and trilogy instrumentation
+
 ### v0.26.0 / 2024-02-08
 
 * BREAKING CHANGE: Move shared sql behavior to helper gems

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

@@ -4,6 +4,9 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'opentelemetry-helpers-mysql'
+require 'opentelemetry-helpers-sql-obfuscation'
+
 module OpenTelemetry
   module Instrumentation
     module Mysql2
@@ -11,7 +14,40 @@ module OpenTelemetry
         # Module to prepend to Mysql2::Client for instrumentation
         module Client
           def query(sql, options = {})
-            attributes = client_attributes
+            tracer.in_span(
+              _otel_span_name(sql),
+              attributes: _otel_span_attributes(sql),
+              kind: :client
+            ) do
+              super(sql, options)
+            end
+          end
+
+          def prepare(sql)
+            tracer.in_span(
+              _otel_span_name(sql),
+              attributes: _otel_span_attributes(sql),
+              kind: :client
+            ) do
+              super(sql)
+            end
+          end
+
+          private
+
+          def _otel_span_name(sql)
+            OpenTelemetry::Helpers::MySQL.database_span_name(
+              sql,
+              OpenTelemetry::Instrumentation::Mysql2.attributes[
+                SemanticConventions::Trace::DB_OPERATION
+              ],
+              _otel_database_name,
+              config
+            )
+          end
+
+          def _otel_span_attributes(sql)
+            attributes = _otel_client_attributes
             case config[:db_statement]
             when :include
               attributes[SemanticConventions::Trace::DB_STATEMENT] = sql
@@ -21,30 +57,18 @@ module OpenTelemetry
                   sql, obfuscation_limit: config[:obfuscation_limit], adapter: :mysql
                 )
             end
-            tracer.in_span(
-              OpenTelemetry::Helpers::MySQL.database_span_name(
-                sql,
-                OpenTelemetry::Instrumentation::Mysql2.attributes[
-                  SemanticConventions::Trace::DB_OPERATION
-                ],
-                database_name,
-                config
-              ),
-              attributes: attributes.merge!(OpenTelemetry::Instrumentation::Mysql2.attributes),
-              kind: :client
-            ) do
-              super(sql, options)
-            end
-          end
 
-          private
+            attributes.merge!(OpenTelemetry::Instrumentation::Mysql2.attributes)
+            attributes.compact!
+            attributes
+          end
 
-          def database_name
+          def _otel_database_name
             # https://github.com/brianmario/mysql2/blob/ca08712c6c8ea672df658bb25b931fea22555f27/lib/mysql2/client.rb#L78
             (query_options[:database] || query_options[:dbname] || query_options[:db])&.to_s
           end
 
-          def client_attributes
+          def _otel_client_attributes
             # The client specific attributes can be found via the query_options instance variable
             # exposed on the mysql2 Client
             # https://github.com/brianmario/mysql2/blob/ca08712c6c8ea672df658bb25b931fea22555f27/lib/mysql2/client.rb#L25-L26
@@ -56,8 +80,9 @@ module OpenTelemetry
               SemanticConventions::Trace::NET_PEER_NAME => host,
               SemanticConventions::Trace::NET_PEER_PORT => port
             }
-            attributes[SemanticConventions::Trace::DB_NAME] = database_name if database_name
-            attributes[SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] if config[:peer_service]
+
+            attributes[SemanticConventions::Trace::DB_NAME] = _otel_database_name
+            attributes[SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service]
             attributes
           end
 

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '0.26.0'
+      VERSION = '0.27.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -255,10 +255,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.26.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.27.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.26.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-mysql2/0.27.0
 post_install_message: 
 rdoc_options: []
 require_paths: