Skip to content

Commit fee95c6

Browse files
arielvalentinkaylareopelle
arielvalentin
and
kaylareopelle
authored
feat: Initial Release SQL Helpers (#1263)
* feat: Initial Release Sql Helpers provides support for other gems. This PR is focing on sharing database related attributes from a parent to a child context.. * squash: mispelling * squash: add some docs * squash: Apply suggestions from code review Co-authored-by: Kayla Reopelle <[email protected]> * squash: update readme with feedback from Kayla --------- Co-authored-by: Kayla Reopelle <[email protected]>
1 parent 93895a1 commit fee95c6

17 files changed

+573
-0
lines changed

‎.github/dependabot.yml

+4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ updates:
99
directory: "/"
1010
schedule:
1111
interval: weekly
12+
- package-ecosystem: bundler
13+
directory: "/helpers/sql"
14+
schedule:
15+
interval: weekly
1216
- package-ecosystem: bundler
1317
directory: "/helpers/mysql"
1418
schedule:

‎.github/workflows/ci-contrib.yml

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ jobs:
2121
fail-fast: false
2222
matrix:
2323
gem:
24+
- sql
2425
- mysql
2526
- sql-obfuscation
2627
os:

‎.toys/.data/releases.yml

+4
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ commit_lint:
3030
# * changelog_path: Path to CHANGLEOG.md relative to the gem directory.
3131
# (Required only if it is not in the expected location.)
3232
gems:
33+
- name: opentelemetry-helpers-sql
34+
directory: helpers/sql
35+
version_constant: [OpenTelemetry, Helpers, Sql, VERSION]
36+
3337
- name: opentelemetry-instrumentation-gruf
3438
directory: instrumentation/gruf
3539
version_constant: [OpenTelemetry, Instrumentation, Gruf, VERSION]

‎helpers/sql/.rubocop.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
inherit_from: ../../.rubocop.yml

‎helpers/sql/.yardopts

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
--no-private
2+
--title=OpenTelemetry Sql Helpers
3+
--markup=markdown
4+
--main=README.md
5+
./lib/opentelemetry/helpers/**/*.rb
6+
./lib/opentelemetry/helpers.rb
7+
-
8+
README.md
9+
CHANGELOG.md

‎helpers/sql/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Release History: opentelemetry-helpers-sql

‎helpers/sql/Gemfile

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# frozen_string_literal: true
2+
3+
# Copyright The OpenTelemetry Authors
4+
#
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
source 'https://rubygems.org'
8+
9+
# DO NOT ADD DEPENDENCIES HERE!
10+
# Please declare a minimum development dependency in the gemspec,
11+
# then target specific versions in the Appraisals file.
12+
13+
gemspec

‎helpers/sql/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -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.

‎helpers/sql/README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# OpenTelemetry Sql Helpers
2+
3+
This gem is intended to be used by the instrumentation libraries to provide a common set of helpers for SQL-related spans. It is not intended to be used directly by applications.
4+
5+
## Installation
6+
7+
Add a line similar to this in your `gemspec`:
8+
9+
```ruby
10+
11+
spec.add_dependency 'opentelemetry-helpers-sql', '~> 0.3' # Use the approprite version
12+
13+
```
14+
15+
Update your `Gemfile` to use the latest version of the gem in the contrib, e.g.
16+
17+
```ruby
18+
19+
group :test do
20+
gem 'opentelemetry-helpers-sql', path: '../../helpers/sql' # Use the approprite path
21+
end
22+
23+
```
24+
25+
## Usage
26+
27+
Some database libraries do not have enough context to add sufficient details to client spans. In these cases, you can use the `OpenTelemetry::Helpers::Sql.with_attributes` to create a set of shared attributes to amend to a database span.
28+
29+
```ruby
30+
# Higher-level instrumentation e.g. ORM
31+
OpenTelemetry::Helpers::Sql.with_attributes({ 'code.namespace' => 'Acme::Customer', 'code.function' => 'truncate!', 'db.operation.name' => 'TRUNCATE', 'db.namespace' => 'customers' }) do
32+
client.query('TRUNCATE customers')
33+
end
34+
35+
# Client snippet
36+
class OtherSqlClient
37+
def query(sql)
38+
tracer.in_span("query", attributes: OpenTelemetry::Helpers::Sql.attributes.merge('db.statement' => sql, 'db.system' => 'other_sql')) do
39+
connection.query(sql)
40+
end
41+
end
42+
end
43+
```
44+
45+
## How can I get involved?
46+
47+
The `opentelemetry-helpers-sql` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
48+
49+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] 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].
50+
51+
## License
52+
53+
The `opentelemetry-helpers-sql` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
54+
55+
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
56+
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
57+
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
58+
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
59+
[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
60+
[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

‎helpers/sql/Rakefile

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# frozen_string_literal: true
2+
3+
# Copyright The OpenTelemetry Authors
4+
#
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
require 'bundler/gem_tasks'
8+
require 'rake/testtask'
9+
require 'yard'
10+
require 'rubocop/rake_task'
11+
12+
RuboCop::RakeTask.new
13+
14+
Rake::TestTask.new :test do |t|
15+
t.libs << 'test'
16+
t.libs << 'lib'
17+
t.test_files = FileList['test/**/*_test.rb']
18+
end
19+
20+
YARD::Rake::YardocTask.new do |t|
21+
t.stats_options = ['--list-undoc']
22+
end
23+
24+
if RUBY_ENGINE == 'truffleruby'
25+
task default: %i[test]
26+
else
27+
task default: %i[test rubocop yard]
28+
end

‎helpers/sql/lib/opentelemetry-helpers-sql.rb

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# frozen_string_literal: true
2+
3+
# Copyright The OpenTelemetry Authors
4+
#
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
require_relative 'opentelemetry/helpers'

‎helpers/sql/lib/opentelemetry/helpers.rb

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# frozen_string_literal: true
2+
3+
# Copyright The OpenTelemetry Authors
4+
#
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
# OpenTelemetry is an open source observability framework, providing a
8+
# general-purpose API, SDK, and related tools required for the instrumentation
9+
# of cloud-native software, frameworks, and libraries.
10+
#
11+
# The OpenTelemetry module provides global accessors for telemetry objects.
12+
# See the documentation for the `opentelemetry-api` gem for details.
13+
module OpenTelemetry
14+
# Helpers should be able to handle the case when the library is not installed on a user's system.
15+
module Helpers
16+
end
17+
end
18+
19+
require_relative 'helpers/sql'

0 commit comments

Comments
 (0)