opentelemetry-instrumentation-pg 0.17.1 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 722b3565568cfc7008142ab78fdffdb894b5e202bf950be9305fbd7df9ddf06e
-  data.tar.gz: 66d7e432e0b70239b64c6486fcf53c5d23c7dc8640ac0cc77a0adb151631d763
+  metadata.gz: 713150c48f2e5b9bbee47cc4f44dd65065468c5e30167edbcb7eae1c03b0d72d
+  data.tar.gz: 6e398fc92bf8c4bf5f7d082ed7fce5ce205e9b709d454b03485db9548ab9d09e
 SHA512:
-  metadata.gz: 7f4beb6dfb67adf122a82f66e4c4eb7f79dda5f14f56334546e44d0de848d5d7dbbcd96408b66b61d389e8f997be258d07346c4d77aeebc5d7e0b3f9d32a97d7
-  data.tar.gz: d0a2ee1ed362c63fbc653ec32bccb72fd162f1492c4d9e18e08bf13deea243c225fc4db46a7469c21afcc6a1f0eaf3cfcb7d6113df9e8aed3d4d691c9ad2bb91
+  metadata.gz: 722eac0ec7fed3069e1d2bdc898fb5f76d0ee50b11a4ac5107ebc75460763dfd10464cef85ee80dcf40b43f9fc5b254d218a3105ce43bc78fe5c373acca5edb8
+  data.tar.gz: bad89f1ece440cf3955b5a5e3378b0e25a592a5633d59e5d690d0a1f91c214ae2a582dce0b92c1faacf7cf0e7292614c60222160e92788e132c09196784a5811

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Release History: opentelemetry-instrumentation-pg
 
+### v0.19.1 / 2021-09-29
+
+* (No significant changes)
+
+### v0.19.0 / 2021-08-12
+
+* ADDED: Add db_statement toggle for postgres 
+* DOCS: Update docs to rely more on environment variable configuration 
+
+### v0.18.1 / 2021-06-23
+
+* (No significant changes)
+
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* ADDED: Add option to postgres instrumentation to disable db.statement
+
 ### v0.17.1 / 2021-04-23
 
 * Initial release.

data/README.md

@@ -35,13 +35,14 @@ end
 ```ruby
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::PG', {
-    # 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,
-
     # You may optionally set a value for 'peer.service', which
     # will be included on all spans from this instrumentation:
     peer_service: 'postgres:readonly',
+
+    # By default, this instrumentation includes the executed SQL as the `db.statement`
+    # semantic attribute. Optionally, you may disable the inclusion of this attribute entirely by
+    # setting this option to :omit or sanitize the attribute by setting to :obfuscate
+    db_statement: :include,
   }
 end
 ```

data/lib/opentelemetry/instrumentation/pg/instrumentation.rb

@@ -11,7 +11,23 @@ module OpenTelemetry
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         MINIMUM_VERSION = Gem::Version.new('1.1.0')
 
-        install do |_config|
+        install do |config|
+          if config[:enable_sql_obfuscation]
+            config[:db_statement] = :obfuscate
+            OpenTelemetry.logger.warn(
+              'Instrumentation pg configuration option enable_sql_obfuscation has been deprecated,' \
+              'use db_statement option instead'
+            )
+          end
+
+          unless config[:enable_statement_attribute]
+            config[:db_statement] = :omit
+            OpenTelemetry.logger.warn(
+              'Instrumentation pg configuration option enable_statement_attribute has been deprecated,' \
+              'use db_statement option instead'
+            )
+          end
+
           require_dependencies
           patch_client
         end
@@ -26,6 +42,8 @@ module OpenTelemetry
 
         option :peer_service, default: nil, validate: :string
         option :enable_sql_obfuscation, default: false, validate: :boolean
+        option :enable_statement_attribute, default: true, validate: :boolean
+        option :db_statement, default: :include, validate: ->(opt) { %I[omit include obfuscate].include?(opt) }
 
         private
 

data/lib/opentelemetry/instrumentation/pg/patches/connection.rb

@@ -83,7 +83,8 @@ module OpenTelemetry
               end
             end
 
-            attrs = { 'db.operation' => validated_operation(operation), 'db.statement' => sql, 'db.postgresql.prepared_statement_name' => statement_name }
+            attrs = { 'db.operation' => validated_operation(operation), 'db.postgresql.prepared_statement_name' => statement_name }
+            attrs['db.statement'] = sql unless config[:db_statement] == :omit
             attrs.reject! { |_, v| v.nil? }
 
             [span_name(operation), client_attributes.merge(attrs)]
@@ -103,7 +104,7 @@ module OpenTelemetry
           end
 
           def obfuscate_sql(sql)
-            return sql unless config[:enable_sql_obfuscation]
+            return sql unless config[:db_statement] == :obfuscate
 
             # Borrowed from opentelemetry-instrumentation-mysql2
             return 'SQL query too large to remove sensitive data ...' if sql.size > 2000

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '0.17.1'
+      VERSION = '0.19.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  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
@@ -86,14 +86,14 @@ 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: pg
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.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
@@ -187,10 +215,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-pg/v0.17.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.19.1/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/pg
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.17.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.19.1
 post_install_message: 
 rdoc_options: []
 require_paths: