From b3b78777e6369699b733682a562366da438f7eea Mon Sep 17 00:00:00 2001 From: Hannah Ramadan Date: Mon, 15 Sep 2025 11:47:02 -0700 Subject: [PATCH 1/9] feat!: deprecate gem --- helpers/sql-obfuscation/CHANGELOG.md | 6 ++++++ helpers/sql-obfuscation/README.md | 8 ++++++++ .../lib/opentelemetry-helpers-sql-obfuscation.rb | 5 +++++ .../lib/opentelemetry/helpers/sql_obfuscation/version.rb | 2 +- 4 files changed, 20 insertions(+), 1 deletion(-) diff --git a/helpers/sql-obfuscation/CHANGELOG.md b/helpers/sql-obfuscation/CHANGELOG.md index 75d1c3a194..16d3d9e941 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-09-23 + +* **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been renamed to `opentelemetry-helpers-sql-processor`. This version (`1.0.0`) is the final release and serves as a transitional package. +* **ACTION REQUIRED:** Users must update their `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead. +* **SUPPORT ENDING:** `opentelemetry-helpers-sql-obfuscation` will no longer receive updates. We plan to remove it from RubyGems entirely after a transition period (approximately 3-6 months). + ### 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..2cb8123f5b 100644 --- a/helpers/sql-obfuscation/README.md +++ b/helpers/sql-obfuscation/README.md @@ -1,3 +1,11 @@ +# Deprecation Notice + +**⚠️ This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.** + +It has been renamed to **`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..fec6003fc3 100644 --- a/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb +++ b/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb @@ -5,3 +5,8 @@ # SPDX-License-Identifier: Apache-2.0 require_relative 'opentelemetry/helpers' + +OpenTelemetry.logger.warn <<~WARNING + [DEPRECATION] The 'opentelemetry-helpers-sql-obfuscation' is deprecated and has been replaced by 'opentelemetry-helpers-sql-processor'. + Please update your Gemfile to use 'opentelemetry-helpers-sql-processor' instead. +WARNING diff --git a/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb b/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb index a8a1fc54a1..afc6c5f0ff 100644 --- a/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb +++ b/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb @@ -7,7 +7,7 @@ module OpenTelemetry module Helpers module SqlObfuscation - VERSION = '0.3.0' + VERSION = '1.0.0' end end end From 4ce16150d752ae01a735eb9dbe32c3e3126e8a60 Mon Sep 17 00:00:00 2001 From: Hannah Ramadan Date: Tue, 16 Sep 2025 11:22:43 -0700 Subject: [PATCH 2/9] Update message --- .../lib/opentelemetry-helpers-sql-obfuscation.rb | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb b/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb index fec6003fc3..cdbb025bd9 100644 --- a/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb +++ b/helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb @@ -7,6 +7,5 @@ require_relative 'opentelemetry/helpers' OpenTelemetry.logger.warn <<~WARNING - [DEPRECATION] The 'opentelemetry-helpers-sql-obfuscation' is deprecated and has been replaced by 'opentelemetry-helpers-sql-processor'. - Please update your Gemfile to use 'opentelemetry-helpers-sql-processor' instead. + [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 From d1c9916cc1fa2b97c25f340f80b4f1fa8bde7566 Mon Sep 17 00:00:00 2001 From: Hannah Ramadan Date: Tue, 16 Sep 2025 11:25:21 -0700 Subject: [PATCH 3/9] Only one heading for README --- helpers/sql-obfuscation/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/helpers/sql-obfuscation/README.md b/helpers/sql-obfuscation/README.md index 2cb8123f5b..7b867f09a7 100644 --- a/helpers/sql-obfuscation/README.md +++ b/helpers/sql-obfuscation/README.md @@ -6,7 +6,7 @@ It has been renamed to **`opentelemetry-helpers-sql-processor`**. All future development, bug fixes, and feature releases will occur in the new gem. -# OpenTelemetry Instrumentation Helpers: SQL Obfuscation +## 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. From fd02b84045f498b0f515bd605bf840040a04cf0d Mon Sep 17 00:00:00 2001 From: Hannah Ramadan Date: Mon, 6 Oct 2025 15:53:18 -0700 Subject: [PATCH 4/9] Feedback updates --- helpers/sql-obfuscation/CHANGELOG.md | 6 +++--- helpers/sql-obfuscation/README.md | 2 +- .../lib/opentelemetry/helpers/sql_obfuscation/version.rb | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/helpers/sql-obfuscation/CHANGELOG.md b/helpers/sql-obfuscation/CHANGELOG.md index 16d3d9e941..eb17355f96 100644 --- a/helpers/sql-obfuscation/CHANGELOG.md +++ b/helpers/sql-obfuscation/CHANGELOG.md @@ -1,10 +1,10 @@ # Release History: opentelemetry-helpers-sql-obfuscation -### 💥 Deprecation Notice / 2025-09-23 +### Deprecation Notice / 2025-10-13 -* **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been renamed to `opentelemetry-helpers-sql-processor`. This version (`1.0.0`) is the final release and serves as a transitional package. +* **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been replaced by `opentelemetry-helpers-sql-processor`. This version (`1.0.0`) is the final release and serves as a transitional package. No action is needed unless you use this gem directly. * **ACTION REQUIRED:** Users must update their `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead. -* **SUPPORT ENDING:** `opentelemetry-helpers-sql-obfuscation` will no longer receive updates. We plan to remove it from RubyGems entirely after a transition period (approximately 3-6 months). +* **SUPPORT ENDING:** `opentelemetry-helpers-sql-obfuscation` will no longer receive updates. ### v0.3.0 / 2025-01-16 diff --git a/helpers/sql-obfuscation/README.md b/helpers/sql-obfuscation/README.md index 7b867f09a7..01b513fb98 100644 --- a/helpers/sql-obfuscation/README.md +++ b/helpers/sql-obfuscation/README.md @@ -2,7 +2,7 @@ **⚠️ This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.** -It has been renamed to **`opentelemetry-helpers-sql-processor`**. +It has been replace by **`opentelemetry-helpers-sql-processor`**. All future development, bug fixes, and feature releases will occur in the new gem. diff --git a/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb b/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb index afc6c5f0ff..3d90c2db07 100644 --- a/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb +++ b/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb @@ -7,7 +7,7 @@ module OpenTelemetry module Helpers module SqlObfuscation - VERSION = '1.0.0' + VERSION = '0.4.0' end end end From 8f657537fd14d4b704bc241085a286428df56aac Mon Sep 17 00:00:00 2001 From: Hannah Ramadan Date: Mon, 6 Oct 2025 15:54:32 -0700 Subject: [PATCH 5/9] Revert version --- .../lib/opentelemetry/helpers/sql_obfuscation/version.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb b/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb index 3d90c2db07..a8a1fc54a1 100644 --- a/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb +++ b/helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb @@ -7,7 +7,7 @@ module OpenTelemetry module Helpers module SqlObfuscation - VERSION = '0.4.0' + VERSION = '0.3.0' end end end From 5bf7dddbf8c1f1d8356cd0742f24401b596bb14b Mon Sep 17 00:00:00 2001 From: Hannah Ramadan <76922290+hannahramadan@users.noreply.github.com> Date: Tue, 7 Oct 2025 10:23:04 -0700 Subject: [PATCH 6/9] Update helpers/sql-obfuscation/CHANGELOG.md Co-authored-by: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> --- helpers/sql-obfuscation/CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/helpers/sql-obfuscation/CHANGELOG.md b/helpers/sql-obfuscation/CHANGELOG.md index eb17355f96..f6365c53a9 100644 --- a/helpers/sql-obfuscation/CHANGELOG.md +++ b/helpers/sql-obfuscation/CHANGELOG.md @@ -2,8 +2,8 @@ ### Deprecation Notice / 2025-10-13 -* **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been replaced by `opentelemetry-helpers-sql-processor`. This version (`1.0.0`) is the final release and serves as a transitional package. No action is needed unless you use this gem directly. -* **ACTION REQUIRED:** Users must update their `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead. +* **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 From 36363358e14ffb542ac8b4ce98731875ebd749e6 Mon Sep 17 00:00:00 2001 From: Hannah Ramadan Date: Wed, 8 Oct 2025 10:28:29 -0700 Subject: [PATCH 7/9] Update readme --- helpers/sql-obfuscation/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/helpers/sql-obfuscation/README.md b/helpers/sql-obfuscation/README.md index 01b513fb98..9e9ff223e4 100644 --- a/helpers/sql-obfuscation/README.md +++ b/helpers/sql-obfuscation/README.md @@ -1,8 +1,8 @@ # Deprecation Notice -**⚠️ This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.** +**This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.** -It has been replace by **`opentelemetry-helpers-sql-processor`**. +It has been replaced by **`opentelemetry-helpers-sql-processor`**. All future development, bug fixes, and feature releases will occur in the new gem. From 1f85e48973c0430c1eb58a29cfc5a302ad8e7378 Mon Sep 17 00:00:00 2001 From: Hannah Ramadan <76922290+hannahramadan@users.noreply.github.com> Date: Wed, 8 Oct 2025 10:30:14 -0700 Subject: [PATCH 8/9] Update helpers/sql-obfuscation/README.md --- helpers/sql-obfuscation/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/helpers/sql-obfuscation/README.md b/helpers/sql-obfuscation/README.md index 01b513fb98..9e9ff223e4 100644 --- a/helpers/sql-obfuscation/README.md +++ b/helpers/sql-obfuscation/README.md @@ -1,8 +1,8 @@ # Deprecation Notice -**⚠️ This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.** +**This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.** -It has been replace by **`opentelemetry-helpers-sql-processor`**. +It has been replaced by **`opentelemetry-helpers-sql-processor`**. All future development, bug fixes, and feature releases will occur in the new gem. From b535b82e605e8414f2ebdd1c63f736e581fe388a Mon Sep 17 00:00:00 2001 From: Hannah Ramadan Date: Wed, 8 Oct 2025 10:37:42 -0700 Subject: [PATCH 9/9] Update gemspec description --- .../opentelemetry-helpers-sql-obfuscation.gemspec | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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'