Skip to content

Commit b3b7877

Browse files
committed
feat!: deprecate gem
1 parent ba4b009 commit b3b7877

File tree

4 files changed

+20
-1
lines changed

4 files changed

+20
-1
lines changed

helpers/sql-obfuscation/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Release History: opentelemetry-helpers-sql-obfuscation
22

3+
### 💥 Deprecation Notice / 2025-09-23
4+
5+
* **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.
6+
* **ACTION REQUIRED:** Users must update their `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead.
7+
* **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).
8+
39
### v0.3.0 / 2025-01-16
410

511
* BREAKING CHANGE: Set minimum supported version to Ruby 3.1

helpers/sql-obfuscation/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# Deprecation Notice
2+
3+
**⚠️ This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.**
4+
5+
It has been renamed to **`opentelemetry-helpers-sql-processor`**.
6+
7+
All future development, bug fixes, and feature releases will occur in the new gem.
8+
19
# OpenTelemetry Instrumentation Helpers: SQL Obfuscation
210

311
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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,8 @@
55
# SPDX-License-Identifier: Apache-2.0
66

77
require_relative 'opentelemetry/helpers'
8+
9+
OpenTelemetry.logger.warn <<~WARNING
10+
[DEPRECATION] The 'opentelemetry-helpers-sql-obfuscation' is deprecated and has been replaced by 'opentelemetry-helpers-sql-processor'.
11+
Please update your Gemfile to use 'opentelemetry-helpers-sql-processor' instead.
12+
WARNING

helpers/sql-obfuscation/lib/opentelemetry/helpers/sql_obfuscation/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
module OpenTelemetry
88
module Helpers
99
module SqlObfuscation
10-
VERSION = '0.3.0'
10+
VERSION = '1.0.0'
1111
end
1212
end
1313
end

0 commit comments

Comments
 (0)