opentelemetry-instrumentation-mysql2 0.18.1 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +2 -2
  4. data/lib/opentelemetry/instrumentation/mysql2/instrumentation.rb +10 -1
  5. data/lib/opentelemetry/instrumentation/mysql2/patches/client.rb +8 -5
  6. data/lib/opentelemetry/instrumentation/mysql2/version.rb +1 -1
  7. metadata +36 -8
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2f530562f160f11a117621eb56ea9d984052e437c3f16b12c50a96f765b5538a
4
- data.tar.gz: 48e436cc15d6c39b44729db0ead43eb659224cda5308f5e23fc4b98e345247f7
3
+ metadata.gz: c4c336dee4ea731b92e4546a72fc047e1daaccbfdc45b2771844a71b937283b6
4
+ data.tar.gz: ce856296ab136a054567fdd5c180af35ea1538f71eeac10255e47adc6f8e9046
5
5
  SHA512:
6
- metadata.gz: ddddcb7135cb84b62ee91741aaa5c2653cdc11f8b542b7a13029befcb43aa47d282ee5c2654c3e62f3a6a6e5cde48940928fe53f6329362ea0b340fd5ff3ea98
7
- data.tar.gz: 4f46285dbc8786989f5b7d0e0d3ccbdf9c33cf08014235ea79d1d183d81eb49fac46b1956e73d51e098517238a4dd10125d0e13ba2264d514a71663095e4351e
6
+ metadata.gz: 6a0c027bb105697ba6c564a32ca3fa1db695ad374302e98b89d59d030fdc2ba63a8c2beb794033687c0a88f9ac00e65b6b6dcd152bbac379ddcdb07b2b7e5f79
7
+ data.tar.gz: 8b31ee410ba0364068f3dde580728618cd9db21c09daaae7827d9a023b01ce1ad079c603e976d100c4c2ba0b4e2f93ac1952fe3d4c439a8fa607980eba586ba9
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release History: opentelemetry-instrumentation-mysql2
2
2
 
3
+ ### v0.19.0 / 2021-08-12
4
+
5
+ * BREAKING CHANGE: Add option for db.statement
6
+
7
+ * ADDED: Add option for db.statement
8
+ * DOCS: Update docs to rely more on environment variable configuration
9
+ * DOCS: Move to using new db_statement
10
+
3
11
  ### v0.18.1 / 2021-06-23
4
12
 
5
13
  * (No significant changes)
data/README.md CHANGED
@@ -36,8 +36,8 @@ end
36
36
  OpenTelemetry::SDK.configure do |c|
37
37
  c.use 'OpenTelemetry::Instrumentation::Mysql2', {
38
38
  # The obfuscation of SQL in the db.statement attribute is disabled by default.
39
- # To enable, set enable_sql_obfuscation to true.
40
- enable_sql_obfuscation: false,
39
+ # To enable, set db_statement to :obfuscate.
40
+ db_statement: :obfuscate,
41
41
  }
42
42
  end
43
43
  ```
data/lib/opentelemetry/instrumentation/mysql2/instrumentation.rb CHANGED
@@ -10,7 +10,15 @@ module OpenTelemetry
10
10
  # The Instrumentation class contains logic to detect and install the Mysql2
11
11
  # instrumentation
12
12
  class Instrumentation < OpenTelemetry::Instrumentation::Base
13
- install do |_config|
13
+ install do |config|
14
+ if config[:enable_sql_obfuscation]
15
+ config[:db_statement] = :obfuscate
16
+ OpenTelemetry.logger.warn(
17
+ 'Instrumentation mysql2 configuration option enable_sql_obfuscation has been deprecated,' \
18
+ 'use db_statement option instead'
19
+ )
20
+ end
21
+
14
22
  require_dependencies
15
23
  patch_client
16
24
  end
@@ -21,6 +29,7 @@ module OpenTelemetry
21
29
 
22
30
  option :peer_service, default: nil, validate: :string
23
31
  option :enable_sql_obfuscation, default: false, validate: :boolean
32
+ option :db_statement, default: :include, validate: ->(opt) { %I[omit include obfuscate].include?(opt) }
24
33
 
25
34
  private
26
35
 
data/lib/opentelemetry/instrumentation/mysql2/patches/client.rb CHANGED
@@ -51,11 +51,16 @@ module OpenTelemetry
51
51
  ].freeze
52
52
 
53
53
  def query(sql, options = {})
54
+ attributes = client_attributes
55
+ case config[:db_statement]
56
+ when :include
57
+ attributes['db.statement'] = sql
58
+ when :obfuscate
59
+ attributes['db.statement'] = obfuscate_sql(sql)
60
+ end
54
61
  tracer.in_span(
55
62
  database_span_name(sql),
56
- attributes: client_attributes.merge(
57
- 'db.statement' => obfuscate_sql(sql)
58
- ),
63
+ attributes: attributes,
59
64
  kind: :client
60
65
  ) do
61
66
  super(sql, options)
@@ -65,8 +70,6 @@ module OpenTelemetry
65
70
  private
66
71
 
67
72
  def obfuscate_sql(sql)
68
- return sql unless config[:enable_sql_obfuscation]
69
-
70
73
  if sql.size > 2000
71
74
  'SQL query too large to remove sensitive data ...'
72
75
  else
data/lib/opentelemetry/instrumentation/mysql2/version.rb CHANGED
@@ -7,7 +7,7 @@
7
7
  module OpenTelemetry
8
8
  module Instrumentation
9
9
  module Mysql2
10
- VERSION = '0.18.1'
10
+ VERSION = '0.19.0'
11
11
  end
12
12
  end
13
13
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: opentelemetry-instrumentation-mysql2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.18.1
4
+ version: 0.19.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenTelemetry Authors
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-06-24 00:00:00.000000000 Z
11
+ date: 2021-08-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: 1.0.0.rc2
19
+ version: 1.0.0.rc3
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: 1.0.0.rc2
26
+ version: 1.0.0.rc3
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: opentelemetry-instrumentation-base
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 0.18.1
33
+ version: 0.18.2
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 0.18.1
40
+ version: 0.18.2
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: appraisal
43
43
  requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
108
108
  - - "~>"
109
109
  - !ruby/object:Gem::Version
110
110
  version: 1.0.0.rc1
111
+ - !ruby/object:Gem::Dependency
112
+ name: pry
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: pry-byebug
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
111
139
  - !ruby/object:Gem::Dependency
112
140
  name: rubocop
113
141
  requirement: !ruby/object:Gem::Requirement
@@ -185,10 +213,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
185
213
  licenses:
186
214
  - Apache-2.0
187
215
  metadata:
188
- changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.18.1/file.CHANGELOG.html
216
+ changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.19.0/file.CHANGELOG.html
189
217
  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/mysql2
190
218
  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
191
- documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.18.1
219
+ documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-mysql2/v0.19.0
192
220
  post_install_message:
193
221
  rdoc_options: []
194
222
  require_paths: