Skip to content

fix!: Return message when sql is over the obfuscation limit #1149

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
kaylareopelle merged 8 commits into from
Sep 10, 2024
Merged

fix!: Return message when sql is over the obfuscation limit #1149

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9a4fe90
fix: Remove prepended SQL comments when truncating
kaylareopelle Sep 4, 2024
74ffb88
fix: Return message when obfuscation limit hit
kaylareopelle Sep 6, 2024
3217b90
feat!: Update obfusaction limit
kaylareopelle Sep 6, 2024
15a3d10
fix: Revert obfuscation limit change
kaylareopelle Sep 6, 2024
6a13777
fix: Guard clause for truncation
kaylareopelle Sep 6, 2024
e649508
chore: Update tests and docs for sql limit message
kaylareopelle Sep 6, 2024
98bf708
style: Rubocop Style/StringLiterals
kaylareopelle Sep 6, 2024
8e3d278
Merge branch 'main' into sql-obfuscation-comments
kaylareopelle Sep 10, 2024
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
Prev Previous commit
Next Next commit
feat!: Update obfusaction limit 
This obfuscation limit matches what New Relic uses for their Ruby agent.
The previous 2000 limit seemed arbitrary.
  • Loading branch information
@kaylareopelle
kaylareopelle committed Sep 6, 2024
commit 3217b9046698dc92377d5354a62a5db6fbd056b4
2 changes: 1 addition & 1 deletion helpers/sql-obfuscation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ end
Make sure the `Instrumentation` class for your gem contains configuration options for:

- `:obfuscation_limit`: the length at which the obfuscated SQL string will be truncated.
Example: `option :obfuscation_limit, default: 2000, validate: :integer`
Example: `option :obfuscation_limit, default: 16384, validate: :integer`

If you want to add support for a new adapter, update the following constants to include keys for your adapter:

Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -20,7 +20,7 @@ module Helpers
# `option :db_statement, default: :include, validate: %I[omit include obfuscate]`
# * `:obfuscation_limit`
# Example:
# `option :obfuscation_limit, default: 2000, validate: :integer`
# `option :obfuscation_limit, default: 16384, validate: :integer`
#
# If you want to add support for a new adapter, update the following
# constants to include keys for your adapter:
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/mysql2/lib/opentelemetry/instrumentation/mysql2/instrumentation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
option :peer_service, default: nil, validate: :string
option :db_statement, default: :obfuscate, validate: %I[omit include obfuscate]
option :span_name, default: :statement_type, validate: %I[statement_type db_name db_operation_and_name]
option :obfuscation_limit, default: 2000, validate: :integer
option :obfuscation_limit, default: 16384, validate: :integer

private

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/pg/lib/opentelemetry/instrumentation/pg/instrumentation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base

option :peer_service, default: nil, validate: :string
option :db_statement, default: :obfuscate, validate: %I[omit include obfuscate]
option :obfuscation_limit, default: 2000, validate: :integer
option :obfuscation_limit, default: 16384, validate: :integer

private

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/trilogy/lib/opentelemetry/instrumentation/trilogy/instrumentation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
option :peer_service, default: nil, validate: :string
option :db_statement, default: :obfuscate, validate: %I[omit include obfuscate]
option :span_name, default: :statement_type, validate: %I[statement_type db_name db_operation_and_name]
option :obfuscation_limit, default: 2000, validate: :integer
option :obfuscation_limit, default: 16384, validate: :integer
option :propagator, default: nil, validate: :string

attr_reader :propagator
Expand Down