Skip to content

feat!: deprecate sql-obfuscation gem #1674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Oct 8, 2025
Merged

feat!: deprecate sql-obfuscation gem #1674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b3b7877
feat!: deprecate gem
hannahramadan Sep 15, 2025
4ce1615
Update message
hannahramadan Sep 16, 2025
d1c9916
Only one heading for README
hannahramadan Sep 16, 2025
473826d
Merge branch 'main' into deprecate_sql_obfuscation
hannahramadan Sep 16, 2025
fd02b84
Feedback updates
hannahramadan Oct 6, 2025
8f65753
Revert version
hannahramadan Oct 6, 2025
5bf7ddd
Update helpers/sql-obfuscation/CHANGELOG.md
hannahramadan Oct 7, 2025
3636335
Update readme
hannahramadan Oct 8, 2025
1f85e48
Update helpers/sql-obfuscation/README.md
hannahramadan Oct 8, 2025
a9c4fee
Merge branch 'deprecate_sql_obfuscation' of https://github.com/hannah…
hannahramadan Oct 8, 2025
b535b82
Update gemspec description
hannahramadan Oct 8, 2025
1a35e57
Merge branch 'main' into deprecate_sql_obfuscation
kaylareopelle Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions helpers/sql-obfuscation/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
10 changes: 9 additions & 1 deletion helpers/sql-obfuscation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 4 additions & 0 deletions helpers/sql-obfuscation/lib/opentelemetry-helpers-sql-obfuscation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down
Loading