From 06759156579cfa4b6a83bd5ff8dfdfdcbf3e9747 Mon Sep 17 00:00:00 2001 From: Mike Goldsmith Date: Tue, 30 Apr 2024 12:34:36 +0100 Subject: [PATCH] feat: Add baggage span processor (#937) --- .github/workflows/ci-contrib.yml | 43 ++++ .release-please-manifest.json | 1 + CODEOWNERS | 2 + processor/baggage/.rubocop.yml | 1 + processor/baggage/.yardopts | 9 + processor/baggage/CHANGELOG.md | 5 + processor/baggage/Gemfile | 6 + processor/baggage/LICENSE | 201 ++++++++++++++++++ processor/baggage/README.md | 75 +++++++ processor/baggage/Rakefile | 30 +++ .../lib/opentelemetry-processor-baggage.rb | 7 + .../baggage/baggage_span_processor.rb | 86 ++++++++ .../processor/baggage/version.rb | 21 ++ .../opentelemetry-processor-baggage.gemspec | 44 ++++ .../baggage/baggage_span_processor_test.rb | 95 +++++++++ processor/baggage/test/test_helper.rb | 11 + 16 files changed, 637 insertions(+) create mode 100644 processor/baggage/.rubocop.yml create mode 100644 processor/baggage/.yardopts create mode 100644 processor/baggage/CHANGELOG.md create mode 100644 processor/baggage/Gemfile create mode 100644 processor/baggage/LICENSE create mode 100644 processor/baggage/README.md create mode 100644 processor/baggage/Rakefile create mode 100644 processor/baggage/lib/opentelemetry-processor-baggage.rb create mode 100644 processor/baggage/lib/opentelemetry/processor/baggage/baggage_span_processor.rb create mode 100644 processor/baggage/lib/opentelemetry/processor/baggage/version.rb create mode 100644 processor/baggage/opentelemetry-processor-baggage.gemspec create mode 100644 processor/baggage/test/opentelemetry/processor/baggage/baggage_span_processor_test.rb create mode 100644 processor/baggage/test/test_helper.rb diff --git a/.github/workflows/ci-contrib.yml b/.github/workflows/ci-contrib.yml index 991aa0134..05d5965e1 100644 --- a/.github/workflows/ci-contrib.yml +++ b/.github/workflows/ci-contrib.yml @@ -137,3 +137,46 @@ jobs: with: gem: "opentelemetry-${{ matrix.gem }}" ruby: "jruby-9.4.6.0" + + processors: + strategy: + fail-fast: false + matrix: + gem: + - baggage + os: + - ubuntu-latest + name: "processors-${{ matrix.gem }} / ${{ matrix.os }}" + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v4 + - name: "Test Ruby 3.3" + uses: ./.github/actions/test_gem + with: + gem: "opentelemetry-processor-${{ matrix.gem }}" + ruby: "3.3" + - name: "Test Ruby 3.2" + uses: ./.github/actions/test_gem + with: + gem: "opentelemetry-processor-${{ matrix.gem }}" + ruby: "3.2" + - name: "Test Ruby 3.1" + uses: ./.github/actions/test_gem + with: + gem: "opentelemetry-processor-${{ matrix.gem }}" + ruby: "3.1" + - name: "Test Ruby 3.0" + if: "${{ matrix.os == 'ubuntu-latest' }}" + uses: ./.github/actions/test_gem + with: + gem: "opentelemetry-processor-${{ matrix.gem }}" + ruby: "3.0" + yard: true + rubocop: true + build: true + - name: "Test JRuby" + if: "${{ matrix.os == 'ubuntu-latest' && steps.jruby_skip.outputs.skip == 'false' }}" + uses: ./.github/actions/test_gem + with: + gem: "opentelemetry-processor-${{ matrix.gem }}" + ruby: "jruby-9.4.6.0" diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 4f2fb0487..6d6a159dc 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -43,6 +43,7 @@ "instrumentation/sidekiq": "0.25.0", "instrumentation/sinatra": "0.23.2", "instrumentation/all": "0.56.0", + "processor/baggage": "0.1.0", "propagator/ottrace": "0.21.2", "propagator/xray": "0.22.1", "resources/azure": "0.1.0", diff --git a/CODEOWNERS b/CODEOWNERS index f24644798..732650bfb 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -31,3 +31,5 @@ instrumentation/racecar/ @chrisholmes @open-telemetry/ruby-contrib-maintainers @ instrumentation/rspec/ @chrisholmes @open-telemetry/ruby-contrib-maintainers @open-telemetry/ruby-contrib-approvers @fbogsany @mwear @robertlaurin @dazuma @ericmustin @arielvalentin @ahayworth @plantfansam @robbkidd @simi @kaylareopelle @xuan-cao-swi instrumentation/que/ @indrekj @open-telemetry/ruby-contrib-maintainers @open-telemetry/ruby-contrib-approvers @fbogsany @mwear @robertlaurin @dazuma @ericmustin @arielvalentin @ahayworth @plantfansam @robbkidd @simi @kaylareopelle @xuan-cao-swi + +processor/baggage/ @robbkidd @mikegoldsmith @open-telemetry/ruby-contrib-maintainers @open-telemetry/ruby-contrib-approvers @fbogsany @mwear @robertlaurin @dazuma @ericmustin @arielvalentin @ahayworth @plantfansam @robbkidd @simi @kaylareopelle @xuan-cao-swi diff --git a/processor/baggage/.rubocop.yml b/processor/baggage/.rubocop.yml new file mode 100644 index 000000000..1248a2f82 --- /dev/null +++ b/processor/baggage/.rubocop.yml @@ -0,0 +1 @@ +inherit_from: ../../.rubocop.yml diff --git a/processor/baggage/.yardopts b/processor/baggage/.yardopts new file mode 100644 index 000000000..6046da39e --- /dev/null +++ b/processor/baggage/.yardopts @@ -0,0 +1,9 @@ +--no-private +--title=OpenTelemetry Processor Baggage +--markup=markdown +--main=README.md +./lib/opentelemetry/processor/baggage/**/*.rb +./lib/opentelemetry/processor/baggage.rb +- +README.md +CHANGELOG.md diff --git a/processor/baggage/CHANGELOG.md b/processor/baggage/CHANGELOG.md new file mode 100644 index 000000000..a054e650e --- /dev/null +++ b/processor/baggage/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History: opentelemetry-processor-baggage + +### v0.1.0 / 2024-04-18 + +* Initial release. diff --git a/processor/baggage/Gemfile b/processor/baggage/Gemfile new file mode 100644 index 000000000..52eb0ed2e --- /dev/null +++ b/processor/baggage/Gemfile @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +source 'https://rubygems.org' + +# Specify your gem's dependencies in opentelemetry-processor-baggage.gemspec +gemspec diff --git a/processor/baggage/LICENSE b/processor/baggage/LICENSE new file mode 100644 index 000000000..1ef7dad2c --- /dev/null +++ b/processor/baggage/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/processor/baggage/README.md b/processor/baggage/README.md new file mode 100644 index 000000000..b880f1150 --- /dev/null +++ b/processor/baggage/README.md @@ -0,0 +1,75 @@ +# Baggage Span Processor + +This is an OpenTelemetry [span processor](https://opentelemetry.io/docs/specs/otel/trace/sdk/#span-processor) that reads key/values stored in [Baggage](https://opentelemetry.io/docs/specs/otel/baggage/api/) in the starting span's parent context and adds them as attributes to the span. + +Keys and values added to Baggage will appear on all subsequent child spans for a trace within this service *and* will be propagated to external services via propagation headers. +If the external services also have a Baggage span processor, the keys and values will appear in those child spans as well. + +⚠️ Waning ⚠️ +To repeat: a consequence of adding data to Baggage is that the keys and values will appear in all outgoing HTTP headers from the application. +Do not put sensitive information in Baggage. + +## How do I get started? + +Install the gem using: + +```shell +gem install opentelemetry-processor-baggage +``` + +Or, if you use [bundler][bundler-home], include `opentelemetry-processor-baggage` to your `Gemfile`. + +### Version Compatibility + +* OpenTelemetry API v1.0+ + +## Usage + +To install the instrumentation, add the gem to your Gemfile: + +```ruby +gem 'opentelemetry-processor-baggage' +``` + +Then add the processor to an SDK's configuration: + +```ruby +require 'rubygems' +require 'bundler/setup' + +Bundler.require + +OpenTelemetry::SDK.configure do |c| + # Add the BaggageSpanProcessor to the collection of span processors + c.add_span_processor(OpenTelemetry::Processor::Baggage::BaggageSpanProcessor.new) + + # Because the span processor list is no longer empty, the SDK will not use the + # values in OTEL_TRACES_EXPORTER to instantiate exporters. + # You'll need to declare your own here in the configure block. + # + # These lines setup the default: a batching OTLP exporter. + c.add_span_processor( + # these constructors without arguments will pull config from the environment + OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new( + OpenTelemetry::Exporter::OTLP::Exporter.new() + ) + ) +end +``` + +## How can I get involved? + +The `opentelemetry-processor-baggage` 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-sinatra` 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-contrib +[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/processor/baggage/Rakefile b/processor/baggage/Rakefile new file mode 100644 index 000000000..88f3670a3 --- /dev/null +++ b/processor/baggage/Rakefile @@ -0,0 +1,30 @@ +# 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' + +ENV['ENABLE_COVERAGE'] ||= '1' + +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/processor/baggage/lib/opentelemetry-processor-baggage.rb b/processor/baggage/lib/opentelemetry-processor-baggage.rb new file mode 100644 index 000000000..a1b22b5a5 --- /dev/null +++ b/processor/baggage/lib/opentelemetry-processor-baggage.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +# Copyright OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require_relative 'opentelemetry/processor/baggage/baggage_span_processor' diff --git a/processor/baggage/lib/opentelemetry/processor/baggage/baggage_span_processor.rb b/processor/baggage/lib/opentelemetry/processor/baggage/baggage_span_processor.rb new file mode 100644 index 000000000..c5e840cec --- /dev/null +++ b/processor/baggage/lib/opentelemetry/processor/baggage/baggage_span_processor.rb @@ -0,0 +1,86 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'opentelemetry-api' +require 'opentelemetry-sdk' + +module OpenTelemetry + module Processor + module Baggage + # The BaggageSpanProcessor reads key/values stored in Baggage in the + # starting span's parent context and adds them as attributes to the span. + # + # Keys and values added to Baggage will appear on all subsequent child spans + # for a trace within this service *and* will be propagated to external services + # via propagation headers. If the external services also have a Baggage span + # processor, the keys and values will appear in those child spans as well. + # + # ⚠️ + # To repeat: a consequence of adding data to Baggage is that the keys and + # values will appear in all outgoing HTTP headers from the application. + # Do not put sensitive information in Baggage. + # ⚠️ + # + # @example + # OpenTelemetry::SDK.configure do |c| + # # Add the BaggageSpanProcessor to the collection of span processors + # c.add_span_processor(OpenTelemetry::Processor::Baggage::BaggageSpanProcessor.new) + # + # # Because the span processor list is no longer empty, the SDK will not use the + # # values in OTEL_TRACES_EXPORTER to instantiate exporters. + # # You'll need to declare your own here in the configure block. + # # + # # These lines setup the default: a batching OTLP exporter. + # c.add_span_processor( + # # these constructors without arguments will pull config from the environment + # OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new( + # OpenTelemetry::Exporter::OTLP::Exporter.new() + # ) + # ) + # end + class BaggageSpanProcessor < OpenTelemetry::SDK::Trace::SpanProcessor + # Called when a `Span` is started, adds Baggage keys/values to the span as attributes. + # + # @param [Span] span the `Span` that just started, expected to conform + # to the concrete `Span` interface from the SDK and respond to :add_attributes. + # @param [Context] parent_context the parent `Context` of the newly + # started span. + def on_start(span, parent_context) + return unless span.respond_to?(:add_attributes) && parent_context.is_a?(::OpenTelemetry::Context) + + span.add_attributes(::OpenTelemetry::Baggage.values(context: parent_context)) + end + + # Called when a Span is ended, does nothing. + # + # NO-OP method to satisfy the SpanProcessor duck type. + # + # @param [Span] span the {OpenTelemetry::Trace::Span} that just ended. + def on_finish(span); end + + # Always successful; this processor does not maintain any state to flush. + # + # NO-OP method to satisfy the `SpanProcessor` duck type. + # + # @param [optional Numeric] timeout An optional timeout in seconds. + # @return [Integer] 0 for success and there is nothing to flush so always successful. + def force_flush(timeout: nil) + 0 + end + + # Always successful; this processor does not maintain any state to clean up or processes to close on shutdown. + # + # NO-OP method to satisfy the `SpanProcessor` duck type. + # + # @param [optional Numeric] timeout An optional timeout in seconds. + # @return [Integer] 0 for success and there is nothing to stop so always successful. + def shutdown(timeout: nil) + 0 + end + end + end + end +end diff --git a/processor/baggage/lib/opentelemetry/processor/baggage/version.rb b/processor/baggage/lib/opentelemetry/processor/baggage/version.rb new file mode 100644 index 000000000..1544ac3f1 --- /dev/null +++ b/processor/baggage/lib/opentelemetry/processor/baggage/version.rb @@ -0,0 +1,21 @@ +# 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 + # Namespace for OpenTelemetry processor extension libraries + module Processor + # Namespace for OpenTelemetry Baggage processor + module Baggage + VERSION = '0.1.0' + end + end +end diff --git a/processor/baggage/opentelemetry-processor-baggage.gemspec b/processor/baggage/opentelemetry-processor-baggage.gemspec new file mode 100644 index 000000000..adaaf13be --- /dev/null +++ b/processor/baggage/opentelemetry-processor-baggage.gemspec @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require_relative 'lib/opentelemetry/processor/baggage/version' + +Gem::Specification.new do |spec| + spec.name = 'opentelemetry-processor-baggage' + spec.version = OpenTelemetry::Processor::Baggage::VERSION + spec.authors = ['OpenTelemetry Authors'] + spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] + + spec.summary = 'Baggage Span Processor for the OpenTelemetry framework' + spec.description = 'Baggage Span Processor 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-sdk', '~> 1.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 'rake', '~> 13.0' + spec.add_development_dependency 'rubocop', '~> 1.62' + spec.add_development_dependency 'rubocop-performance', '~> 1.20' + spec.add_development_dependency 'simplecov', '~> 0.22.0' + 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/processor/baggage' + 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/processor/baggage/test/opentelemetry/processor/baggage/baggage_span_processor_test.rb b/processor/baggage/test/opentelemetry/processor/baggage/baggage_span_processor_test.rb new file mode 100644 index 000000000..1f7bfc779 --- /dev/null +++ b/processor/baggage/test/opentelemetry/processor/baggage/baggage_span_processor_test.rb @@ -0,0 +1,95 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require 'opentelemetry/sdk' + +TEST_EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new + +OpenTelemetry::SDK.configure do |c| + # the baggage processor getting wired in for testing + c.add_span_processor OpenTelemetry::Processor::Baggage::BaggageSpanProcessor.new + + # use a simple processor and in-memory export for testing sent spans + c.add_span_processor( + OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(TEST_EXPORTER) + ) + + c.error_handler = ->(exception:, message:) { raise(exception || message) } + c.logger = Logger.new($stderr, level: ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym) +end + +describe OpenTelemetry::Processor::Baggage::BaggageSpanProcessor do + let(:processor) { OpenTelemetry::Processor::Baggage::BaggageSpanProcessor.new } + let(:span) { Minitest::Mock.new } + let(:context_with_baggage) { OpenTelemetry::Baggage.set_value('a_key', 'a_value') } + + describe '#on_start' do + it 'adds current baggage keys/values as attributes when a span starts' do + span.expect(:add_attributes, span, [{ 'a_key' => 'a_value' }]) + + processor.on_start(span, context_with_baggage) + + span.verify + end + + it 'does not blow up when given nil context' do + processor.on_start(span, nil) + assert true # nothing above raised an exception + end + it 'does not blow up when given nil span' do + processor.on_start(nil, context_with_baggage) + assert true # nothing above raised an exception + end + it 'does not blow up when given nil span and context' do + processor.on_start(nil, nil) + assert true # nothing above raised an exception + end + it 'does not blow up when given a context that is not a Context' do + processor.on_start(span, :not_a_context) + assert true # nothing above raised an exception + end + it 'does not blow up when given a span that is not a Span' do + processor.on_start(:not_a_span, context_with_baggage) + assert true # nothing above raised an exception + end + end + + describe 'satisfies the SpanProcessor duck type with no-op methods' do + it 'implements #on_finish' do + processor.on_finish(span) + assert true # nothing above raised an exception + end + + it 'implements #force_flush' do + _(processor.force_flush).must_equal(OpenTelemetry::SDK::Trace::Export::SUCCESS) + end + + it 'implements #shutdown' do + _(processor.shutdown).must_equal(OpenTelemetry::SDK::Trace::Export::SUCCESS) + end + end + + describe 'integration test with an exporter' do + let(:tracer) { OpenTelemetry.tracer_provider.tracer('🧳') } + let(:exporter) { TEST_EXPORTER } + + before do + exporter.reset + end + + it 'adds baggage attributes to spans' do + tracer + .start_span('integration test span', with_parent: context_with_baggage) + .finish + + _(exporter.finished_spans.size).must_equal(1) + _(exporter.finished_spans.first.name).must_equal('integration test span') + _(exporter.finished_spans.first.attributes).must_equal('a_key' => 'a_value') + end + end +end diff --git a/processor/baggage/test/test_helper.rb b/processor/baggage/test/test_helper.rb new file mode 100644 index 000000000..8c1eb5932 --- /dev/null +++ b/processor/baggage/test/test_helper.rb @@ -0,0 +1,11 @@ +# 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' +require 'opentelemetry-processor-baggage'