opentelemetry-instrumentation-mysql2 0.17.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8046ef05a5deaaf15de879528829ffd2afcc3249a902e7c101134082efcf2213
-  data.tar.gz: 137b5d091131f449d0f796e3af7fe10ede9d2a8db81a14534fb5313f3be1e446
+  metadata.gz: 12b6b5712065c1bd63b04766999270aed5e6feb68f30becc97f453d23ccfffb9
+  data.tar.gz: dc7d19ddd48df92d5463df04b265dfcc8a98366a2ef62199e032a68c6d4193f2
 SHA512:
-  metadata.gz: 9c7fa062c32f5dbac9166cd4ca99267b4be29b6eab23d040b5271b32be43d84acb8448e210a9108dff435cba5e67c15479a7901b014c5575b51874d2dd89b480
-  data.tar.gz: ca613f5aac7bf981ee4ac26033b0312c211deab8fc1e251204f4f576d9a99be1457b87899383186c6e22c37e2c9bc3f1a0dfa21ea29834d7d7de2b3bf3116c5e
+  metadata.gz: 1f5ed045c7a312ee4487b064ca810fedff9cac72e86d7b7b851db5d411df19a61feb6bd71cf83b5c7b081eb9ac2edfecfd544d7c62324a741a3c113959ba7a36
+  data.tar.gz: 37944cd8d1e6b40a0c95e8c40b2b6dfbb20a2a36ef956a2b8c710a346b4c1bfa87431be9b07d167472365b641899c6995ca29be692696b35b1034a8116b66217

data/CHANGELOG.md

@@ -1,18 +1,39 @@
 # Release History: opentelemetry-instrumentation-mysql2
 
+### v0.19.1 / 2021-09-29
+
+* (No significant changes)
+
+### v0.19.0 / 2021-08-12
+
+* BREAKING CHANGE: Add option for db.statement 
+
+* ADDED: Add option for db.statement 
+* DOCS: Update docs to rely more on environment variable configuration 
+* DOCS: Move to using new db_statement 
+
+### v0.18.1 / 2021-06-23
+
+* (No significant changes)
+
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* Fix: Nil value for db.name attribute #744
+
 ### v0.17.0 / 2021-04-22
 
 * (No significant changes)
 
 ### v0.16.0 / 2021-03-17
 
-* FIXED: Update DB semantic conventions 
-* FIXED: Example scripts now reference local common lib 
+* FIXED: Update DB semantic conventions
+* FIXED: Example scripts now reference local common lib
 * ADDED: Configurable obfuscation of sql in mysql2 instrumentation to avoid logging sensitive data
 
 ### v0.15.0 / 2021-02-18
 
-* ADDED: Add instrumentation config validation 
+* ADDED: Add instrumentation config validation
 
 ### v0.14.0 / 2021-02-03
 
@@ -28,12 +49,12 @@
 
 ### v0.11.0 / 2020-12-11
 
-* ADDED: Add peer service config to mysql 
-* FIXED: Copyright comments to not reference year 
+* ADDED: Add peer service config to mysql
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.1 / 2020-12-09
 
-* FIXED: Semantic conventions db.type -> db.system 
+* FIXED: Semantic conventions db.type -> db.system
 
 ### v0.10.0 / 2020-12-03
 
@@ -41,19 +62,19 @@
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Add timeout for force_flush and shutdown 
+* ADDED: Add timeout for force_flush and shutdown
 
 ### v0.8.0 / 2020-10-27
 
-* BREAKING CHANGE: Remove 'canonical' from status codes 
+* BREAKING CHANGE: Remove 'canonical' from status codes
 
-* FIXED: Remove 'canonical' from status codes 
+* FIXED: Remove 'canonical' from status codes
 
 ### v0.7.0 / 2020-10-07
 
-* DOCS: Standardize toplevel docs structure and readme 
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 

data/README.md

@@ -36,8 +36,8 @@ end
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::Mysql2', {
     # The obfuscation of SQL in the db.statement attribute is disabled by default.
-    # To enable, set enable_sql_obfuscation to true.
-    enable_sql_obfuscation: false,
+    # To enable, set db_statement to :obfuscate.
+    db_statement: :obfuscate,
   }
 end
 ```

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

@@ -10,7 +10,15 @@ 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|
+          if config[:enable_sql_obfuscation]
+            config[:db_statement] = :obfuscate
+            OpenTelemetry.logger.warn(
+              'Instrumentation mysql2 configuration option enable_sql_obfuscation has been deprecated,' \
+              'use db_statement option instead'
+            )
+          end
+
           require_dependencies
           patch_client
         end
@@ -21,6 +29,7 @@ module OpenTelemetry
 
         option :peer_service, default: nil, validate: :string
         option :enable_sql_obfuscation, default: false, validate: :boolean
+        option :db_statement, default: :include, validate: ->(opt) { %I[omit include obfuscate].include?(opt) }
 
         private
 

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

@@ -51,11 +51,16 @@ module OpenTelemetry
           ].freeze
 
           def query(sql, options = {})
+            attributes = client_attributes
+            case config[:db_statement]
+            when :include
+              attributes['db.statement'] = sql
+            when :obfuscate
+              attributes['db.statement'] = obfuscate_sql(sql)
+            end
             tracer.in_span(
               database_span_name(sql),
-              attributes: client_attributes.merge(
-                'db.statement' => obfuscate_sql(sql)
-              ),
+              attributes: attributes,
               kind: :client
             ) do
               super(sql, options)
@@ -65,8 +70,6 @@ module OpenTelemetry
           private
 
           def obfuscate_sql(sql)
-            return sql unless config[:enable_sql_obfuscation]
-
             if sql.size > 2000
               'SQL query too large to remove sensitive data ...'
             else
@@ -119,10 +122,10 @@ module OpenTelemetry
 
             attributes = {
               'db.system' => 'mysql',
-              'db.name' => database_name,
               'net.peer.name' => host,
               'net.peer.port' => port
             }
+            attributes['db.name'] = database_name if database_name
             attributes['peer.service'] = config[:peer_service] if config[:peer_service]
             attributes
           end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Mysql2
-      VERSION = '0.17.0'
+      VERSION = '0.19.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-mysql2
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.3
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -185,10 +213,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.17.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.19.1/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/mysql2
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.17.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.19.1
 post_install_message: 
 rdoc_options: []
 require_paths: