opentelemetry-helpers-sql-obfuscation 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d73e8f546afb1c2ff64b8fdac702fd87ed74f0030e5e2153a5c7982f745d8deb
-  data.tar.gz: f9ea5e0fa0f7629507a21881c97f0eb6a47f47b4e68772a01bb1425b06e0b3b5
+  metadata.gz: b82b7f32ebee1fdef7b847aab0fdcac539dff5ca52f78fa354afbd571b8223cb
+  data.tar.gz: 7c475ed907c19c0299779b139f0cbe5583639fa6a65020558b623fc8ed060e89
 SHA512:
-  metadata.gz: bb57af1b773d8e6ed9df1ec2bf9829d13b7802d685f5e82189095dbf36be59f95a0a405a85b8162bccaeaf962c6d1082b1167b14065d8b1a793b06d23ed5b3b4
-  data.tar.gz: 0326d386a88dff15667b97226aa519b617bae128a296f76a67dac488f7b7044055f48bd0ff9bda74448caa63f571fce8a2ea18e95024f0bd149c560a8108e4c2
+  metadata.gz: e778e2f31f7e6b733927ea1d8d1f167a2d4c437deac34679d1fa0cbdac8379219c5f0b9539d4186707a9f75afb443110e862d8e1635f243904d353e34f89b6dc
+  data.tar.gz: f400ec85ce9026ce735307af7e139da25f47243ab07302429989ff6fdc0b5e053c0b62b93207d622af1b588873911477aab7aaef6e4c6968613a1589bc32fef6

data/CHANGELOG.md

@@ -1,8 +1,12 @@
-# Release History: opentelemetry-helpers-sql-obfuscation
+# Release History: opentelemetry-helpers-sql-obfuscation
+
+### v0.2.0 / 2024-09-12
+
+- BREAKING CHANGE: Return message when sql is over the obfuscation limit. Fixes a bug where sql statements with prepended comments that hit the obfuscation limit would be sent raw.
 
 ### v0.1.1 / 2024-06-18
 
-* FIXED: Relax otel common gem constraints
+- FIXED: Relax otel common gem constraints
 
 ### v0.1.0 / 2024-02-08
 

data/README.md

@@ -24,7 +24,8 @@ end
 ```
 
 Make sure the `Instrumentation` class for your gem contains configuration options for:
-- `:obfuscation_limit`: the length at which the obfuscated SQL string will be truncated.
+
+- `:obfuscation_limit`: the length at which the SQL string will not be obfuscated
   Example: `option :obfuscation_limit, default: 2000, validate: :integer`
 
 If you want to add support for a new adapter, update the following constants to include keys for your adapter:
@@ -48,7 +49,7 @@ OpenTelemetry::Helpers::SqlObfuscation.obfuscate_sql(sql, obfuscation_limit: con
 
 The `opentelemetry-helpers-sql-obfuscation` gem source is [on github][repo-github], along with related gems including `opentelemetry-instrumentation-pg` and `opentelemetry-instrumentation-trilogy`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -59,4 +60,5 @@ The `opentelemetry-helpers-sql-obfuscation` gem is distributed under the Apache
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/helpers/sql_obfuscation/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Helpers
     module SqlObfuscation
-      VERSION = '0.1.1'
+      VERSION = '0.2.0'
     end
   end
 end

data/lib/opentelemetry/helpers/sql_obfuscation.rb

@@ -94,7 +94,7 @@ module OpenTelemetry
       # This is a SQL obfuscation utility intended for use in database adapter instrumentation.
       #
       # @param sql [String] The SQL to obfuscate.
-      # @param obfuscation_limit [optional Integer] The maximum length of an obfuscated sql statement.
+      # @param obfuscation_limit [optional Integer] the length at which the SQL string will not be obfuscated
       # @param adapter [optional Symbol] the type of database adapter calling the method. `:default`, `:mysql` and `:postgres` are supported.
       # @return [String] The SQL query string where the values are replaced with "?". When the sql statement exceeds the obufscation limit
       #  the first matched pair from the SQL statement will be returned, with an appended truncation message. If trunaction is unsuccessful,
@@ -102,6 +102,8 @@ module OpenTelemetry
       #
       # @api public
       def obfuscate_sql(sql, obfuscation_limit: 2000, adapter: :default)
+        return "SQL not obfuscated, query exceeds #{obfuscation_limit} characters" if sql.size > obfuscation_limit
+
         regex = case adapter
                 when :mysql
                   MYSQL_COMPONENTS_REGEX
@@ -115,7 +117,6 @@ module OpenTelemetry
         # https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/160
         # https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/345
         sql = OpenTelemetry::Common::Utilities.utf8_encode(sql, binary: true)
-        return truncate_statement(sql, regex, obfuscation_limit) if sql.size > obfuscation_limit
 
         sql = sql.gsub(regex, PLACEHOLDER)
         return 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if CLEANUP_REGEX[adapter].match(sql)
@@ -124,16 +125,6 @@ module OpenTelemetry
       rescue StandardError => e
         OpenTelemetry.handle_error(message: 'Failed to obfuscate SQL', exception: e)
       end
-
-      # @api private
-      def truncate_statement(sql, regex, limit)
-        first_match_index = sql.index(regex)
-        truncation_message = "SQL truncated (> #{limit} characters)"
-        return truncation_message unless first_match_index
-
-        truncated_sql = sql[..first_match_index - 1]
-        "#{truncated_sql}...\n#{truncation_message}"
-      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-helpers-sql-obfuscation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.0
+        version: 1.66.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.0
+        version: 1.66.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -155,10 +155,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.1.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.2.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/helpers/sql-obfuscation
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.1.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: