Skip to content
6 changes: 6 additions & 0 deletions helpers/sql-obfuscation/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 8 additions & 0 deletions helpers/sql-obfuscation/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# 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

Check failure on line 9 in helpers/sql-obfuscation/README.md

View workflow job for this annotation

GitHub Actions / markdownlint-check

Multiple top-level headings in the same document

helpers/sql-obfuscation/README.md:9 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "OpenTelemetry Instrumentation ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md

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
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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
module OpenTelemetry
module Helpers
module SqlObfuscation
VERSION = '0.3.0'
VERSION = '1.0.0'
end
end
end
Loading