From d895a6f05569485dd931028746411c244d183797 Mon Sep 17 00:00:00 2001 From: Ariel Valentin Date: Fri, 22 Nov 2024 23:09:42 -0600 Subject: [PATCH 1/3] 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.. --- .github/dependabot.yml | 4 + .github/workflows/ci-contrib.yml | 1 + .toys/.data/releases.yml | 4 + helpers/sql/.rubocop.yml | 1 + helpers/sql/.yardopts | 9 + helpers/sql/CHANGELOG.md | 1 + helpers/sql/Gemfile | 13 ++ helpers/sql/LICENSE | 201 ++++++++++++++++++ helpers/sql/README.md | 35 +++ helpers/sql/Rakefile | 28 +++ helpers/sql/lib/opentelemetry-helpers-sql.rb | 7 + helpers/sql/lib/opentelemetry/helpers.rb | 19 ++ helpers/sql/lib/opentelemetry/helpers/sql.rb | 56 +++++ .../lib/opentelemetry/helpers/sql/version.rb | 13 ++ helpers/sql/opentelemetry-helpers-sql.gemspec | 46 ++++ .../opentelemetry/helpers/sql/sql_test.rb | 100 +++++++++ helpers/sql/test/test_helper.rb | 10 + 17 files changed, 548 insertions(+) create mode 100644 helpers/sql/.rubocop.yml create mode 100644 helpers/sql/.yardopts create mode 100644 helpers/sql/CHANGELOG.md create mode 100644 helpers/sql/Gemfile create mode 100644 helpers/sql/LICENSE create mode 100644 helpers/sql/README.md create mode 100644 helpers/sql/Rakefile create mode 100644 helpers/sql/lib/opentelemetry-helpers-sql.rb create mode 100644 helpers/sql/lib/opentelemetry/helpers.rb create mode 100644 helpers/sql/lib/opentelemetry/helpers/sql.rb create mode 100644 helpers/sql/lib/opentelemetry/helpers/sql/version.rb create mode 100644 helpers/sql/opentelemetry-helpers-sql.gemspec create mode 100644 helpers/sql/test/opentelemetry/helpers/sql/sql_test.rb create mode 100644 helpers/sql/test/test_helper.rb diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5cf3f91db..3bebd5f9c 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,6 +9,10 @@ updates: directory: "/" schedule: interval: weekly +- package-ecosystem: bundler + directory: "/helpers/sql" + schedule: + interval: weekly - package-ecosystem: bundler directory: "/helpers/mysql" schedule: diff --git a/.github/workflows/ci-contrib.yml b/.github/workflows/ci-contrib.yml index 1c8593069..45ec39dbf 100644 --- a/.github/workflows/ci-contrib.yml +++ b/.github/workflows/ci-contrib.yml @@ -21,6 +21,7 @@ jobs: fail-fast: false matrix: gem: + - sql - mysql - sql-obfuscation os: diff --git a/.toys/.data/releases.yml b/.toys/.data/releases.yml index a90d626e3..8bbef5670 100644 --- a/.toys/.data/releases.yml +++ b/.toys/.data/releases.yml @@ -30,6 +30,10 @@ commit_lint: # * changelog_path: Path to CHANGLEOG.md relative to the gem directory. # (Required only if it is not in the expected location.) gems: + - name: opentelemetry-helpers-sql + directory: helpers/sql + version_constant: [OpenTelemetry, helpers, Sql, VERSION] + - name: opentelemetry-instrumentation-gruf directory: instrumentation/gruf version_constant: [OpenTelemetry, Instrumentation, Gruf, VERSION] diff --git a/helpers/sql/.rubocop.yml b/helpers/sql/.rubocop.yml new file mode 100644 index 000000000..1248a2f82 --- /dev/null +++ b/helpers/sql/.rubocop.yml @@ -0,0 +1 @@ +inherit_from: ../../.rubocop.yml diff --git a/helpers/sql/.yardopts b/helpers/sql/.yardopts new file mode 100644 index 000000000..ff382cce4 --- /dev/null +++ b/helpers/sql/.yardopts @@ -0,0 +1,9 @@ +--no-private +--title=OpenTelemetry Sql Instrumentation +--markup=markdown +--main=README.md +./lib/opentelemetry/instrumentation/**/*.rb +./lib/opentelemetry/instrumentation.rb +- +README.md +CHANGELOG.md diff --git a/helpers/sql/CHANGELOG.md b/helpers/sql/CHANGELOG.md new file mode 100644 index 000000000..0d5ab2499 --- /dev/null +++ b/helpers/sql/CHANGELOG.md @@ -0,0 +1 @@ +# Release History: opentelemetry-instrumentation-sql diff --git a/helpers/sql/Gemfile b/helpers/sql/Gemfile new file mode 100644 index 000000000..5f1d771fa --- /dev/null +++ b/helpers/sql/Gemfile @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +source 'https://rubygems.org' + +# DO NOT ADD DEPENDENCIES HERE! +# Please declare a minimum development dependency in the gemspec, +# then target specific versions in the Appraisals file. + +gemspec diff --git a/helpers/sql/LICENSE b/helpers/sql/LICENSE new file mode 100644 index 000000000..1ef7dad2c --- /dev/null +++ b/helpers/sql/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright The OpenTelemetry Authors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/helpers/sql/README.md b/helpers/sql/README.md new file mode 100644 index 000000000..728753376 --- /dev/null +++ b/helpers/sql/README.md @@ -0,0 +1,35 @@ +# OpenTelemetry Sql Helpers + +Todo: Add a description. + +## How do I get started? + +Install the gem using: + +```console +gem install opentelemetry-helpers-sql +``` + +Or, if you use [bundler][bundler-home], include `opentelemetry-helpers-sql` in your `Gemfile`. + +## Usage + +## Examples + +## How can I get involved? + +The `opentelemetry-helpers-sql` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. + +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]. + +## License + +The `opentelemetry-helpers-sql` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. + +[bundler-home]: https://bundler.io +[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby +[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE +[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig +[community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/helpers/sql/Rakefile b/helpers/sql/Rakefile new file mode 100644 index 000000000..1a64ba842 --- /dev/null +++ b/helpers/sql/Rakefile @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'bundler/gem_tasks' +require 'rake/testtask' +require 'yard' +require 'rubocop/rake_task' + +RuboCop::RakeTask.new + +Rake::TestTask.new :test do |t| + t.libs << 'test' + t.libs << 'lib' + t.test_files = FileList['test/**/*_test.rb'] +end + +YARD::Rake::YardocTask.new do |t| + t.stats_options = ['--list-undoc'] +end + +if RUBY_ENGINE == 'truffleruby' + task default: %i[test] +else + task default: %i[test rubocop yard] +end diff --git a/helpers/sql/lib/opentelemetry-helpers-sql.rb b/helpers/sql/lib/opentelemetry-helpers-sql.rb new file mode 100644 index 000000000..a839b7e58 --- /dev/null +++ b/helpers/sql/lib/opentelemetry-helpers-sql.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require_relative 'opentelemetry/helpers' diff --git a/helpers/sql/lib/opentelemetry/helpers.rb b/helpers/sql/lib/opentelemetry/helpers.rb new file mode 100644 index 000000000..290f78bf6 --- /dev/null +++ b/helpers/sql/lib/opentelemetry/helpers.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +# OpenTelemetry is an open source observability framework, providing a +# general-purpose API, SDK, and related tools required for the instrumentation +# of cloud-native software, frameworks, and libraries. +# +# The OpenTelemetry module provides global accessors for telemetry objects. +# See the documentation for the `opentelemetry-api` gem for details. +module OpenTelemetry + # Helpers should be able to handle the case when the library is not installed on a user's system. + module Helpers + end +end + +require_relative 'helpers/sql' diff --git a/helpers/sql/lib/opentelemetry/helpers/sql.rb b/helpers/sql/lib/opentelemetry/helpers/sql.rb new file mode 100644 index 000000000..7c2b5be27 --- /dev/null +++ b/helpers/sql/lib/opentelemetry/helpers/sql.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'opentelemetry' + +module OpenTelemetry + module Helpers + # Contains the OpenTelemetry instrumentation for the Sql gem + module Sql + extend self + + CURRENT_ATTRIBUTES_KEY = Context.create_key('sql-attributes-hash') + + private_constant :CURRENT_ATTRIBUTES_KEY + + # Returns the attributes hash representing the Trilogy context found + # in the optional context or the current context if none is provided. + # + # @param [optional Context] context The context to lookup the current + # attributes hash. Defaults to Context.current + def attributes(context = nil) + context ||= Context.current + context.value(CURRENT_ATTRIBUTES_KEY) || {} + end + + # Returns a context containing the merged attributes hash, derived from the + # optional parent context, or the current context if one was not provided. + # + # @param [optional Context] context The context to use as the parent for + # the returned context + def context_with_attributes(attributes_hash, parent_context: Context.current) + attributes_hash = attributes(parent_context).merge(attributes_hash) + parent_context.set_value(CURRENT_ATTRIBUTES_KEY, attributes_hash) + end + + # Activates/deactivates the merged attributes hash within the current Context, + # which makes the "current attributes hash" available implicitly. + # + # On exit, the attributes hash that was active before calling this method + # will be reactivated. + # + # @param [Span] span the span to activate + # @yield [Hash, Context] yields attributes hash and a context containing the + # attributes hash to the block. + def with_attributes(attributes_hash) + attributes_hash = attributes.merge(attributes_hash) + Context.with_value(CURRENT_ATTRIBUTES_KEY, attributes_hash) { |c, h| yield h, c } + end + end + end +end + +require_relative 'sql/version' diff --git a/helpers/sql/lib/opentelemetry/helpers/sql/version.rb b/helpers/sql/lib/opentelemetry/helpers/sql/version.rb new file mode 100644 index 000000000..b6dd75249 --- /dev/null +++ b/helpers/sql/lib/opentelemetry/helpers/sql/version.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Helpers + module Sql + VERSION = '0.0.0' + end + end +end diff --git a/helpers/sql/opentelemetry-helpers-sql.gemspec b/helpers/sql/opentelemetry-helpers-sql.gemspec new file mode 100644 index 000000000..9cb1f20ef --- /dev/null +++ b/helpers/sql/opentelemetry-helpers-sql.gemspec @@ -0,0 +1,46 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +lib = File.expand_path('lib', __dir__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'opentelemetry/helpers/sql/version' + +Gem::Specification.new do |spec| + spec.name = 'opentelemetry-helpers-sql' + spec.version = OpenTelemetry::Helpers::Sql::VERSION + spec.authors = ['OpenTelemetry Authors'] + spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] + + spec.summary = 'Sql helpers for the OpenTelemetry framework' + spec.description = 'Sql helpers for the OpenTelemetry framework' + spec.homepage = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib' + spec.license = 'Apache-2.0' + + spec.files = Dir.glob('lib/**/*.rb') + + Dir.glob('*.md') + + ['LICENSE', '.yardopts'] + spec.require_paths = ['lib'] + spec.required_ruby_version = '>= 3.0' + + spec.add_dependency 'opentelemetry-api', '~> 1.4.0' + + spec.add_development_dependency 'appraisal', '~> 2.5' + spec.add_development_dependency 'bundler', '~> 2.4' + spec.add_development_dependency 'minitest', '~> 5.0' + spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3' + spec.add_development_dependency 'rake', '~> 13.0' + spec.add_development_dependency 'rubocop', '~> 1.68.0' + spec.add_development_dependency 'rubocop-performance', '~> 1.22.0' + spec.add_development_dependency 'simplecov', '~> 0.17.1' + spec.add_development_dependency 'yard', '~> 0.9' + + if spec.respond_to?(:metadata) + spec.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}/file/CHANGELOG.md" + spec.metadata['source_code_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/helpers/sql' + spec.metadata['bug_tracker_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues' + spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}" + end +end diff --git a/helpers/sql/test/opentelemetry/helpers/sql/sql_test.rb b/helpers/sql/test/opentelemetry/helpers/sql/sql_test.rb new file mode 100644 index 000000000..bf9927950 --- /dev/null +++ b/helpers/sql/test/opentelemetry/helpers/sql/sql_test.rb @@ -0,0 +1,100 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../lib/opentelemetry/helpers/sql' + +describe OpenTelemetry::Helpers::Sql do + describe 'when using implicit contexts' do + it 'manages shared attributes with child contexts' do + actual_attrs = nil + actual_context = nil + + shared_attrs = { 'db.operation' => 'foo' } + + OpenTelemetry::Helpers::Sql.with_attributes(shared_attrs.dup) do |_, child| + actual_attrs = OpenTelemetry::Helpers::Sql.attributes + actual_context = child + end + + _(OpenTelemetry::Helpers::Sql.attributes(actual_context)).must_equal(shared_attrs) + _(actual_attrs).must_equal(shared_attrs) + end + + it 'provides immediate access to shared attributes' do + actual_attrs = nil + shared_attrs = { 'db.operation' => 'foo' } + + OpenTelemetry::Helpers::Sql.with_attributes(shared_attrs.dup) do |attrs, _| + actual_attrs = attrs + end + + _(actual_attrs).must_equal(shared_attrs) + end + + it 'manages shared attributes using an implicit context' do + shared_attrs = { 'db.operation' => 'foo' } + actual_attrs = nil + actual_context = OpenTelemetry::Helpers::Sql.context_with_attributes(shared_attrs.dup) + OpenTelemetry::Context.with_current(actual_context) do + actual_attrs = OpenTelemetry::Helpers::Sql.attributes + end + + _(actual_context).wont_equal(OpenTelemetry::Context.current) + _(actual_attrs).must_equal(shared_attrs) + end + end + + describe 'when using explicit contexts' do + it 'manages shared attributes using a child child contexts' do + actual_attrs = nil + actual_context = nil + + shared_attrs = { 'db.operation' => 'foo' } + + root_context = OpenTelemetry::Context.empty + + OpenTelemetry::Helpers::Sql.with_attributes(shared_attrs.dup) do |_, child| + actual_attrs = OpenTelemetry::Helpers::Sql.attributes(child) + actual_context = child + end + + _(actual_context).wont_equal(root_context) + _(actual_attrs).must_equal(shared_attrs) + end + + it 'manages shared attributes using a provided context' do + shared_attrs = { 'db.operation' => 'foo' } + + root_context = OpenTelemetry::Context.empty + actual_context = OpenTelemetry::Helpers::Sql.context_with_attributes(shared_attrs.dup, parent_context: root_context) + actual_attrs = OpenTelemetry::Helpers::Sql.attributes(actual_context) + + _(actual_context).wont_equal(root_context) + _(actual_attrs).must_equal(shared_attrs) + end + + describe 'given the incorrect context' do + it 'attempts to find shared attributes' do + actual_attrs = nil + actual_context = nil + + shared_attrs = { 'db.operation' => 'foo' } + + root_context = OpenTelemetry::Context.empty + + OpenTelemetry::Helpers::Sql.with_attributes(shared_attrs.dup) do |_, child| + actual_attrs = OpenTelemetry::Helpers::Sql.attributes(root_context) + actual_context = child + end + + _(actual_context).wont_equal(root_context) + _(actual_attrs).must_be_empty + end + end + end +end diff --git a/helpers/sql/test/test_helper.rb b/helpers/sql/test/test_helper.rb new file mode 100644 index 000000000..026a026a2 --- /dev/null +++ b/helpers/sql/test/test_helper.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'bundler/setup' +Bundler.require(:default, :development, :test) + +require 'minitest/autorun' From ca87a681722c7f68d9b1f1086ae7417b8b137a77 Mon Sep 17 00:00:00 2001 From: Ariel Valentin Date: Fri, 22 Nov 2024 23:14:41 -0600 Subject: [PATCH 2/3] squash: mispelling --- helpers/sql/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/helpers/sql/CHANGELOG.md b/helpers/sql/CHANGELOG.md index 0d5ab2499..f81d19ba5 100644 --- a/helpers/sql/CHANGELOG.md +++ b/helpers/sql/CHANGELOG.md @@ -1 +1 @@ -# Release History: opentelemetry-instrumentation-sql +# Release History: opentelemetry-helpers-sql From c4b1c52928685a6b66fbd962f78d892bc312b8fd Mon Sep 17 00:00:00 2001 From: Ariel Valentin Date: Fri, 22 Nov 2024 23:33:48 -0600 Subject: [PATCH 3/3] squash: add some docs --- helpers/sql/README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/helpers/sql/README.md b/helpers/sql/README.md index 728753376..5758b4050 100644 --- a/helpers/sql/README.md +++ b/helpers/sql/README.md @@ -14,7 +14,25 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-helpers-sql` in y ## Usage -## Examples +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. + +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. + +```ruby +# Higher-level instrumentation e.g. ORM +OpenTelemetry::Helpers::Sql.with_attributes({ 'code.namespace' => 'Acme::Customer', 'code.function' => 'truncate!', 'db.operation.name' => 'TRUNCATE', 'db.namespace' => 'customers' }) do + client.query('TRUNCATE customers') +end + +# Client snippet +class OtherSqlClient + def query(sql) + tracer.in_span("query", attributes: OpenTelemetry::Helpers::Sql.attributes.merge('db.statement' => sql, 'db.system' => 'other_sql')) do + connection.query(sql) + end + end +end +``` ## How can I get involved?