opentelemetry-helpers-sql-obfuscation 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +9 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE +201 -0
- data/README.md +62 -0
- data/lib/opentelemetry/helpers/sql_obfuscation/version.rb +13 -0
- data/lib/opentelemetry/helpers/sql_obfuscation.rb +139 -0
- data/lib/opentelemetry/helpers.rb +14 -0
- data/lib/opentelemetry-helpers-sql-obfuscation.rb +7 -0
- metadata +181 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: d1e67b7f9a65054088c342b9721aa6cd9b99de22087b69339bb4af55afec8cf4
|
4
|
+
data.tar.gz: 13d36a4b21073ade430d55e9062f54f3954051631b63e600f33bd3b437cf0221
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c54edccdd3a16cb014b0d7e60e551eb2e6d20f8ca51b026ebe8c3d2cc1f1a4a7a8990e9ab8f935e35262015193b6ed39aea0edb37984d5dbcab4db94e48a6106
|
7
|
+
data.tar.gz: a1e307663993b4daecde6fbaba39348f826700edb83319839a1aaa167cd07ea6993986d1f06c218a9fb24c14a933892e6ca66857e8c415da6f23e944b531c720
|
data/.yardopts
ADDED
data/CHANGELOG.md
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright The OpenTelemetry Authors
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
# OpenTelemetry Instrumentation Helpers: SQL Obfuscation
|
2
|
+
|
3
|
+
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.
|
4
|
+
|
5
|
+
The logic is largely drawn from the [New Relic Ruby agent's SQL Obfuscation Helpers module][new-relic-obfuscation-helpers].
|
6
|
+
|
7
|
+
## Usage
|
8
|
+
|
9
|
+
Add the gem to your instrumentation's gemspec file:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
# opentelemetry-instrumentation-your-gem.gemspec
|
13
|
+
spec.add_dependency 'opentelemetry-helpers-sql-obfuscation'
|
14
|
+
```
|
15
|
+
|
16
|
+
Add the gem to your instrumentation's Gemfile:
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
# Gemfile
|
20
|
+
|
21
|
+
group :test, :development do
|
22
|
+
gem 'opentelemetry-helpers-sql-obfuscation', path: '../../helpers/sql-obfuscation'
|
23
|
+
end
|
24
|
+
```
|
25
|
+
|
26
|
+
Make sure the `Instrumentation` class for your gem contains configuration options for:
|
27
|
+
- `:obfuscation_limit`: the length at which the obfuscated SQL string will be truncated.
|
28
|
+
Example: `option :obfuscation_limit, default: 2000, validate: :integer`
|
29
|
+
|
30
|
+
If you want to add support for a new adapter, update the following constants to include keys for your adapter:
|
31
|
+
|
32
|
+
- `DIALECT_COMPONENTS`
|
33
|
+
- `CLEANUP_REGEX`
|
34
|
+
|
35
|
+
You must also add a new constant that calls the `generate_regex` method with your adapter's DIALECT_COMPONENTS that is named like `<ADAPTER>_COMPONENTS_REGEX`, such as: `MYSQL_COMPONENTS_REGEX`.
|
36
|
+
|
37
|
+
Check [New Relic's SQL Obfuscation Helpers module][new-relic-obfuscation-helpers] to see if regular expressions for your adapter already exist.
|
38
|
+
|
39
|
+
## Examples
|
40
|
+
|
41
|
+
To obfuscate sql in your library:
|
42
|
+
|
43
|
+
```ruby
|
44
|
+
OpenTelemetry::Helpers::SqlObfuscation.obfuscate_sql(sql, obfuscation_limit: config[:obfuscation_limit], adapter: :postgres)
|
45
|
+
```
|
46
|
+
|
47
|
+
## How can I get involved?
|
48
|
+
|
49
|
+
The `opentelemetry-helpers-sql-obfuscation` gem source is [on github][repo-github], along with related gems including `opentelemetry-instrumentation-pg` and `opentelemetry-instrumentation-trilogy`.
|
50
|
+
|
51
|
+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
|
52
|
+
|
53
|
+
## License
|
54
|
+
|
55
|
+
The `opentelemetry-helpers-sql-obfuscation` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
|
56
|
+
|
57
|
+
[new-relic-obfuscation-helpers]: https://github.com/newrelic/newrelic-ruby-agent/blob/96e7aca22c1c873c0f5fe704a2b3bb19652db68e/lib/new_relic/agent/database/obfuscation_helpers.rb
|
58
|
+
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
|
59
|
+
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
|
60
|
+
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
|
61
|
+
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
|
62
|
+
[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
|
@@ -0,0 +1,139 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0module OpenTelemetry
|
6
|
+
|
7
|
+
require 'opentelemetry-common'
|
8
|
+
|
9
|
+
module OpenTelemetry
|
10
|
+
module Helpers
|
11
|
+
#
|
12
|
+
# This module contains SQL obfuscation behavior to share with
|
13
|
+
# instrumentation for specific database adapters.
|
14
|
+
# The class uses code from: https://github.com/newrelic/newrelic-ruby-agent/blob/1fca78cc7a087421ad58088d8bea72c0362bc62f/lib/new_relic/agent/database/obfuscation_helpers.rb
|
15
|
+
#
|
16
|
+
# To use this in your instrumentation, the `Instrumentation` class for
|
17
|
+
# your gem must contain configuration options for:
|
18
|
+
# * `:db_statement`
|
19
|
+
# Example:
|
20
|
+
# `option :db_statement, default: :include, validate: %I[omit include obfuscate]`
|
21
|
+
# * `:obfuscation_limit`
|
22
|
+
# Example:
|
23
|
+
# `option :obfuscation_limit, default: 2000, validate: :integer`
|
24
|
+
#
|
25
|
+
# If you want to add support for a new adapter, update the following
|
26
|
+
# constants to include keys for your adapter:
|
27
|
+
# * DIALECT_COMPONENTS
|
28
|
+
# * CLEANUP_REGEX
|
29
|
+
# You must also add a new constant that uses `generate_regex` with your
|
30
|
+
# adapter's dialect components that is named like
|
31
|
+
# `<ADAPTER>_COMPONENTS_REGEX`, such as: `MYSQL_COMPONENTS_REGEX`.
|
32
|
+
#
|
33
|
+
# @api public
|
34
|
+
module SqlObfuscation
|
35
|
+
module_function
|
36
|
+
|
37
|
+
# From: https://github.com/newrelic/newrelic-ruby-agent/blob/1fca78cc7a087421ad58088d8bea72c0362bc62f/lib/new_relic/agent/database/obfuscation_helpers.rb
|
38
|
+
COMPONENTS_REGEX_MAP = {
|
39
|
+
single_quotes: /'(?:[^']|'')*?(?:\\'.*|'(?!'))/,
|
40
|
+
double_quotes: /"(?:[^"]|"")*?(?:\\".*|"(?!"))/,
|
41
|
+
dollar_quotes: /(\$(?!\d)[^$]*?\$).*?(?:\1|$)/,
|
42
|
+
uuids: /\{?(?:[0-9a-fA-F]\-*){32}\}?/,
|
43
|
+
numeric_literals: /-?\b(?:[0-9]+\.)?[0-9]+([eE][+-]?[0-9]+)?\b/,
|
44
|
+
boolean_literals: /\b(?:true|false|null)\b/i,
|
45
|
+
hexadecimal_literals: /0x[0-9a-fA-F]+/,
|
46
|
+
comments: /(?:#|--).*?(?=\r|\n|$)/i,
|
47
|
+
multi_line_comments: %r{(?:\/\*.*?\*\/)}m,
|
48
|
+
oracle_quoted_strings: /q'\[.*?(?:\]'|$)|q'\{.*?(?:\}'|$)|q'\<.*?(?:\>'|$)|q'\(.*?(?:\)'|$)/
|
49
|
+
}.freeze
|
50
|
+
|
51
|
+
DIALECT_COMPONENTS = {
|
52
|
+
default: COMPONENTS_REGEX_MAP.keys,
|
53
|
+
mysql: %i[single_quotes double_quotes numeric_literals boolean_literals
|
54
|
+
hexadecimal_literals comments multi_line_comments],
|
55
|
+
postgres: %i[single_quotes dollar_quotes uuids numeric_literals
|
56
|
+
boolean_literals comments multi_line_comments],
|
57
|
+
sqlite: %i[single_quotes numeric_literals boolean_literals hexadecimal_literals
|
58
|
+
comments multi_line_comments],
|
59
|
+
oracle: %i[single_quotes oracle_quoted_strings numeric_literals comments
|
60
|
+
multi_line_comments],
|
61
|
+
cassandra: %i[single_quotes uuids numeric_literals boolean_literals
|
62
|
+
hexadecimal_literals comments multi_line_comments]
|
63
|
+
}.freeze
|
64
|
+
|
65
|
+
PLACEHOLDER = '?'
|
66
|
+
|
67
|
+
# We use these to check whether the query contains any quote characters
|
68
|
+
# after obfuscation. If so, that's a good indication that the original
|
69
|
+
# query was malformed, and so our obfuscation can't reliably find
|
70
|
+
# literals. In such a case, we'll replace the entire query with a
|
71
|
+
# placeholder.
|
72
|
+
CLEANUP_REGEX = {
|
73
|
+
default: %r{'|"|\/\*|\*\/},
|
74
|
+
mysql: %r{'|"|\/\*|\*\//},
|
75
|
+
postgres: %r{'|\/\*|\*\/|\$(?!\?)/},
|
76
|
+
sqlite: %r{'|\/\*|\*\//},
|
77
|
+
cassandra: %r{'|\/\*|\*\//},
|
78
|
+
oracle: %r{'|\/\*|\*\//}
|
79
|
+
}.freeze
|
80
|
+
|
81
|
+
# @api private
|
82
|
+
def generate_regex(dialect)
|
83
|
+
components = DIALECT_COMPONENTS[dialect]
|
84
|
+
Regexp.union(components.map { |component| COMPONENTS_REGEX_MAP[component] })
|
85
|
+
end
|
86
|
+
|
87
|
+
DEFAULT_COMPONENTS_REGEX = generate_regex(:default)
|
88
|
+
MYSQL_COMPONENTS_REGEX = generate_regex(:mysql)
|
89
|
+
POSTGRES_COMPONENTS_REGEX = generate_regex(:postgres)
|
90
|
+
SQLITE_COMPONENTS_REGEX = generate_regex(:sqlite)
|
91
|
+
CASSANDRA_COMPONENTS_REGEX = generate_regex(:cassandra)
|
92
|
+
ORACLE_COMPONENTS_REGEX = generate_regex(:oracle)
|
93
|
+
|
94
|
+
# This is a SQL obfuscation utility intended for use in database adapter instrumentation.
|
95
|
+
#
|
96
|
+
# @param sql [String] The SQL to obfuscate.
|
97
|
+
# @param obfuscation_limit [optional Integer] The maximum length of an obfuscated sql statement.
|
98
|
+
# @param adapter [optional Symbol] the type of database adapter calling the method. `:default`, `:mysql` and `:postgres` are supported.
|
99
|
+
# @return [String] The SQL query string where the values are replaced with "?". When the sql statement exceeds the obufscation limit
|
100
|
+
# the first matched pair from the SQL statement will be returned, with an appended truncation message. If trunaction is unsuccessful,
|
101
|
+
# a string describing the error will be returned.
|
102
|
+
#
|
103
|
+
# @api public
|
104
|
+
def obfuscate_sql(sql, obfuscation_limit: 2000, adapter: :default)
|
105
|
+
regex = case adapter
|
106
|
+
when :mysql
|
107
|
+
MYSQL_COMPONENTS_REGEX
|
108
|
+
when :postgres
|
109
|
+
POSTGRES_COMPONENTS_REGEX
|
110
|
+
else
|
111
|
+
DEFAULT_COMPONENTS_REGEX
|
112
|
+
end
|
113
|
+
|
114
|
+
# Original MySQL UTF-8 Encoding Fixes:
|
115
|
+
# https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/160
|
116
|
+
# https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/345
|
117
|
+
sql = OpenTelemetry::Common::Utilities.utf8_encode(sql, binary: true)
|
118
|
+
return truncate_statement(sql, regex, obfuscation_limit) if sql.size > obfuscation_limit
|
119
|
+
|
120
|
+
sql = sql.gsub(regex, PLACEHOLDER)
|
121
|
+
return 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if CLEANUP_REGEX[adapter].match(sql)
|
122
|
+
|
123
|
+
sql
|
124
|
+
rescue StandardError => e
|
125
|
+
OpenTelemetry.handle_error(message: 'Failed to obfuscate SQL', exception: e)
|
126
|
+
end
|
127
|
+
|
128
|
+
# @api private
|
129
|
+
def truncate_statement(sql, regex, limit)
|
130
|
+
first_match_index = sql.index(regex)
|
131
|
+
truncation_message = "SQL truncated (> #{limit} characters)"
|
132
|
+
return truncation_message unless first_match_index
|
133
|
+
|
134
|
+
truncated_sql = sql[..first_match_index - 1]
|
135
|
+
"#{truncated_sql}...\n#{truncation_message}"
|
136
|
+
end
|
137
|
+
end
|
138
|
+
end
|
139
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
require 'opentelemetry/helpers/sql_obfuscation'
|
8
|
+
|
9
|
+
module OpenTelemetry
|
10
|
+
# The helpers module contains functionality shared across multiple
|
11
|
+
# instrumentation libraries
|
12
|
+
module Helpers
|
13
|
+
end
|
14
|
+
end
|
metadata
ADDED
@@ -0,0 +1,181 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: opentelemetry-helpers-sql-obfuscation
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- OpenTelemetry Authors
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2024-02-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: opentelemetry-common
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.20'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.20'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.4'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.4'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: minitest
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '5.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '5.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: opentelemetry-test-helpers
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.3'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0.3'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '13.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '13.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rubocop
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: 1.57.2
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: 1.57.2
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rubocop-performance
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: 1.19.1
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: 1.19.1
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: yard
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0.9'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0.9'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: yard-doctest
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 0.1.6
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: 0.1.6
|
139
|
+
description: SQL Obfuscation Instrumentation Helpers for the OpenTelemetry framework
|
140
|
+
email:
|
141
|
+
- cncf-opentelemetry-contributors@lists.cncf.io
|
142
|
+
executables: []
|
143
|
+
extensions: []
|
144
|
+
extra_rdoc_files: []
|
145
|
+
files:
|
146
|
+
- ".yardopts"
|
147
|
+
- CHANGELOG.md
|
148
|
+
- LICENSE
|
149
|
+
- README.md
|
150
|
+
- lib/opentelemetry-helpers-sql-obfuscation.rb
|
151
|
+
- lib/opentelemetry/helpers.rb
|
152
|
+
- lib/opentelemetry/helpers/sql_obfuscation.rb
|
153
|
+
- lib/opentelemetry/helpers/sql_obfuscation/version.rb
|
154
|
+
homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
|
155
|
+
licenses:
|
156
|
+
- Apache-2.0
|
157
|
+
metadata:
|
158
|
+
changelog_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.1.0/file/CHANGELOG.md
|
159
|
+
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/helpers/sql-obfuscation
|
160
|
+
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
|
161
|
+
documentation_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.1.0
|
162
|
+
post_install_message:
|
163
|
+
rdoc_options: []
|
164
|
+
require_paths:
|
165
|
+
- lib
|
166
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
167
|
+
requirements:
|
168
|
+
- - ">="
|
169
|
+
- !ruby/object:Gem::Version
|
170
|
+
version: '3.0'
|
171
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
172
|
+
requirements:
|
173
|
+
- - ">="
|
174
|
+
- !ruby/object:Gem::Version
|
175
|
+
version: '0'
|
176
|
+
requirements: []
|
177
|
+
rubygems_version: 3.2.33
|
178
|
+
signing_key:
|
179
|
+
specification_version: 4
|
180
|
+
summary: SQL Obfuscation Instrumentation Helpers for the OpenTelemetry framework
|
181
|
+
test_files: []
|