opentelemetry-sdk 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0231dc6f06956325ffb14fc4a209f579001c7cc059659da14d4a4790fd07efeb
-  data.tar.gz: 676299747265e10f02eb15ffda455bfcd70155a9969e1f021804fb37c26ba768
+  metadata.gz: 4be88dba1f3a925ceb97494267f2d27cfb24f5f89e417236d5cca698c0388b9b
+  data.tar.gz: 8e43a87d87dc739c1323acecaa18e93dac8a911fc28a119c016e5e834ca74615
 SHA512:
-  metadata.gz: ea3a1003fd132137846cbf7957da2524e21dca19d0899c9663cebbc5836bd5ce1adafe4b0ecf8f899600a94701b410534ea1eca56409da9e2dc3de658b0cb4c7
-  data.tar.gz: ee4b4487c397cee00f0d40854c3c19b7e405bfff70f145ee8520f1ceb924ac7a99cb8b15a43af30c826f59d08028345ab62535d5fef0164c89e43bd6b221d43c
+  metadata.gz: 672426fc31d0c6cce4f363509085b40bddf66d6c6516048e40ae1661fefaf2a6a3482acfe9a6dcff8db328675fb2e5ec02c9fe89d91486f551bf029bcb390f6b
+  data.tar.gz: 42b693687ddfdf1221c972d902e9249fcec6a947bb48416b4627fbd805859ac8bc5fcdb18ac44e4fb628bfd56f67bf42d028465f6e34c4c679844a7c1027515d

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release History: opentelemetry-sdk
 
+### v0.17.0 / 2021-04-22
+
+* BREAKING CHANGE: Replace TextMapInjector/TextMapExtractor pairs with a TextMapPropagator.
+
+  [Check the propagator documentation](https://open-telemetry.github.io/opentelemetry-ruby/) for the new usage.
+
+* ADDED: Add zipkin exporter 
+* ADDED: Processors validate exporters on init. 
+* ADDED: Add configurable truncation of span and event attribute values  
+* ADDED: Add simple 'recording' attr_accessor to InMemorySpanExporter 
+* FIXED: Typo in error message 
+* FIXED: Improve configuration error reporting 
+* FIXED: Refactor propagators to add #fields 
+
 ### v0.16.0 / 2021-03-17
 
 * BREAKING CHANGE: Update SDK BaggageManager to match API 

data/lib/opentelemetry/sdk.rb

@@ -6,6 +6,7 @@
 
 require 'opentelemetry'
 require 'opentelemetry/common'
+require 'opentelemetry-instrumentation-base'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation
@@ -66,14 +67,13 @@ module OpenTelemetry
       begin
         raise ConfigurationError
       rescue ConfigurationError => e
-        OpenTelemetry.handle_error(exception: e, message: 'unexpected configuration error')
+        OpenTelemetry.handle_error(exception: e, message: "unexpected configuration error due to #{e.cause}")
       end
     end
   end
 end
 
 require 'opentelemetry/sdk/configurator'
-require 'opentelemetry/sdk/baggage'
 require 'opentelemetry/sdk/internal'
 require 'opentelemetry/sdk/instrumentation_library'
 require 'opentelemetry/sdk/resources'

data/lib/opentelemetry/sdk/configurator.rb

@@ -15,14 +15,12 @@ module OpenTelemetry
 
       private_constant :USE_MODE_UNSPECIFIED, :USE_MODE_ONE, :USE_MODE_ALL
 
-      attr_writer :logger, :extractors, :injectors, :error_handler,
-                  :id_generator
+      attr_writer :logger, :propagators, :error_handler, :id_generator
 
       def initialize
         @instrumentation_names = []
         @instrumentation_config_map = {}
-        @injectors = nil
-        @extractors = nil
+        @propagators = nil
         @span_processors = []
         @use_mode = USE_MODE_UNSPECIFIED
         @resource = Resources::Resource.default
@@ -136,9 +134,9 @@ module OpenTelemetry
       def install_instrumentation
         case @use_mode
         when USE_MODE_ONE
-          OpenTelemetry.instrumentation_registry.install(@instrumentation_names, @instrumentation_config_map)
+          OpenTelemetry::Instrumentation.registry.install(@instrumentation_names, @instrumentation_config_map)
         when USE_MODE_ALL
-          OpenTelemetry.instrumentation_registry.install_all(@instrumentation_config_map)
+          OpenTelemetry::Instrumentation.registry.install_all(@instrumentation_config_map)
         end
       end
 
@@ -161,14 +159,11 @@ module OpenTelemetry
         end
       end
 
-      def configure_propagation # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-        propagators = ENV.fetch('OTEL_PROPAGATORS', 'tracecontext,baggage').split(',')
-        injectors, extractors = propagators.uniq.collect do |propagator|
+      def configure_propagation # rubocop:disable Metrics/CyclomaticComplexity
+        propagators = ENV.fetch('OTEL_PROPAGATORS', 'tracecontext,baggage').split(',').uniq.collect do |propagator|
           case propagator
-          when 'tracecontext'
-            [OpenTelemetry::Trace::Propagation::TraceContext.text_map_injector, OpenTelemetry::Trace::Propagation::TraceContext.text_map_extractor]
-          when 'baggage'
-            [OpenTelemetry::Baggage::Propagation.text_map_injector, OpenTelemetry::Baggage::Propagation.text_map_extractor]
+          when 'tracecontext' then OpenTelemetry::Trace::Propagation::TraceContext.text_map_propagator
+          when 'baggage' then OpenTelemetry::Baggage::Propagation.text_map_propagator
           when 'b3' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::B3::Single')
           when 'b3multi' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::B3::Multi', 'b3')
           when 'jaeger' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::Jaeger')
@@ -176,27 +171,17 @@ module OpenTelemetry
           when 'ottrace' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::OTTrace')
           else
             OpenTelemetry.logger.warn "The #{propagator} propagator is unknown and cannot be configured"
-            [Context::Propagation::NoopInjector.new, Context::Propagation::NoopExtractor.new]
+            Context::Propagation::NoopTextMapPropagator.new
           end
-        end.transpose
-        OpenTelemetry.propagation = create_propagator(@injectors || injectors.compact,
-                                                      @extractors || extractors.compact)
-      end
-
-      def create_propagator(injectors, extractors)
-        if injectors.size > 1 || extractors.size > 1
-          Context::Propagation::CompositePropagator.new(injectors, extractors)
-        else
-          Context::Propagation::Propagator.new(injectors.first, extractors.first)
         end
+        OpenTelemetry.propagation = Context::Propagation::CompositeTextMapPropagator.compose_propagators((@propagators || propagators).compact)
       end
 
       def fetch_propagator(name, class_name, gem_suffix = name)
-        propagator_class = Kernel.const_get(class_name)
-        [propagator_class.text_map_injector, propagator_class.text_map_extractor]
+        Kernel.const_get(class_name).text_map_propagator
       rescue NameError
         OpenTelemetry.logger.warn "The #{name} propagator cannot be configured - please add opentelemetry-propagator-#{gem_suffix} to your Gemfile"
-        [nil, nil]
+        nil
       end
 
       def fetch_exporter(name, class_name)

data/lib/opentelemetry/sdk/internal.rb

@@ -47,7 +47,7 @@ module OpenTelemetry
       def valid_attributes?(attrs)
         attrs.nil? || attrs.all? do |k, v|
           if !valid_key?(k)
-            OpenTelemetry.handle_error(message: "invalid attribute key type #{v.class}")
+            OpenTelemetry.handle_error(message: "invalid attribute key type #{k.class}")
             false
           elsif !valid_value?(v)
             OpenTelemetry.handle_error(message: "invalid attribute value type #{v.class}")

data/lib/opentelemetry/sdk/trace/config/trace_config.rb

@@ -16,6 +16,9 @@ module OpenTelemetry
           # The global default max number of attributes per {Span}.
           attr_reader :max_attributes_count
 
+          # The global default max length of attribute value per {Span}.
+          attr_reader :max_attributes_length
+
           # The global default max number of {OpenTelemetry::SDK::Trace::Event}s per {Span}.
           attr_reader :max_events_count
 
@@ -32,13 +35,15 @@ module OpenTelemetry
           #
           # @return [TraceConfig] with the desired values.
           # @raise [ArgumentError] if any of the max numbers are not positive.
-          def initialize(sampler: sampler_from_environment(Samplers.parent_based(root: Samplers::ALWAYS_ON)),
+          def initialize(sampler: sampler_from_environment(Samplers.parent_based(root: Samplers::ALWAYS_ON)), # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
                          max_attributes_count: Integer(ENV.fetch('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 128)),
+                         max_attributes_length: ENV['OTEL_RUBY_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT'],
                          max_events_count: Integer(ENV.fetch('OTEL_SPAN_EVENT_COUNT_LIMIT', 128)),
                          max_links_count: Integer(ENV.fetch('OTEL_SPAN_LINK_COUNT_LIMIT', 128)),
                          max_attributes_per_event: max_attributes_count,
                          max_attributes_per_link: max_attributes_count)
             raise ArgumentError, 'max_attributes_count must be positive' unless max_attributes_count.positive?
+            raise ArgumentError, 'max_attributes_length must not be less than 32' unless max_attributes_length.nil? || Integer(max_attributes_length) >= 32
             raise ArgumentError, 'max_events_count must be positive' unless max_events_count.positive?
             raise ArgumentError, 'max_links_count must be positive' unless max_links_count.positive?
             raise ArgumentError, 'max_attributes_per_event must be positive' unless max_attributes_per_event.positive?
@@ -46,6 +51,7 @@ module OpenTelemetry
 
             @sampler = sampler
             @max_attributes_count = max_attributes_count
+            @max_attributes_length = max_attributes_length.nil? ? nil : Integer(max_attributes_length)
             @max_events_count = max_events_count
             @max_links_count = max_links_count
             @max_attributes_per_event = max_attributes_per_event

data/lib/opentelemetry/sdk/trace/export/batch_span_processor.rb

@@ -52,6 +52,7 @@ module OpenTelemetry
                          start_thread_on_boot: String(ENV['OTEL_RUBY_BSP_START_THREAD_ON_BOOT']) !~ /false/i,
                          metrics_reporter: nil)
             raise ArgumentError if max_export_batch_size > max_queue_size
+            raise ArgumentError, "exporter #{exporter.inspect} does not appear to be a valid exporter" unless Common::Utilities.valid_exporter?(exporter)
 
             @exporter = exporter
             @exporter_timeout_seconds = exporter_timeout / 1000.0

data/lib/opentelemetry/sdk/trace/export/in_memory_span_exporter.rb

@@ -10,30 +10,39 @@ module OpenTelemetry
       module Export
         # A SpanExporter implementation that can be used to test OpenTelemetry integration.
         #
-        # Example usage:
+        # Example usage in a test suite:
         #
         # class MyClassTest
         #   def setup
         #     @tracer_provider = TracerProvider.new
-        #     @exporter = InMemorySpanExporter.new
+        #     # The default is `recording: true`, which is appropriate in non-test environments.
+        #     @exporter = InMemorySpanExporter.new(recording: false)
         #     @tracer_provider.add_span_processor(SimpleSampledSpansProcessor.new(@exporter))
         #   end
         #
         #   def test_finished_spans
+        #     @exporter.recording = true
         #     @tracer_provider.tracer.in_span("span") {}
         #
         #     spans = @exporter.finished_spans
         #     spans.wont_be_nil
         #     spans.size.must_equal(1)
         #     spans[0].name.must_equal("span")
+        #
+        #     @exporter.recording = false
         #   end
         class InMemorySpanExporter
+          # Controls whether or not the exporter will record spans, or discard them.
+          # @return [Boolean] when true, the exporter is recording. By default, this is true.
+          attr_accessor :recording
+
           # Returns a new instance of the {InMemorySpanExporter}.
           #
           # @return a new instance of the {InMemorySpanExporter}.
-          def initialize
+          def initialize(recording: true)
             @finished_spans = []
             @stopped = false
+            @recording = recording
             @mutex = Mutex.new
           end
 
@@ -67,7 +76,7 @@ module OpenTelemetry
             @mutex.synchronize do
               return FAILURE if @stopped
 
-              @finished_spans.concat(span_datas.to_a)
+              @finished_spans.concat(span_datas.to_a) if @recording
             end
             SUCCESS
           end

data/lib/opentelemetry/sdk/trace/export/simple_span_processor.rb

@@ -29,6 +29,8 @@ module OpenTelemetry
           # @return [SimpleSpanProcessor]
           # @raise ArgumentError if the span_exporter is nil.
           def initialize(span_exporter)
+            raise ArgumentError, "exporter #{span_exporter.inspect} does not appear to be a valid exporter" unless Common::Utilities.valid_exporter?(span_exporter)
+
             @span_exporter = span_exporter
           end
 

data/lib/opentelemetry/sdk/trace/span.rb

@@ -133,7 +133,7 @@ module OpenTelemetry
         # @return [self] returns itself
         def add_event(name, attributes: nil, timestamp: nil)
           super
-          event = Event.new(name: name, attributes: attributes, timestamp: timestamp || Time.now)
+          event = Event.new(name: name, attributes: truncate_attribute_values(attributes), timestamp: timestamp || Time.now)
 
           @mutex.synchronize do
             if @ended
@@ -316,9 +316,18 @@ module OpenTelemetry
 
           excess = attrs.size - @trace_config.max_attributes_count
           excess.times { attrs.shift } if excess.positive?
+          truncate_attribute_values(attrs)
           nil
         end
 
+        def truncate_attribute_values(attrs)
+          return if attrs.nil?
+
+          max_attributes_length = @trace_config.max_attributes_length
+          attrs.each { |key, value| attrs[key] = OpenTelemetry::Common::Utilities.truncate(value, max_attributes_length) } if max_attributes_length
+          attrs
+        end
+
         def trim_links(links, max_links_count, max_attributes_per_link) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           # Fast path (likely) common cases.
           return nil if links.nil?

data/lib/opentelemetry/sdk/version.rb

@@ -7,6 +7,6 @@
 module OpenTelemetry
   module SDK
     ## Current OpenTelemetry version
-    VERSION = '0.16.0'
+    VERSION = '0.17.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -177,9 +191,6 @@ files:
 - README.md
 - lib/opentelemetry-sdk.rb
 - lib/opentelemetry/sdk.rb
-- lib/opentelemetry/sdk/baggage.rb
-- lib/opentelemetry/sdk/baggage/builder.rb
-- lib/opentelemetry/sdk/baggage/manager.rb
 - lib/opentelemetry/sdk/configurator.rb
 - lib/opentelemetry/sdk/instrumentation_library.rb
 - lib/opentelemetry/sdk/internal.rb
@@ -215,10 +226,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.16.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.17.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.16.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.17.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -234,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A stats collection and distributed tracing framework

data/lib/opentelemetry/sdk/baggage.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-require 'opentelemetry/sdk/baggage/builder'
-require 'opentelemetry/sdk/baggage/manager'
-
-module OpenTelemetry
-  module SDK
-    # Contains operational implementations of the Baggage::Manager
-    module Baggage
-    end
-  end
-end

data/lib/opentelemetry/sdk/baggage/builder.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Baggage
-      # SDK implementation of Baggage::Builder
-      class Builder
-        attr_reader :entries
-
-        def initialize(entries)
-          @entries = entries
-        end
-
-        # Set key-value in the to-be-created baggage
-        #
-        # @param [String] key The key to store this value under
-        # @param [String] value String value to be stored under key
-        def set_value(key, value)
-          @entries[key] = value.to_s
-        end
-
-        # Removes key from the to-be-created baggage
-        #
-        # @param [String] key The key to remove
-        def remove_value(key)
-          @entries.delete(key)
-        end
-
-        # Clears all baggage from the to-be-created baggage
-        def clear
-          @entries.clear
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/sdk/baggage/manager.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Baggage
-      # Manages baggage
-      class Manager
-        BAGGAGE_KEY = OpenTelemetry::Baggage::Propagation::ContextKeys.baggage_key
-        EMPTY_BAGGAGE = {}.freeze
-        private_constant(:BAGGAGE_KEY, :EMPTY_BAGGAGE)
-
-        # Used to chain modifications to baggage. The result is a
-        # context with an updated baggage. If only a single
-        # modification is being made to baggage, use the other
-        # methods on +Manager+, if multiple modifications are being made, use
-        # this one.
-        #
-        # @param [optional Context] context The context to update with with new
-        #   modified baggage. Defaults to +Context.current+
-        # @return [Context]
-        def build(context: Context.current)
-          builder = Builder.new(baggage_for(context).dup)
-          yield builder
-          context.set_value(BAGGAGE_KEY, builder.entries)
-        end
-
-        # Returns a new context with empty baggage
-        #
-        # @param [optional Context] context Context to clear baggage from. Defaults
-        #   to +Context.current+
-        # @return [Context]
-        def clear(context: Context.current)
-          context.set_value(BAGGAGE_KEY, EMPTY_BAGGAGE)
-        end
-
-        # Returns the corresponding baggage value (or nil) for key
-        #
-        # @param [String] key The lookup key
-        # @param [optional Context] context The context from which to retrieve
-        #   the key.
-        #   Defaults to +Context.current+
-        # @return [String]
-        def value(key, context: Context.current)
-          baggage_for(context)[key]
-        end
-
-        # Returns the baggage
-        #
-        # @param [optional Context] context The context from which to retrieve
-        #   the baggage.
-        #   Defaults to +Context.current+
-        # @return [Hash]
-        def values(context: Context.current)
-          baggage_for(context).dup.freeze
-        end
-
-        # Returns a new context with new key-value pair
-        #
-        # @param [String] key The key to store this value under
-        # @param [String] value String value to be stored under key
-        # @param [optional Context] context The context to update with new
-        #   value. Defaults to +Context.current+
-        # @return [Context]
-        def set_value(key, value, context: Context.current)
-          new_baggage = baggage_for(context).dup
-          new_baggage[key] = value
-          context.set_value(BAGGAGE_KEY, new_baggage)
-        end
-
-        # Returns a new context with value at key removed
-        #
-        # @param [String] key The key to remove
-        # @param [optional Context] context The context to remove baggage
-        #   from. Defaults to +Context.current+
-        # @return [Context]
-        def remove_value(key, context: Context.current)
-          baggage = baggage_for(context)
-          return context unless baggage.key?(key)
-
-          new_baggage = baggage.dup
-          new_baggage.delete(key)
-          context.set_value(BAGGAGE_KEY, new_baggage)
-        end
-
-        private
-
-        def baggage_for(context)
-          context.value(BAGGAGE_KEY) || EMPTY_BAGGAGE
-        end
-      end
-    end
-  end
-end