diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5485d59f1..64346bd86 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -33,6 +33,10 @@ updates: directory: "/instrumentation/sinatra" schedule: interval: weekly +- package-ecosystem: bundler + directory: "/instrumentation/shoryuken" + schedule: + interval: weekly - package-ecosystem: bundler directory: "/instrumentation/sidekiq" schedule: diff --git a/.github/workflows/ci-instrumentation-canary.yml b/.github/workflows/ci-instrumentation-canary.yml index ae32dd9bb..5fe3604c5 100644 --- a/.github/workflows/ci-instrumentation-canary.yml +++ b/.github/workflows/ci-instrumentation-canary.yml @@ -38,6 +38,7 @@ jobs: - rails - restclient - rspec + - shoryuken - sinatra os: - ubuntu-latest @@ -100,6 +101,7 @@ jobs: [[ "${{ matrix.gem }}" == "lmdb" ]] && echo "skip=true" >> $GITHUB_OUTPUT [[ "${{ matrix.gem }}" == "rack" ]] && echo "skip=true" >> $GITHUB_OUTPUT [[ "${{ matrix.gem }}" == "rails" ]] && echo "skip=true" >> $GITHUB_OUTPUT + [[ "${{ matrix.gem }}" == "shoryuken" ]] && echo "skip=true" >> $GITHUB_OUTPUT # This is essentially a bash script getting evaluated, so we need to return true or the whole job fails. true - name: "Test JRuby" diff --git a/.github/workflows/ci-instrumentation.yml b/.github/workflows/ci-instrumentation.yml index d06fe5d5b..c63d7d979 100644 --- a/.github/workflows/ci-instrumentation.yml +++ b/.github/workflows/ci-instrumentation.yml @@ -42,6 +42,7 @@ jobs: - rails - restclient - rspec + - shoryuken - sinatra os: - ubuntu-latest @@ -88,6 +89,7 @@ jobs: [[ "${{ matrix.gem }}" == "lmdb" ]] && echo "skip=true" >> $GITHUB_OUTPUT [[ "${{ matrix.gem }}" == "rack" ]] && echo "skip=true" >> $GITHUB_OUTPUT [[ "${{ matrix.gem }}" == "rails" ]] && echo "skip=true" >> $GITHUB_OUTPUT + [[ "${{ matrix.gem }}" == "shoryuken" ]] && echo "skip=true" >> $GITHUB_OUTPUT [[ "${{ matrix.gem }}" == "gruf" ]] && echo "skip=true" >> $GITHUB_OUTPUT # This is essentially a bash script getting evaluated, so we need to return true or the whole job fails. true diff --git a/instrumentation/shoryuken/.rubocop.yml b/instrumentation/shoryuken/.rubocop.yml new file mode 100644 index 000000000..525cb33e6 --- /dev/null +++ b/instrumentation/shoryuken/.rubocop.yml @@ -0,0 +1,6 @@ +inherit_from: ../../.rubocop.yml + +Style/FetchEnvVar: + Enabled: true + Exclude: + - test/test_helper.rb diff --git a/instrumentation/shoryuken/.yardopts b/instrumentation/shoryuken/.yardopts new file mode 100644 index 000000000..28a609e89 --- /dev/null +++ b/instrumentation/shoryuken/.yardopts @@ -0,0 +1,9 @@ +--no-private +--title=OpenTelemetry Shoryuken Instrumentation +--markup=markdown +--main=README.md +./lib/opentelemetry/instrumentation/**/*.rb +./lib/opentelemetry/instrumentation.rb +- +README.md +CHANGELOG.md diff --git a/instrumentation/shoryuken/CHANGELOG.md b/instrumentation/shoryuken/CHANGELOG.md new file mode 100644 index 000000000..1b590659a --- /dev/null +++ b/instrumentation/shoryuken/CHANGELOG.md @@ -0,0 +1 @@ +# Release History: opentelemetry-instrumentation-shoryuken diff --git a/instrumentation/shoryuken/Gemfile b/instrumentation/shoryuken/Gemfile new file mode 100644 index 000000000..5b7d54b64 --- /dev/null +++ b/instrumentation/shoryuken/Gemfile @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +source 'https://rubygems.org' + +gemspec + +group :test do + gem 'opentelemetry-instrumentation-base', path: '../base' + gem 'pry-byebug' +end diff --git a/instrumentation/shoryuken/LICENSE b/instrumentation/shoryuken/LICENSE new file mode 100644 index 000000000..1ef7dad2c --- /dev/null +++ b/instrumentation/shoryuken/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/instrumentation/shoryuken/README.md b/instrumentation/shoryuken/README.md new file mode 100644 index 000000000..d9cfc81c2 --- /dev/null +++ b/instrumentation/shoryuken/README.md @@ -0,0 +1,63 @@ +# OpenTelemetry Shoryuken Instrumentation + +The Shoryuken instrumentation is a community-maintained instrumentation for the [Shoryuken][shoryuken-home] Ruby jobs system. + +**Note that this gem currently only supports instrumentation of server side processing.** + +## How do I get started? + +Install the gem using: + +``` +gem install opentelemetry-instrumentation-shoryuken +``` + +Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-shoryuken` in your `Gemfile`. + +## Usage + +To use the instrumentation, call `use` with the name of the instrumentation: + +```ruby +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::Shoryuken' +end +``` + +Alternatively, you can also call `use_all` to install all the available instrumentation. + +```ruby +OpenTelemetry::SDK.configure do |c| + c.use_all +end +``` + +Note that span names can be configured to be based on either the queue name or the job class with the `span_naming` config option, as shown below. Valid values are `:queue` and `:job_class`, `:queue` being the default. + +```ruby +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::Shoryuken', span_naming: :queue +end +``` + +## Examples + +Example usage can be seen in the `./example/shoryuken.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/shoryuken/example/shoryuken.rb) + +## How can I get involved? + +The `opentelemetry-instrumentation-shoryuken` 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 in [GitHub Discussions][discussions-url] 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-instrumentation-shoryuken` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. + +[shoryuken-home]: https://github.com/ruby-shoryuken/shoryuken +[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 +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/shoryuken/Rakefile b/instrumentation/shoryuken/Rakefile new file mode 100644 index 000000000..4b0e9b5a8 --- /dev/null +++ b/instrumentation/shoryuken/Rakefile @@ -0,0 +1,29 @@ +# 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'] + t.warning = false +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/instrumentation/shoryuken/example/Gemfile b/instrumentation/shoryuken/example/Gemfile new file mode 100644 index 000000000..73f7ed3f0 --- /dev/null +++ b/instrumentation/shoryuken/example/Gemfile @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +source 'https://rubygems.org' + +gem 'opentelemetry-api' +gem 'opentelemetry-common' +gem 'opentelemetry-instrumentation-base' +gem 'opentelemetry-instrumentation-shoryuken' +gem 'opentelemetry-sdk' + +gem 'shoryuken' diff --git a/instrumentation/shoryuken/example/shoryuken.rb b/instrumentation/shoryuken/example/shoryuken.rb new file mode 100644 index 000000000..517f79d6a --- /dev/null +++ b/instrumentation/shoryuken/example/shoryuken.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +require 'rubygems' +require 'bundler/setup' + +Bundler.require + +# Export traces to console by default +ENV['OTEL_TRACES_EXPORTER'] ||= 'console' + +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::Shoryuken' +end + +# A basic Shoryuken job worker example +class SimpleJob + include Shoryuken::Worker + + shoryuken_options queue: 'hello', auto_delete: true + + def perform(sqs_msg, name) + puts "Hello, #{name}" + end +end + +SimpleJob.perform_async('Ken') diff --git a/instrumentation/shoryuken/lib/opentelemetry-instrumentation-shoryuken.rb b/instrumentation/shoryuken/lib/opentelemetry-instrumentation-shoryuken.rb new file mode 100644 index 000000000..c034f140f --- /dev/null +++ b/instrumentation/shoryuken/lib/opentelemetry-instrumentation-shoryuken.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require_relative 'opentelemetry/instrumentation' diff --git a/instrumentation/shoryuken/lib/opentelemetry/instrumentation.rb b/instrumentation/shoryuken/lib/opentelemetry/instrumentation.rb new file mode 100644 index 000000000..4fb1d0049 --- /dev/null +++ b/instrumentation/shoryuken/lib/opentelemetry/instrumentation.rb @@ -0,0 +1,22 @@ +# 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 + # "Instrumentation" are specified by + # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library + # + # Instrumentation should be able to handle the case when the library is not installed on a user's system. + module Instrumentation + end +end + +require_relative 'instrumentation/shoryuken' diff --git a/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken.rb b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken.rb new file mode 100644 index 000000000..f032907c1 --- /dev/null +++ b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +require 'opentelemetry' +require 'opentelemetry-instrumentation-base' + +module OpenTelemetry + module Instrumentation + # Contains the OpenTelemetry instrumentation for the Shoryuken gem + module Shoryuken + end + end +end + +require_relative 'shoryuken/instrumentation' +require 'opentelemetry/common' diff --git a/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/instrumentation.rb b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/instrumentation.rb new file mode 100644 index 000000000..9870c67bc --- /dev/null +++ b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/instrumentation.rb @@ -0,0 +1,61 @@ +# frozen_string_literal: true + +module OpenTelemetry + module Instrumentation + module Shoryuken + # The Instrumentation class contains logic to detect and install the Shoryuken + # instrumentation + class Instrumentation < OpenTelemetry::Instrumentation::Base + MINIMUM_VERSION = Gem::Version.new('5.3.0') + + install do |_config| + require_dependencies + add_server_middleware + patch_on_startup + end + + present do + defined?(::Shoryuken) + end + + compatible do + gem_version >= MINIMUM_VERSION + end + + option :span_naming, default: :queue, validate: %I[job_class queue] + + private + + def gem_version + Gem::Version.new(::Shoryuken::VERSION) + end + + def require_dependencies + require_relative 'middlewares/server/tracer_middleware' + + require_relative 'patches/fetcher' + end + + def patch_on_startup + ::Shoryuken.configure_server do |config| + config.on(:startup) do + ::Shoryuken::Fetcher.prepend(Patches::Fetcher) + end + + config.on(:shutdown) do + OpenTelemetry.tracer_provider.shutdown + end + end + end + + def add_server_middleware + ::Shoryuken.configure_server do |config| + config.server_middleware do |chain| + chain.add Middlewares::Server::TracerMiddleware + end + end + end + end + end + end +end diff --git a/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/middlewares/server/tracer_middleware.rb b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/middlewares/server/tracer_middleware.rb new file mode 100644 index 000000000..69ca77350 --- /dev/null +++ b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/middlewares/server/tracer_middleware.rb @@ -0,0 +1,57 @@ +# frozen_string_literal: true + +module OpenTelemetry + module Instrumentation + module Shoryuken + module Middlewares + module Server + # TracerMiddleware propagates context and instruments Shoryuken requests + # by way of its middleware system + class TracerMiddleware + def call(worker_instance, queue, sqs_msg, _body) + attributes = { + OpenTelemetry::SemanticConventions::Trace::MESSAGING_SYSTEM => 'shoryuken', + 'code.namespace' => worker_instance.class.name, + OpenTelemetry::SemanticConventions::Trace::MESSAGING_MESSAGE_ID => sqs_msg.message_id, + OpenTelemetry::SemanticConventions::Trace::MESSAGING_DESTINATION => queue, + OpenTelemetry::SemanticConventions::Trace::MESSAGING_DESTINATION_KIND => 'queue', + OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION => 'process' + } + span_name = case instrumentation_config[:span_naming] + when :job_class then "#{worker_instance.class.name} process" + else "#{queue} process" + end + + extracted_context = OpenTelemetry.propagation.extract(sqs_msg.message_attributes) + OpenTelemetry::Context.with_current(extracted_context) do + links = [] + span_context = OpenTelemetry::Trace.current_span(extracted_context).context + links << OpenTelemetry::Trace::Link.new(span_context) if span_context.valid? + span = tracer.start_root_span(span_name, attributes: attributes, links: links, kind: :consumer) + OpenTelemetry::Trace.with_span(span) do + yield + rescue Exception => e # rubocop:disable Lint/RescueException + span.record_exception(e) + span.status = OpenTelemetry::Trace::Status.error("Unhandled exception of type: #{e.class}") + raise e + ensure + span.finish + end + end + end + + private + + def instrumentation_config + Shoryuken::Instrumentation.instance.config + end + + def tracer + Shoryuken::Instrumentation.instance.tracer + end + end + end + end + end + end +end diff --git a/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/patches/fetcher.rb b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/patches/fetcher.rb new file mode 100644 index 000000000..a0b1c34ce --- /dev/null +++ b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/patches/fetcher.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module OpenTelemetry + module Instrumentation + module Shoryuken + module Patches + # The Fetcher module silences the instrumentation for the fetch method + module Fetcher + def fetch(queue, limit) + OpenTelemetry::Common::Utilities.untraced { super } + end + end + end + end + end +end diff --git a/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/version.rb b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/version.rb new file mode 100644 index 000000000..a559e162f --- /dev/null +++ b/instrumentation/shoryuken/lib/opentelemetry/instrumentation/shoryuken/version.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Shoryuken + VERSION = '0.1.0' + end + end +end diff --git a/instrumentation/shoryuken/opentelemetry-instrumentation-shoryuken.gemspec b/instrumentation/shoryuken/opentelemetry-instrumentation-shoryuken.gemspec new file mode 100644 index 000000000..2abd1eb0f --- /dev/null +++ b/instrumentation/shoryuken/opentelemetry-instrumentation-shoryuken.gemspec @@ -0,0 +1,54 @@ +# 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/instrumentation/shoryuken/version' + +Gem::Specification.new do |spec| + spec.name = 'opentelemetry-instrumentation-shoryuken' + spec.version = OpenTelemetry::Instrumentation::Shoryuken::VERSION + spec.authors = ['OpenTelemetry Authors'] + spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] + + spec.summary = 'Shoryuken instrumentation for the OpenTelemetry framework' + spec.description = 'Shoryuken instrumentation 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.0' + spec.add_dependency 'opentelemetry-common', '~> 0.20.0' + spec.add_dependency 'opentelemetry-instrumentation-aws_sdk', '~> 0.5.0' + spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.22.1' + + spec.add_development_dependency 'activejob', '>= 6.0' + spec.add_development_dependency 'appraisal', '~> 2.2.0' + spec.add_development_dependency 'aws-sdk-sqs', '>= 1.55.0' + spec.add_development_dependency 'bundler', '~> 2.4' + spec.add_development_dependency 'minitest', '~> 5.0' + spec.add_development_dependency 'opentelemetry-sdk', '~> 1.1' + spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3' + spec.add_development_dependency 'rspec-mocks' + spec.add_development_dependency 'rubocop', '~> 1.59.0' + spec.add_development_dependency 'rubocop-performance', '~> 1.19.1' + spec.add_development_dependency 'shoryuken', '~> 5.3.0' + spec.add_development_dependency 'simplecov', '~> 0.17.1' + spec.add_development_dependency 'yard', '~> 0.9' + spec.add_development_dependency 'yard-doctest', '~> 0.1.6' + + 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/instrumentation/shoryuken' + 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/instrumentation/shoryuken/test/helpers/mock_loader.rb b/instrumentation/shoryuken/test/helpers/mock_loader.rb new file mode 100644 index 000000000..bebeda210 --- /dev/null +++ b/instrumentation/shoryuken/test/helpers/mock_loader.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'shoryuken/launcher' + +class MockLoader + include Shoryuken::Util + + attr_reader :launcher + + def initialize + fire_event(:startup) + Shoryuken.add_group('default', Shoryuken.options[:concurrency]) + @launcher = Shoryuken::Launcher.new + end + + def fetcher + manager.instance_variable_get(:@fetcher) + end + + def manager + launcher.instance_variable_get(:@managers).first + end +end diff --git a/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/instrumentation_test.rb b/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/instrumentation_test.rb new file mode 100644 index 000000000..b15171c90 --- /dev/null +++ b/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/instrumentation_test.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' +require_relative '../../../../lib/opentelemetry/instrumentation/shoryuken' + +describe OpenTelemetry::Instrumentation::Shoryuken::Instrumentation do + let(:instrumentation) { OpenTelemetry::Instrumentation::Shoryuken::Instrumentation.instance } + + it 'has #name' do + _(instrumentation.name).must_equal 'OpenTelemetry::Instrumentation::Shoryuken' + end + + it 'has #version' do + _(instrumentation.version).wont_be_nil + _(instrumentation.version).wont_be_empty + end + + describe 'compatible' do + it 'when older gem version installed' do + stub_const('::Shoryuken::VERSION', '5.2.3') + _(instrumentation.compatible?).must_equal false + end + + it 'when future gem version installed' do + _(instrumentation.compatible?).must_equal true + end + end +end diff --git a/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/middlewares/server/tracer_middleware_test.rb b/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/middlewares/server/tracer_middleware_test.rb new file mode 100644 index 000000000..fbea1e411 --- /dev/null +++ b/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/middlewares/server/tracer_middleware_test.rb @@ -0,0 +1,102 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' +require_relative '../../../../../../lib/opentelemetry/instrumentation/shoryuken' +require_relative '../../../../../../lib/opentelemetry/instrumentation/shoryuken/middlewares/server/tracer_middleware' + +describe OpenTelemetry::Instrumentation::Shoryuken::Middlewares::Server::TracerMiddleware do + let(:instrumentation) { OpenTelemetry::Instrumentation::Shoryuken::Instrumentation.instance } + let(:exporter) { EXPORTER } + let(:spans) { exporter.finished_spans } + let(:enqueuer_span) { spans.first } + let(:job_span) { spans.last } + let(:root_span) { spans.find { |s| s.parent_span_id == OpenTelemetry::Trace::INVALID_SPAN_ID } } + let(:config) { {} } + let(:queue_name) { 'default' } + let(:sqs_msg) do + double( + Shoryuken::Message, + queue_url: queue_name, + body: '{"test" : 1}', + message_attributes: { + 'shoryuken_class' => { string_value: worker_class.name } + }, + message_id: SecureRandom.uuid, + receipt_handle: SecureRandom.uuid + ) + end + let(:sqs_client) { Aws::SQS::Client.new(stub_responses: true) } + let(:worker_class) { SimpleJob } + + before do + allow(sqs_client).to receive(:get_queue_url).and_return(double(queue_url: 'https://sqs.fake.amazonaws.com/1/queue-name')) + instrumentation.install(config) + exporter.reset + Shoryuken::Client.sqs = sqs_client + end + + after { instrumentation.instance_variable_set(:@installed, false) } + + describe 'enqueue spans' do + it 'before performing any jobs' do + _(exporter.finished_spans.size).must_equal 0 + end + + it 'traces processing' do + Shoryuken::Processor.process(queue_name, sqs_msg) + + _(exporter.finished_spans.size).must_equal 1 + + _(job_span.name).must_equal "#{queue_name} process" + _(job_span.kind).must_equal :consumer + _(job_span.attributes['messaging.system']).must_equal 'shoryuken' + _(job_span.attributes['code.namespace']).must_equal worker_class.name + _(job_span.attributes['messaging.message_id']).must_equal sqs_msg.message_id + _(job_span.attributes['messaging.destination']).must_equal 'default' + _(job_span.attributes['messaging.destination_kind']).must_equal 'queue' + _(job_span.attributes['messaging.operation']).must_equal 'process' + end + + describe 'when enqueued with Active Job' do + let(:worker_class) { SimpleJobWithActiveJob } + + it 'traces when enqueued with Active Job' do + Shoryuken::Processor.process(queue_name, sqs_msg) + + _(job_span.attributes['messaging.system']).must_equal 'shoryuken' + _(job_span.attributes['code.namespace']).must_equal worker_class.name + _(job_span.attributes['messaging.message_id']).must_equal sqs_msg.message_id + _(job_span.attributes['messaging.destination']).must_equal 'default' + _(job_span.attributes['messaging.destination_kind']).must_equal 'queue' + _(job_span.attributes['messaging.operation']).must_equal 'process' + end + end + + describe 'when span_naming is job_class' do + let(:config) { { span_naming: :job_class } } + + it 'uses the job class name for the span name' do + Shoryuken::Processor.process(queue_name, sqs_msg) + + _(job_span.name).must_equal("#{worker_class} process") + end + end + + describe 'when worker raises exception' do + let(:worker_class) { ExceptionTestingJob } + + it 'records exceptions' do + _(-> { Shoryuken::Processor.process(queue_name, sqs_msg) }).must_raise(RuntimeError) + + ev = job_span.events + _(ev[0].attributes['exception.type']).must_equal('RuntimeError') + _(ev[0].attributes['exception.message']).must_equal('a little hell') + _(ev[0].attributes['exception.stacktrace']).wont_be_nil + end + end + end +end diff --git a/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/patches/fetcher_test.rb b/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/patches/fetcher_test.rb new file mode 100644 index 000000000..15c6211cf --- /dev/null +++ b/instrumentation/shoryuken/test/opentelemetry/instrumentation/shoryuken/patches/fetcher_test.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../../lib/opentelemetry/instrumentation/shoryuken' +require_relative '../../../../../lib/opentelemetry/instrumentation/shoryuken/patches/fetcher' + +describe OpenTelemetry::Instrumentation::Shoryuken::Patches::Fetcher do + let(:instrumentation) { OpenTelemetry::Instrumentation::Shoryuken::Instrumentation.instance } + let(:exporter) { EXPORTER } + let(:spans) { exporter.finished_spans } + let(:config) { {} } + let(:fetcher) { MockLoader.new.fetcher } + let(:queue) { Shoryuken::Client.queues('default') } + let(:sqs_client) { Aws::SQS::Client.new(stub_responses: true) } + + before do + # Clear spans + exporter.reset + instrumentation.install(config) + Shoryuken::Client.sqs = sqs_client + end + + after do + # Force re-install of instrumentation + instrumentation.instance_variable_set(:@installed, false) + end + + describe 'fetch' do + it 'does not trace' do + allow(fetcher).to receive(:fetch_with_auto_retry) + fetcher.fetch(queue, 10) + _(spans.size).must_equal(0) + end + end +end diff --git a/instrumentation/shoryuken/test/test_helper.rb b/instrumentation/shoryuken/test/test_helper.rb new file mode 100644 index 000000000..fa13b4795 --- /dev/null +++ b/instrumentation/shoryuken/test/test_helper.rb @@ -0,0 +1,59 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'bundler/setup' +Bundler.require(:default, :development, :test) + +require 'active_job' + +require 'minitest/autorun' +require 'rspec/mocks/minitest_integration' + +require 'helpers/mock_loader' +require 'shoryuken/extensions/active_job_adapter' + +# OpenTelemetry SDK config for testing +EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new +span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER) + +OpenTelemetry::SDK.configure do |c| + c.error_handler = ->(exception:, message:) { raise(exception || message) } + c.add_span_processor span_processor +end + +# Silence Actibe Job logging noise +ActiveJob::Base.logger = Logger.new($stderr, level: ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym) + +class SimpleJobWithActiveJob < ActiveJob::Base + queue_as :default + include Shoryuken::Worker + shoryuken_options body_parser: JSON, queue: 'default', auto_delete: false + + def perform(*args); end +end + +class SimpleJob + include Shoryuken::Worker + shoryuken_options body_parser: JSON, queue: 'default', auto_delete: false + + def perform(sqs_msg, payload); end +end + +class ExceptionTestingJob + include Shoryuken::Worker + shoryuken_options body_parser: JSON, queue: 'default', auto_delete: true + + def perform(*args) + raise 'a little hell' + end +end + +module Shoryuken + module CLI + # Hack to signal to shoryuken it's running in a server context + # see https://github.com/ruby-shoryuken/shoryuken/blob/f24db5422ef6869c4a556c134a27b4259027e7b8/lib/shoryuken/options.rb#L151 + end +end