opentelemetry-propagator-b3 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50e7b7f83da0eb8ed55bcada4fa252af0a62dd6402a1ac8b965a6342d2ff2cb0
+  data.tar.gz: 94c873f3082d3795760d3b05765cc01265a6592ae710948bf83019222429987d
+SHA512:
+  metadata.gz: 426bb9f47c828837f55400a190c5dc02bdedbb42da501a649c6f720e034cff03e29c27e776aa98a5b78a4cb7c744878305be8fd0bd19e499d8d0bcd239ecc58f
+  data.tar.gz: c0df4693397c7f913094ae2ae6688d03008eca621fa2d22ead9f8deaa5ea492cf85041bea41438feab14edd9fabd498103d69ba45e566294418e268a174f2eb8

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Propagator B3
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/propagator/b3/**/*.rb
+./lib/opentelemetry/propagator/b3.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Release History: opentelemetry-propagator-b3
+
+### v0.8.0 / 2020-10-27
+
+* Initial release.

data/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 2020 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.

data/README.md

@@ -0,0 +1,46 @@
+# opentelemetry-propagator-b3
+
+The `opentelemetry-propagator-b3` gem contains injectors and extractors for the
+[b3 context propagation format][b3-spec]. There are injectors and extractors for both the
+single and multi-header b3 variants. They can be in conjunction with each other
+as well injectors and extractors for other formats to support a variety of
+context propagation scenarios.
+
+## 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:
+
+```
+gem install opentelemetry-propagator-b3
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-b3` in your `Gemfile`.
+
+## How can I get involved?
+
+The `opentelemetry-propagator-b3` 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 [gitter channel][ruby-gitter] 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-b3` 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/blob/master/LICENSE
+[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
+[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[b3-spec]: https://github.com/openzipkin/b3-propagation

data/lib/opentelemetry-propagator-b3.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry-api'
+require_relative './opentelemetry/propagator/b3'

data/lib/opentelemetry/propagator/b3.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 B3 propagation
+    module B3
+      extend self
+
+      DEBUG_CONTEXT_KEY = Context.create_key('b3-debug-key')
+      private_constant :DEBUG_CONTEXT_KEY
+
+      # @api private
+      # Returns a new context with the b3 debug flag enabled
+      def context_with_debug(context)
+        context.set_value(DEBUG_CONTEXT_KEY, true)
+      end
+
+      # @api private
+      # Read the B3 debug flag from the provided context
+      def debug?(context)
+        context.value(DEBUG_CONTEXT_KEY)
+      end
+
+      # @api private
+      # Convert an id from a hex encoded string to byte array, optionally left
+      # padding to the correct length. Assumes the input id has already been
+      # validated to be 16 or 32 characters in length.
+      def to_trace_id(hex_id)
+        if hex_id.length == 32
+          Array(hex_id).pack('H*')
+        else
+          [0, hex_id].pack('qH*')
+        end
+      end
+
+      # @api private
+      # Convert an id from a hex encoded string to byte array.
+      def to_span_id(hex_id)
+        Array(hex_id).pack('H*')
+      end
+    end
+  end
+end
+
+require_relative './b3/version'
+require_relative './b3/multi'
+require_relative './b3/single'

data/lib/opentelemetry/propagator/b3/multi.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative './multi/text_map_extractor'
+require_relative './multi/text_map_injector'
+
+# 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 B3 propagation
+    module B3
+      # Namespace for OpenTelemetry b3 multi header encoding
+      module Multi
+        extend self
+
+        TEXT_MAP_EXTRACTOR = TextMapExtractor.new
+        TEXT_MAP_INJECTOR = TextMapInjector.new
+        RACK_KEYS = {
+          b3_trace_id_key: 'HTTP_X_B3_TRACEID',
+          b3_span_id_key: 'HTTP_X_B3_SPANID',
+          b3_sampled_key: 'HTTP_X_B3_SAMPLED',
+          b3_flags_key: 'HTTP_X_B3_FLAGS'
+        }.freeze
+        RACK_EXTRACTOR = TextMapExtractor.new(**RACK_KEYS)
+        RACK_INJECTOR = TextMapInjector.new(**RACK_KEYS)
+
+        private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR, :RACK_INJECTOR,
+                         :RACK_EXTRACTOR, :RACK_KEYS
+
+        # Returns an extractor that extracts context in the B3 multi header
+        # format
+        def text_map_injector
+          TEXT_MAP_INJECTOR
+        end
+
+        # Returns an injector that injects context in the B3 multi header
+        # format
+        def text_map_extractor
+          TEXT_MAP_EXTRACTOR
+        end
+
+        # Returns an extractor that extracts context in the B3 multi header
+        # format with Rack normalized keys (upcased and prefixed with
+        # HTTP_)
+        def rack_injector
+          RACK_INJECTOR
+        end
+
+        # Returns an injector that injects context in the B3 multi header
+        # format with Rack normalized keys (upcased and prefixed with
+        # HTTP_)
+        def rack_extractor
+          RACK_EXTRACTOR
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/multi/text_map_extractor.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 B3 propagation
+    module B3
+      # Namespace for OpenTelemetry b3 multi header encoding
+      module Multi
+        # Extracts context from carriers in the b3 single header format
+        class TextMapExtractor
+          include Context::Propagation::DefaultGetter
+
+          B3_TRACE_ID_REGEX = /\A(?:[0-9a-f]{16}){1,2}\z/.freeze
+          B3_SPAN_ID_REGEX = /\A[0-9a-f]{16}\z/.freeze
+          SAMPLED_VALUES = %w[1 true].freeze
+          DEBUG_FLAG = '1'
+          private_constant :B3_TRACE_ID_REGEX, :B3_SPAN_ID_REGEX, :SAMPLED_VALUES, :DEBUG_FLAG
+
+          # Returns a new TextMapExtractor that extracts b3 context using the
+          # specified header keys
+          #
+          # @param [String] b3_trace_id_key The b3 trace id key used in the carrier
+          # @param [String] b3_span_id_key The b3 span id key used in the carrier
+          # @param [String] b3_sampled_key The b3 sampled key used in the carrier
+          # @param [String] b3_flags_key The b3 flags key used in the carrier
+          # @return [TextMapExtractor]
+          def initialize(b3_trace_id_key: 'X-B3-TraceId',
+                         b3_span_id_key: 'X-B3-SpanId',
+                         b3_sampled_key: 'X-B3-Sampled',
+                         b3_flags_key: 'X-B3-Flags')
+            @b3_trace_id_key = b3_trace_id_key
+            @b3_span_id_key = b3_span_id_key
+            @b3_sampled_key = b3_sampled_key
+            @b3_flags_key = b3_flags_key
+          end
+
+          # Extract b3 context from the supplied carrier and set the active span
+          # in the given context. The original context will be returned if b3
+          # cannot be extracted from the carrier.
+          #
+          # @param [Carrier] carrier The carrier to get the header from.
+          # @param [Context] context The context to be updated with extracted context
+          # @param [optional Callable] getter An optional callable that takes a carrier and a key and
+          #   returns the value associated with the key. If omitted the default getter will be used
+          #   which expects the carrier to respond to [] and []=.
+          # @yield [Carrier, String] if an optional getter is provided, extract will yield the carrier
+          #   and the header key to the getter.
+          # @return [Context] Updated context with active span derived from the header, or the original
+          #   context if parsing fails.
+          def extract(carrier, context, &getter)
+            getter ||= default_getter
+
+            trace_id_hex = getter.call(carrier, @b3_trace_id_key)
+            return context unless valid_trace_id?(trace_id_hex)
+
+            span_id_hex = getter.call(carrier, @b3_span_id_key)
+            return context unless valid_span_id?(span_id_hex)
+
+            sampled = getter.call(carrier, @b3_sampled_key)
+            flags = getter.call(carrier, @b3_flags_key)
+
+            context = B3.context_with_debug(context) if flags == DEBUG_FLAG
+
+            span_context = Trace::SpanContext.new(
+              trace_id: B3.to_trace_id(trace_id_hex),
+              span_id: B3.to_span_id(span_id_hex),
+              trace_flags: to_trace_flags(sampled, flags),
+              remote: true
+            )
+
+            span = Trace::Span.new(span_context: span_context)
+            Trace.context_with_span(span, parent_context: context)
+          rescue OpenTelemetry::Error
+            context
+          end
+
+          private
+
+          def to_trace_flags(sampled, b3_flags)
+            if b3_flags == DEBUG_FLAG || SAMPLED_VALUES.include?(sampled)
+              Trace::TraceFlags::SAMPLED
+            else
+              Trace::TraceFlags::DEFAULT
+            end
+          end
+
+          def valid_trace_id?(trace_id)
+            B3_TRACE_ID_REGEX.match?(trace_id)
+          end
+
+          def valid_span_id?(span_id)
+            B3_SPAN_ID_REGEX.match?(span_id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/multi/text_map_injector.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+module OpenTelemetry
+  # Namespace for OpenTelemetry propagator extension libraries
+  module Propagator
+    # Namespace for OpenTelemetry B3 propagation
+    module B3
+      # Namespace for OpenTelemetry b3 single header encoding
+      module Multi
+        # Injects context into carriers using the b3 single header format
+        class TextMapInjector
+          include Context::Propagation::DefaultSetter
+
+          # Returns a new TextMapInjector that extracts b3 context using the
+          # specified header keys
+          #
+          # @param [String] b3_trace_id_key The b3 trace id key used in the carrier
+          # @param [String] b3_span_id_key The b3 span id key used in the carrier
+          # @param [String] b3_sampled_key The b3 sampled key used in the carrier
+          # @param [String] b3_flags_key The b3 flags key used in the carrier
+          # @return [TextMapInjector]
+          def initialize(b3_trace_id_key: 'X-B3-TraceId',
+                         b3_span_id_key: 'X-B3-SpanId',
+                         b3_sampled_key: 'X-B3-Sampled',
+                         b3_flags_key: 'X-B3-Flags')
+            @b3_trace_id_key = b3_trace_id_key
+            @b3_span_id_key = b3_span_id_key
+            @b3_sampled_key = b3_sampled_key
+            @b3_flags_key = b3_flags_key
+          end
+
+          # Set the span context on the supplied carrier.
+          #
+          # @param [Context] context The active Context.
+          # @param [optional Callable] setter An optional callable that takes a carrier and a key and
+          #   a value and assigns the key-value pair in the carrier. If omitted the default setter
+          #   will be used which expects the carrier to respond to [] and []=.
+          # @yield [Carrier, String, String] if an optional setter is provided, inject will yield
+          #   carrier, header key, header value to the setter.
+          # @return [Object] the carrier with context injected
+          def inject(carrier, context, &setter)
+            span_context = Trace.current_span(context).context
+            return unless span_context.valid?
+
+            setter ||= default_setter
+            setter.call(carrier, @b3_trace_id_key, span_context.hex_trace_id)
+            setter.call(carrier, @b3_span_id_key, span_context.hex_span_id)
+
+            if B3.debug?(context)
+              setter.call(carrier, @b3_flags_key, '1')
+            elsif span_context.trace_flags.sampled?
+              setter.call(carrier, @b3_sampled_key, '1')
+            else
+              setter.call(carrier, @b3_sampled_key, '0')
+            end
+
+            carrier
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/single.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative './single/text_map_extractor'
+require_relative './single/text_map_injector'
+
+# 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 B3 propagation
+    module B3
+      # Namespace for OpenTelemetry b3 single header encoding
+      module Single
+        extend self
+
+        TEXT_MAP_EXTRACTOR = TextMapExtractor.new
+        TEXT_MAP_INJECTOR = TextMapInjector.new
+        RACK_EXTRACTOR = TextMapExtractor.new(
+          b3_key: 'HTTP_B3'
+        )
+        RACK_INJECTOR = TextMapInjector.new(
+          b3_key: 'HTTP_B3'
+        )
+
+        private_constant :TEXT_MAP_INJECTOR, :TEXT_MAP_EXTRACTOR, :RACK_INJECTOR,
+                         :RACK_EXTRACTOR
+
+        # Returns an extractor that extracts context in the B3 single header
+        # format
+        def text_map_injector
+          TEXT_MAP_INJECTOR
+        end
+
+        # Returns an injector that injects context in the B3 single header
+        # format
+        def text_map_extractor
+          TEXT_MAP_EXTRACTOR
+        end
+
+        # Returns an extractor that extracts context in the B3 single header
+        # format with Rack normalized keys (upcased and prefixed with
+        # HTTP_)
+        def rack_injector
+          RACK_INJECTOR
+        end
+
+        # Returns an injector that injects context in the B3 single header
+        # format with Rack normalized keys (upcased and prefixed with
+        # HTTP_)
+        def rack_extractor
+          RACK_EXTRACTOR
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/single/text_map_extractor.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 B3 propagation
+    module B3
+      # Namespace for OpenTelemetry b3 single header encoding
+      module Single
+        # Extracts context from carriers in the b3 single header format
+        class TextMapExtractor
+          include Context::Propagation::DefaultGetter
+
+          B3_CONTEXT_REGEX = /\A(?<trace_id>(?:[0-9a-f]{16}){1,2})-(?<span_id>[0-9a-f]{16})(?:-(?<sampling_state>[01d](?![0-9a-f])))?(?:-(?<parent_span_id>[0-9a-f]{16}))?\z/.freeze
+          SAMPLED_VALUES = %w[1 d].freeze
+
+          # Returns a new TextMapExtractor that extracts b3 context using the
+          # specified header keys
+          #
+          # @param [String] b3_key The b3 header key used in the carrier
+          # @return [TextMapExtractor]
+          def initialize(b3_key: 'b3')
+            @b3_key = b3_key
+          end
+
+          # Extract b3 context from the supplied carrier and set the active span
+          # in the given context. The original context will be returned if b3
+          # cannot be extracted from the carrier.
+          #
+          # @param [Carrier] carrier The carrier to get the header from.
+          # @param [Context] context The context to be updated with extracted context
+          # @param [optional Callable] getter An optional callable that takes a carrier and a key and
+          #   returns the value associated with the key. If omitted the default getter will be used
+          #   which expects the carrier to respond to [] and []=.
+          # @yield [Carrier, String] if an optional getter is provided, extract will yield the carrier
+          #   and the header key to the getter.
+          # @return [Context] Updated context with active span derived from the header, or the original
+          #   context if parsing fails.
+          def extract(carrier, context, &getter)
+            getter ||= default_getter
+            header = getter.call(carrier, @b3_key)
+            return context unless (match = header.match(B3_CONTEXT_REGEX))
+
+            span_context = Trace::SpanContext.new(
+              trace_id: B3.to_trace_id(match['trace_id']),
+              span_id: B3.to_span_id(match['span_id']),
+              trace_flags: to_trace_flags(match['sampling_state']),
+              remote: true
+            )
+
+            span = Trace::Span.new(span_context: span_context)
+            context = B3.context_with_debug(context) if match['sampling_state'] == 'd'
+            Trace.context_with_span(span, parent_context: context)
+          rescue OpenTelemetry::Error
+            context
+          end
+
+          private
+
+          def to_trace_flags(sampling_state)
+            if SAMPLED_VALUES.include?(sampling_state)
+              Trace::TraceFlags::SAMPLED
+            else
+              Trace::TraceFlags::DEFAULT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/single/text_map_injector.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+module OpenTelemetry
+  # Namespace for OpenTelemetry propagator extension libraries
+  module Propagator
+    # Namespace for OpenTelemetry B3 propagation
+    module B3
+      # Namespace for OpenTelemetry b3 single header encoding
+      module Single
+        # Injects context into carriers using the b3 single header format
+        class TextMapInjector
+          include Context::Propagation::DefaultSetter
+
+          # Returns a new TextMapInjector that extracts b3 context using the
+          # specified header keys
+          #
+          # @param [String] b3_key The b3 header key used in the carrier
+          # @return [TextMapInjector]
+          def initialize(b3_key: 'b3')
+            @b3_key = b3_key
+          end
+
+          # Set the span context on the supplied carrier.
+          #
+          # @param [Context] context The active Context.
+          # @param [optional Callable] setter An optional callable that takes a carrier and a key and
+          #   a value and assigns the key-value pair in the carrier. If omitted the default setter
+          #   will be used which expects the carrier to respond to [] and []=.
+          # @yield [Carrier, String, String] if an optional setter is provided, inject will yield
+          #   carrier, header key, header value to the setter.
+          # @return [Object] the carrier with context injected
+          def inject(carrier, context, &setter)
+            span_context = Trace.current_span(context).context
+            return unless span_context.valid?
+
+            sampling_state = if B3.debug?(context)
+                               'd'
+                             elsif span_context.trace_flags.sampled?
+                               '1'
+                             else
+                               '0'
+                             end
+
+            b3_value = "#{span_context.hex_trace_id}-#{span_context.hex_span_id}-#{sampling_state}"
+
+            setter ||= default_setter
+            setter.call(carrier, @b3_key, b3_value)
+            carrier
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/propagator/b3/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Propagator
+    module B3
+      VERSION = '0.8.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: opentelemetry-propagator-b3
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- OpenTelemetry Authors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: B3 Context Propagation Extension for the OpenTelemetry framework
+email:
+- cncf-opentelemetry-contributors@lists.cncf.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/opentelemetry-propagator-b3.rb
+- lib/opentelemetry/propagator/b3.rb
+- lib/opentelemetry/propagator/b3/multi.rb
+- lib/opentelemetry/propagator/b3/multi/text_map_extractor.rb
+- lib/opentelemetry/propagator/b3/multi/text_map_injector.rb
+- lib/opentelemetry/propagator/b3/single.rb
+- lib/opentelemetry/propagator/b3/single/text_map_extractor.rb
+- lib/opentelemetry/propagator/b3/single/text_map_injector.rb
+- lib/opentelemetry/propagator/b3/version.rb
+homepage: https://github.com/open-telemetry/opentelemetry-ruby
+licenses:
+- Apache-2.0
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.8.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/propagator/b3
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-propagator-b3/v0.8.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: B3 Context Propagation Extension for the OpenTelemetry framework
+test_files: []