Contents

# frozen_string_literal: true

# Copyright 2019 OpenTelemetry Authors
#
# SPDX-License-Identifier: Apache-2.0

require 'cgi'

module OpenTelemetry
  module CorrelationContext
    module Propagation
      # Injects correlation context using the W3C Correlation Context format
      class TextInjector
        include Context::Propagation::DefaultSetter

        # Returns a new TextInjector that injects context using the specified
        # header key
        #
        # @param [String] correlation_context_header_key The correlation context header
        #   key used in the carrier
        # @return [TextInjector]
        def initialize(correlation_context_key: 'Correlation-Context')
          @correlation_context_key = correlation_context_key
        end

        # Inject in-process correlations into the supplied carrier.
        #
        # @param [Carrier] carrier The carrier to inject correlations into
        # @param [Context] context The context to read correlations from
        # @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, inject will yield the carrier
        #   and the header key to the getter.
        # @return [Object] carrier with injected correlations
        def inject(carrier, context, &setter)
          return carrier unless (correlations = context[ContextKeys.correlation_context_key]) && !correlations.empty?

          setter ||= default_setter
          setter.call(carrier, @correlation_context_key, encode(correlations))

          carrier
        end

        private

        def encode(correlations)
          correlations.inject(+'') do |memo, (k, v)|
            memo << CGI.escape(k.to_s) << '=' << CGI.escape(v.to_s) << ','
          end.chop!
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
opentelemetry-api-0.4.0	lib/opentelemetry/correlation_context/propagation/text_injector.rb
opentelemetry-api-0.3.0	lib/opentelemetry/correlation_context/propagation/text_injector.rb