diff --git a/.cspell.yml b/.cspell.yml index ca4fb19fc6..c63eaf0f6d 100644 --- a/.cspell.yml +++ b/.cspell.yml @@ -82,3 +82,4 @@ words: - webmocks - Xuan - yardoc + - traceparent \ No newline at end of file diff --git a/.github/workflows/ci-contrib.yml b/.github/workflows/ci-contrib.yml index 63c7a0d23e..186a6e0008 100644 --- a/.github/workflows/ci-contrib.yml +++ b/.github/workflows/ci-contrib.yml @@ -69,6 +69,7 @@ jobs: - ottrace - vitess - xray + - google_cloud_trace_context os: - ubuntu-latest name: "propagator-${{ matrix.gem }} / ${{ matrix.os }}" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf5929e71b..80e4162ece 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,6 +71,7 @@ This repository contains multiple Ruby gems: * Various resource detector gems located in subdirectories of `resources` * `opentelemetry-propagator-xray` located in the `propagator/xray` directory * `opentelemetry-propagator-ottrace` located in the `propagator/ottrace` directory +* `opentelemetry-propagator-google_cloud_trace_context` located in the `propagator/google_cloud_trace_context` directory Each of these gems has its configuration and tests. diff --git a/propagator/google_cloud_trace_context/.rubocop.yml b/propagator/google_cloud_trace_context/.rubocop.yml new file mode 100644 index 0000000000..1248a2f825 --- /dev/null +++ b/propagator/google_cloud_trace_context/.rubocop.yml @@ -0,0 +1 @@ +inherit_from: ../../.rubocop.yml diff --git a/propagator/google_cloud_trace_context/.yardopts b/propagator/google_cloud_trace_context/.yardopts new file mode 100644 index 0000000000..0d1da5e71f --- /dev/null +++ b/propagator/google_cloud_trace_context/.yardopts @@ -0,0 +1,9 @@ +--no-private +--title=OpenTelemetry Propagator Google Cloud Trace Context +--markup=markdown +--main=README.md +./lib/opentelemetry/propagator/google_cloud_trace_context/**/*.rb +./lib/opentelemetry/propagator/google_cloud_trace_context.rb +- +README.md +CHANGELOG.md diff --git a/propagator/google_cloud_trace_context/CHANGELOG.md b/propagator/google_cloud_trace_context/CHANGELOG.md new file mode 100644 index 0000000000..2730092922 --- /dev/null +++ b/propagator/google_cloud_trace_context/CHANGELOG.md @@ -0,0 +1 @@ +# Release History: opentelemetry-propagator-google_cloud_trace_context diff --git a/propagator/google_cloud_trace_context/Gemfile b/propagator/google_cloud_trace_context/Gemfile new file mode 100644 index 0000000000..32cf4f817d --- /dev/null +++ b/propagator/google_cloud_trace_context/Gemfile @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +source 'https://rubygems.org' + +gemspec + +group :test do + gem 'bundler', '~> 2.4' + gem 'minitest', '~> 5.0' + gem 'rake', '~> 13.0' + gem 'rubocop', '~> 1.75.1' + gem 'rubocop-performance', '~> 1.24.0' + gem 'simplecov', '~> 0.22.0' + gem 'yard', '~> 0.9' + if RUBY_VERSION >= '3.4' + gem 'base64' + gem 'mutex_m' + end +end diff --git a/propagator/google_cloud_trace_context/LICENSE b/propagator/google_cloud_trace_context/LICENSE new file mode 100644 index 0000000000..1ef7dad2c5 --- /dev/null +++ b/propagator/google_cloud_trace_context/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/propagator/google_cloud_trace_context/README.md b/propagator/google_cloud_trace_context/README.md new file mode 100644 index 0000000000..39d7fab63f --- /dev/null +++ b/propagator/google_cloud_trace_context/README.md @@ -0,0 +1,71 @@ +# opentelemetry-propagator-google_cloud_trace_context + +The `opentelemetry-propagator-google_cloud_trace_context` gem contains injectors and extractors for the +[Google Cloud X-Cloud-Trace-Context format][gcp-spec]. + +## X-Cloud-Trace-Context header + +The `X-Cloud-Trace-Context` header that is used by Google Cloud predates the W3C specification. For backwards compatibility, some Google Cloud services continue to accept, generate, and propagate the `X-Cloud-Trace-Context` header. However, it is likely that these systems also support the traceparent header. + +For example Google's Cloud Load Balancers (which do not support the traceparent header)[https://issuetracker.google.com/issues/253419736], instead will only propagate `X-Cloud-Trace-Context` which this gem helps resolve. + +The `X-Cloud-Trace-Context` header has the following format: + +```yaml +X-Cloud-Trace-Context: TRACE_ID/SPAN_ID;o=OPTIONS +``` + +The fields of header are defined as follows: + +- `TRACE_ID` is a 32-character hexadecimal value representing a 128-bit number. +- `SPAN_ID` is a 64-bit decimal representation of the unsigned span ID. +- `OPTIONS` supports 0 (parent not sampled) and 1 (parent was sampled). + +## What is OpenTelemetry? + +[OpenTelemetry][opentelemetry-home] 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. + +OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools. + +## How does this gem fit in? + +This gem can be used with any OpenTelemetry SDK implementation. This can be the official `opentelemetry-sdk` gem or any other concrete implementation. + +## How do I get started? + +Install the gem using: + +```console +gem install opentelemetry-propagator-google_cloud_trace_context +``` + +Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-google_cloud_trace_context` in your `Gemfile`. + +Configure your application to use this propagator by setting the following [environment variable][envars]: + +```console +OTEL_PROPAGATORS=google_cloud_trace_context +``` + +## How can I get involved? + +The `opentelemetry-propagator-google_cloud_trace_context` 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-propagator-google_cloud_trace_context` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. + +[opentelemetry-home]: https://opentelemetry.io +[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 +[gcp-spec]: https://cloud.google.com/appengine/docs/standard/writing-application-logs +[rfc7230-url]: https://tools.ietf.org/html/rfc7230#section-3.2 +[fields-spec-url]: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md#fields +[envars]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/sdk-environment-variables.md#general-sdk-configuration diff --git a/propagator/google_cloud_trace_context/Rakefile b/propagator/google_cloud_trace_context/Rakefile new file mode 100644 index 0000000000..1a64ba842e --- /dev/null +++ b/propagator/google_cloud_trace_context/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/propagator/google_cloud_trace_context/lib/opentelemetry-propagator-google_cloud_trace_context.rb b/propagator/google_cloud_trace_context/lib/opentelemetry-propagator-google_cloud_trace_context.rb new file mode 100644 index 0000000000..f5cf0a9b15 --- /dev/null +++ b/propagator/google_cloud_trace_context/lib/opentelemetry-propagator-google_cloud_trace_context.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'opentelemetry-api' +require_relative 'opentelemetry/propagator/google_cloud_trace_context' diff --git a/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context.rb b/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context.rb new file mode 100644 index 0000000000..7d425b4a55 --- /dev/null +++ b/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'opentelemetry/propagator/google_cloud_trace_context/version' +require 'opentelemetry/propagator/google_cloud_trace_context/text_map_propagator' + +# 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 propagator extension libraries + module Propagator + # Namespace for OpenTelemetry GoogleCloudTraceContext propagation + module GoogleCloudTraceContext + extend self + + TEXT_MAP_PROPAGATOR = TextMapPropagator.new + + private_constant :TEXT_MAP_PROPAGATOR + + # Returns a text map propagator that propagates context using the + # GoogleCloudTraceContext format. + def text_map_propagator + TEXT_MAP_PROPAGATOR + end + end + end +end diff --git a/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context/text_map_propagator.rb b/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context/text_map_propagator.rb new file mode 100644 index 0000000000..8ff433f5e9 --- /dev/null +++ b/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context/text_map_propagator.rb @@ -0,0 +1,125 @@ +# 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 propagator extension libraries + module Propagator + # Namespace for OpenTelemetry GoogleCloudTraceContext propagation + module GoogleCloudTraceContext + # Provides a class for decoding and encoding x-cloud-trace-context header to/from into trace components + class CloudTraceContext + CLOUD_TRACE_CONTEXT_REGEX = %r{\A(?[a-f0-9]{32})\/(?[0-9]+)(?:;o=(?[01]))?\Z}i + + private_constant :CLOUD_TRACE_CONTEXT_REGEX + + class << self + # Creates a new {CloudTraceContext} from a supplied {Trace::SpanContext} + # @param [SpanContext] ctx The span context + # @return [CloudTraceContext] a trace parent + def from_span_context(ctx) + new(trace_id: ctx.trace_id, span_id: ctx.span_id, flags: ctx.trace_flags) + end + + # Deserializes the {CloudTraceContext} from the string representation + # @param [String] string The serialized trace parent + # @return [CloudTraceContext, nil] a trace_parent or nil if malformed + def from_string(string) + matches = CLOUD_TRACE_CONTEXT_REGEX.match(string) + return unless matches + + trace_id = Array(matches[:trace_id].downcase).pack('H*') + span_id = Array(matches[:span_id].to_i.to_s(16)).pack('H*') + flags = matches[:options] == '1' ? Trace::TraceFlags::SAMPLED : Trace::TraceFlags::DEFAULT + + new(trace_id: trace_id, span_id: span_id, flags: flags) + end + end + + attr_reader :trace_id, :span_id, :flags + + private_class_method :new + + # converts this object into a string according to the w3c spec + # @return [String] the serialized trace_parent + def to_s + "#{trace_id.unpack1('H*')}/#{span_id.unpack1('H*').to_i(16)};o=#{flags.sampled? ? '1' : '0'}" + end + + private + + def initialize(trace_id: nil, span_id: nil, flags: Trace::TraceFlags::DEFAULT) + @trace_id = trace_id + @span_id = span_id + @flags = flags + end + end + + # Propagates context using GoogleCloudTraceContext header format + class TextMapPropagator + CLOUD_TRACE_CONTEXT_KEY = 'x-cloud-trace-context' + FIELDS = [CLOUD_TRACE_CONTEXT_KEY].freeze + + private_constant :CLOUD_TRACE_CONTEXT_KEY, :FIELDS + + # Inject trace context into the supplied carrier. + # + # @param [Carrier] carrier The mutable carrier to inject trace context into + # @param [Context] context The context to read trace context from + # @param [optional Setter] setter If the optional setter is provided, it + # will be used to write context into the carrier, otherwise the default + # text map setter will be used. + def inject(carrier, context: Context.current, setter: Context::Propagation.text_map_setter) + span_context = Trace.current_span(context).context + return unless span_context.valid? + + setter.set(carrier, CLOUD_TRACE_CONTEXT_KEY, CloudTraceContext.from_span_context(span_context).to_s) + nil + end + + # Extract trace context from the supplied carrier. + # If extraction fails, the original context will be returned + # + # @param [Carrier] carrier The carrier to get the header from + # @param [optional Context] context Context to be updated with the trace context + # extracted from the carrier. Defaults to +Context.current+. + # @param [optional Getter] getter If the optional getter is provided, it + # will be used to read the header from the carrier, otherwise the default + # text map getter will be used. + # + # @return [Context] context updated with extracted baggage, or the original context + # if extraction fails + def extract(carrier, context: Context.current, getter: Context::Propagation.text_map_getter) + trace_parent_value = getter.get(carrier, CLOUD_TRACE_CONTEXT_KEY) + return context unless trace_parent_value + + cloud_trace_context = CloudTraceContext.from_string(trace_parent_value) + return context unless cloud_trace_context + + span_context = Trace::SpanContext.new(trace_id: cloud_trace_context.trace_id, + span_id: cloud_trace_context.span_id, + trace_flags: cloud_trace_context.flags, + remote: true) + span = Trace.non_recording_span(span_context) + Trace.context_with_span(span, parent_context: context) + end + + # Returns the predefined propagation fields. If your carrier is reused, you + # should delete the fields returned by this method before calling +inject+. + # + # @return [Array] a list of fields that will be used by this propagator. + def fields + FIELDS + end + end + end + end +end diff --git a/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context/version.rb b/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context/version.rb new file mode 100644 index 0000000000..589477a9af --- /dev/null +++ b/propagator/google_cloud_trace_context/lib/opentelemetry/propagator/google_cloud_trace_context/version.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 + # Namespace for OpenTelemetry propagator extension libraries + module Propagator + # Namespace for OpenTelemetry GoogleCloudTraceContext propagation + module GoogleCloudTraceContext + # Current gem version + VERSION = '0.0.0' + end + end +end diff --git a/propagator/google_cloud_trace_context/opentelemetry-propagator-google_cloud_trace_context.gemspec b/propagator/google_cloud_trace_context/opentelemetry-propagator-google_cloud_trace_context.gemspec new file mode 100644 index 0000000000..027c7de358 --- /dev/null +++ b/propagator/google_cloud_trace_context/opentelemetry-propagator-google_cloud_trace_context.gemspec @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +# Copyright 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/propagator/google_cloud_trace_context/version' + +Gem::Specification.new do |spec| + spec.name = 'opentelemetry-propagator-google_cloud_trace_context' + spec.version = OpenTelemetry::Propagator::GoogleCloudTraceContext::VERSION + spec.authors = ['OpenTelemetry Authors'] + spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] + + spec.summary = 'Google Cloud Trace Context Propagation Extension for the OpenTelemetry framework' + spec.description = 'Google Cloud Trace Context Propagation Extension 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 = ">= #{File.read(File.expand_path('../../gemspecs/RUBY_REQUIREMENT', __dir__))}" + + spec.add_dependency 'opentelemetry-api', '~> 1.0' + + 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/propagator/google_cloud_trace_context' + 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 + + spec.post_install_message = File.read(File.expand_path('../../gemspecs/POST_INSTALL_MESSAGE', __dir__)) +end diff --git a/propagator/google_cloud_trace_context/test/opentelemetry/propagator/ottrace/text_map_propagator_test.rb b/propagator/google_cloud_trace_context/test/opentelemetry/propagator/ottrace/text_map_propagator_test.rb new file mode 100644 index 0000000000..b7f283b1a2 --- /dev/null +++ b/propagator/google_cloud_trace_context/test/opentelemetry/propagator/ottrace/text_map_propagator_test.rb @@ -0,0 +1,238 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +describe OpenTelemetry::Propagator::GoogleCloudTraceContext::TextMapPropagator do + class FakeGetter + def get(carrier, key) + '7ffe3d75a2b8ef468ab34365ee891f08/2141054039718851918;o=0' + end + + def keys(carrier) + [] + end + end + + class FakeSetter + def set(carrier, key, value) + carrier[key] = "#{key} = #{value}" + end + end + + let(:span_id) do + 'e457b5a2e4d86bd1' + end + + let(:trace_id) do + '80f198ee56343ba864fe8b2a57d3eff7' + end + + let(:trace_flags) do + OpenTelemetry::Trace::TraceFlags::DEFAULT + end + + let(:context) do + OpenTelemetry::Trace.context_with_span( + OpenTelemetry::Trace.non_recording_span( + OpenTelemetry::Trace::SpanContext.new( + trace_id: Array(trace_id).pack('H*'), + span_id: Array(span_id).pack('H*'), + trace_flags: trace_flags + ) + ) + ) + end + + let(:propagator) do + OpenTelemetry::Propagator::GoogleCloudTraceContext::TextMapPropagator.new + end + + let(:parent_context) do + OpenTelemetry::Context.empty + end + + let(:gcp_header) do + "#{trace_id}/#{span_id.to_i(16)};o=1" + end + + let(:carrier) do + { 'x-cloud-trace-context' => gcp_header } + end + + describe '#extract' do + describe 'given an empty context' do + let(:carrier) do + {} + end + + it 'skips context extraction' do + context = propagator.extract(carrier, context: parent_context) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context.hex_trace_id).must_equal('0' * 32) + _(extracted_context.hex_span_id).must_equal('0' * 16) + _(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::DEFAULT) + _(extracted_context).wont_be(:remote?) + end + end + + describe 'given a minimal context' do + it 'extracts parent context' do + context = propagator.extract(carrier, context: parent_context) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context.hex_trace_id).must_equal(trace_id) + _(extracted_context.hex_span_id).must_equal(span_id) + _(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::SAMPLED) + _(extracted_context).must_be(:remote?) + end + end + + describe 'given a minimal context with uppercase fields' do + let(:carrier) do + { 'x-cloud-trace-context' => gcp_header.upcase } + end + + it 'extracts parent context' do + context = propagator.extract(carrier, context: parent_context) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context.hex_trace_id).must_equal(trace_id) + _(extracted_context.hex_span_id).must_equal(span_id) + _(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::SAMPLED) + _(extracted_context).must_be(:remote?) + end + end + + describe 'given a context with sampling bit set to enabled' do + it 'extracts sampled trace flag' do + context = propagator.extract(carrier, context: parent_context) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context.hex_trace_id).must_equal(trace_id) + _(extracted_context.hex_span_id).must_equal(span_id) + _(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::SAMPLED) + _(extracted_context).must_be(:remote?) + end + end + + describe 'given a context with a sampling bit set to disabled' do + let(:carrier) do + { 'x-cloud-trace-context' => "#{trace_id}/#{span_id.to_i(16)};o=0" } + end + + it 'extracts a default trace flag' do + context = propagator.extract(carrier, context: parent_context) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context.hex_trace_id).must_equal(trace_id) + _(extracted_context.hex_span_id).must_equal(span_id) + _(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::DEFAULT) + _(extracted_context).must_be(:remote?) + end + end + + describe 'given context with a malformed trace id' do + let(:carrier) do + { 'x-cloud-trace-context' => "abc123/#{span_id.to_i(16)};o=1" } + end + + it 'skips content extraction' do + context = propagator.extract(carrier, context: parent_context) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context).must_be_same_as(OpenTelemetry::Trace::SpanContext::INVALID) + end + end + + describe 'given context with a malformed span id' do + let(:carrier) do + { 'x-cloud-trace-context' => "#{trace_id}/abc123;o=1" } + end + + it 'skips content extraction' do + context = propagator.extract(carrier, context: parent_context) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context).must_be_same_as(OpenTelemetry::Trace::SpanContext::INVALID) + end + end + + describe 'given an alternative getter parameter' do + it 'will use the alternative getter instead of the constructor provided one' do + context = propagator.extract(carrier, context: parent_context, getter: FakeGetter.new) + extracted_context = OpenTelemetry::Trace.current_span(context).context + + _(extracted_context.hex_trace_id).must_equal('7ffe3d75a2b8ef468ab34365ee891f08') + _(extracted_context.hex_span_id).must_equal('1db68d4e2a5b754e') + _(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::DEFAULT) + _(extracted_context).must_be(:remote?) + end + end + end + + describe '#inject' do + describe 'when provided invalid trace ids' do + let(:trace_id) do + '0' * 32 + end + + it 'skips injecting context' do + carrier = {} + propagator.inject(carrier, context: context) + + _(carrier).must_be_empty + end + end + + describe 'when provided invalid span ids' do + let(:span_id) do + '0' * 16 + end + + it 'skips injecting context' do + carrier = {} + propagator.inject(carrier, context: context) + + _(carrier).must_be_empty + end + end + + describe 'given a minimal context' do + it 'injects OpenTracing headers' do + carrier = {} + propagator.inject(carrier, context: context) + + _(carrier.fetch('x-cloud-trace-context')).must_equal("#{trace_id}/#{span_id.to_i(16)};o=0") + end + end + + describe 'given a sampled trace flag' do + let(:trace_flags) do + OpenTelemetry::Trace::TraceFlags::SAMPLED + end + + it 'injects OpenTracing headers' do + carrier = {} + propagator.inject(carrier, context: context) + + _(carrier.fetch('x-cloud-trace-context')).must_equal("#{trace_id}/#{span_id.to_i(16)};o=1") + end + end + + describe 'given an alternative setter parameter' do + it 'will use the alternative setter instead of the constructor provided one' do + carrier = {} + + alternate_setter = FakeSetter.new + propagator.inject(carrier, context: context, setter: alternate_setter) + + _(carrier.fetch('x-cloud-trace-context')).must_equal("x-cloud-trace-context = #{trace_id}/#{span_id.to_i(16)};o=0") + end + end + end +end diff --git a/propagator/google_cloud_trace_context/test/opentelemetry/propagator/ottrace_test.rb b/propagator/google_cloud_trace_context/test/opentelemetry/propagator/ottrace_test.rb new file mode 100644 index 0000000000..10e71e4888 --- /dev/null +++ b/propagator/google_cloud_trace_context/test/opentelemetry/propagator/ottrace_test.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +describe OpenTelemetry::Propagator::GoogleCloudTraceContext do + describe '#text_map_propagator' do + it 'returns an instance of TextMapPropagator' do + propagator = OpenTelemetry::Propagator::GoogleCloudTraceContext.text_map_propagator + _(propagator).must_be_instance_of( + OpenTelemetry::Propagator::GoogleCloudTraceContext::TextMapPropagator + ) + end + end +end diff --git a/propagator/google_cloud_trace_context/test/test_helper.rb b/propagator/google_cloud_trace_context/test/test_helper.rb new file mode 100644 index 0000000000..dbf7f2c0bf --- /dev/null +++ b/propagator/google_cloud_trace_context/test/test_helper.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'simplecov' +require 'bundler/setup' +Bundler.require(:default, :development, :test) + +require 'opentelemetry-propagator-google_cloud_trace_context' +require 'minitest/autorun' + +OpenTelemetry.logger = Logger.new($stderr, level: ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym) diff --git a/release-please-config.json b/release-please-config.json index 3d9216e9df..db4312a82d 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -210,6 +210,10 @@ "package-name": "opentelemetry-propagator-xray", "version-file": "lib/opentelemetry/propagator/xray/version.rb" }, + "propagator/google_cloud_trace_context": { + "package-name": "opentelemetry-propagator-google_cloud_trace_context", + "version-file": "lib/opentelemetry/propagator/google_cloud_trace_context/version.rb" + }, "resources/azure": { "package-name": "opentelemetry-resource-detector-azure", "version-file": "lib/opentelemetry/resource/detector/azure/version.rb"