diff --git a/helpers/sql-obfuscation/CHANGELOG.md b/helpers/sql-obfuscation/CHANGELOG.md index 75d1c3a194..f6365c53a9 100644 --- a/helpers/sql-obfuscation/CHANGELOG.md +++ b/helpers/sql-obfuscation/CHANGELOG.md @@ -1,5 +1,11 @@ # Release History: opentelemetry-helpers-sql-obfuscation +### Deprecation Notice / 2025-10-13 + +* **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been replaced by `opentelemetry-helpers-sql-processor`. This is the final release and serves as a transitional package. +* **ACTION REQUIRED:** No action is needed unless you use this gem directly. If you use this gem directly, update your `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead. +* **SUPPORT ENDING:** `opentelemetry-helpers-sql-obfuscation` will no longer receive updates. + ### v0.3.0 / 2025-01-16 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1 diff --git a/helpers/sql-obfuscation/README.md b/helpers/sql-obfuscation/README.md index de4c436d11..9e9ff223e4 100644 --- a/helpers/sql-obfuscation/README.md +++ b/helpers/sql-obfuscation/README.md @@ -1,4 +1,12 @@ -# OpenTelemetry Instrumentation Helpers: SQL Obfuscation +# Deprecation Notice + +**This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.** + +It has been replaced by **`opentelemetry-helpers-sql-processor`**. + +All future development, bug fixes, and feature releases will occur in the new gem. + +## OpenTelemetry Instrumentation Helpers: SQL Obfuscation This Ruby gem contains logic to obfuscate SQL. It's intended for use by by gem authors instrumenting SQL adapter libraries, such as mysql2, pg, and trilogy. diff --git a/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb b/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb index a839b7e58d..cdbb025bd9 100644 --- a/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb +++ b/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb @@ -5,3 +5,7 @@ # SPDX-License-Identifier: Apache-2.0 require_relative 'opentelemetry/helpers' + +OpenTelemetry.logger.warn <<~WARNING + [DEPRECATION] The 'opentelemetry-helpers-sql-obfuscation' gem has been renamed to 'opentelemetry-helpers-sql-processor'. No action is needed unless you use this gem directly. +WARNING diff --git a/helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec b/helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec index 734e507747..3a17a8b369 100644 --- a/helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec +++ b/helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec @@ -14,8 +14,8 @@ Gem::Specification.new do |spec| spec.authors = ['OpenTelemetry Authors'] spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] - spec.summary = 'SQL Obfuscation Instrumentation Helpers for the OpenTelemetry framework' - spec.description = 'SQL Obfuscation Instrumentation Helpers for the OpenTelemetry framework' + spec.summary = 'This gem is deprecated and no longer maintained. It has been replaced by opentelemetry-helpers-sql-processor.' + spec.description = 'This gem is deprecated and no longer maintained. It has been replaced by opentelemetry-helpers-sql-processor.' spec.homepage = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib' spec.license = 'Apache-2.0'