feat!: deprecate sql-obfuscation gem (open-telemetry#1674)

* feat!: deprecate gem

* Update message

* Only one heading for README

* Feedback updates

* Revert version

* Update helpers/sql-obfuscation/CHANGELOG.md

Co-authored-by: Kayla Reopelle <[email protected]>

* Update readme

* Update helpers/sql-obfuscation/README.md

* Update gemspec description

---------

Co-authored-by: Kayla Reopelle <[email protected]>

Author: 2 people

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

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.
 

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

helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   spec.authors     = ['OpenTelemetry Authors']
   spec.email       = ['[email protected]']
 
-  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'