Skip to content

feat: Add Obfuscation Limit Option to Trilogy #477

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
arielvalentin merged 2 commits into from
May 25, 2023
Merged

feat: Add Obfuscation Limit Option to Trilogy #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28dec0e
feat: Add Obfuscation Limit to Trilogy
arielvalentin May 25, 2023
f222b63
fix: copy-paste error
arielvalentin May 25, 2023
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
1 change: 1 addition & 0 deletions instrumentation/mysql2/test/opentelemetry/instrumentation/mysql2/instrumentation_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@
_(span.attributes['net.peer.name']).must_equal host.to_s
_(span.attributes['net.peer.port']).must_equal port.to_s
end

it 'encodes invalid byte sequences for db.statement' do
# \255 is off-limits https://en.wikipedia.org/wiki/UTF-8#Codepage_layout
sql = "SELECT * from users where users.id = 1 and users.email = '[email protected]\255'"
Expand Down
1 change: 1 addition & 0 deletions 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 @@ -25,6 +25,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

private

Expand Down
5 changes: 3 additions & 2 deletions instrumentation/trilogy/lib/opentelemetry/instrumentation/trilogy/patches/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@ def client_attributes(sql)
end

def obfuscate_sql(sql)
if sql.size > 2000
'SQL query too large to remove sensitive data ...'
if sql.size > config[:obfuscation_limit]
truncated_sql = sql[..sql.index(FULL_SQL_REGEXP) - 1]
truncated_sql + "...\nSQL truncated (> #{config[:obfuscation_limit]} characters)"
else
obfuscated = OpenTelemetry::Common::Utilities.utf8_encode(sql, binary: true)
obfuscated = obfuscated.gsub(FULL_SQL_REGEXP, '?')
Expand Down
14 changes: 14 additions & 0 deletions instrumentation/trilogy/test/opentelemetry/instrumentation/trilogy/instrumentation_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,20 @@
_(span.name).must_equal 'mysql'
_(span.attributes[OpenTelemetry::SemanticConventions::Trace::DB_STATEMENT]).must_equal obfuscated_sql
end

describe 'with obfuscation_limit' do
let(:config) { { db_statement: :obfuscate, obfuscation_limit: 10 } }

it 'truncates SQL using config limit' do
sql = "SELECT * from users where users.id = 1 and users.email = '[email protected]'"
obfuscated_sql = "SELECT * from users where users.id = ...\nSQL truncated (> 10 characters)"
expect do
client.query(sql)
end.must_raise Trilogy::Error

_(span.attributes['db.statement']).must_equal obfuscated_sql
end
end
end

describe 'when db_statement is set to omit' do
Expand Down