opentelemetry-instrumentation-pg 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce186d43d289c64ce441d6e299d4b4b4916650ce63b0a8791dab6538e4b28ff6
-  data.tar.gz: fa68247b40312aa9341841aa7bfa8a311e967de7efeab5a9fdda80c81646ab55
+  metadata.gz: 92d131df358f791a704781a41f2b4dccf138d92129ba6835179d33c01fb72c5a
+  data.tar.gz: 47bfd3067f55772f6f616c25d9d733b88734183248ddb6afa6cbfe462aa89560
 SHA512:
-  metadata.gz: 72180d064f5a606dc8649bf4229ec7a714de3c0369f50f03f34ab404410dd227ff51298846b6d891d00dece30c4036c1fd7354501152f9401ccb896b5e8b721d
-  data.tar.gz: b3ae7bc6bc75b182835d4f5d2823485da0237dd248761ee36e4cf2283c226c381753ad3cb50776adbc8bf634674451f34acc50fbaead7ee47441df94bb0d4a04
+  metadata.gz: e00cf026c0ad5bde5beb1881ea80311209b9eb44e763d59e453335a798681e71895beb197061ac60989e55f4404f1366cf2bc4d21105af47726782a56c34b32b
+  data.tar.gz: 2ea850c452a38d8fe4051f867a23d33f620a81e7e60ffbe26175fec9e5006a1993cd4b016a761fe98e5c98203cbd3aeaec2a316ba24695636c3433687721591d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History: opentelemetry-instrumentation-pg
 
+### 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)

data/README.md

@@ -35,19 +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 (possibly sanitized, according to the value of `enable_sql_obfuscation`).
-    # Optionally, you may disable the inclusion of this attribute entirely by
-    # setting this option to false.
-    enable_statement_attribute: true,
+    # 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
@@ -27,6 +43,7 @@ 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

@@ -84,7 +84,7 @@ module OpenTelemetry
             end
 
             attrs = { 'db.operation' => validated_operation(operation), 'db.postgresql.prepared_statement_name' => statement_name }
-            attrs['db.statement'] = sql if config[:enable_statement_attribute]
+            attrs['db.statement'] = sql unless config[:db_statement] == :omit
             attrs.reject! { |_, v| v.nil? }
 
             [span_name(operation), client_attributes.merge(attrs)]
@@ -104,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.18.1'
+      VERSION = '0.19.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-pg
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc2
+        version: 1.0.0.rc3
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   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.18.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.19.0/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.18.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.19.0
 post_install_message: 
 rdoc_options: []
 require_paths: