opentelemetry-sdk 0.14.0 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e11789326f901d3c6e768ea1eac43f49826fd762a74e1878adaaf76d398074
-  data.tar.gz: 9431b37ace4dc00894f8aa81d89522d139120958a680141fe605a5ff73e57a66
+  metadata.gz: d43559eaa2be64a3597d078d032c168429702e47bdeaee1ac454dc5e74f9f496
+  data.tar.gz: 583f42bb1b6543d6375d3cfc8e4bd2319d5146306f42a73d726ca73f3c01e56d
 SHA512:
-  metadata.gz: 6292a201663ec6e5a7cd54560ef25855865bc77b698fd4c80a1ee4bc4109760da9f9f3e2522753c0bcc6edd11728e0222093e3759db4466b12a423544f64358a
-  data.tar.gz: 602740b9c995cc0b204b45c2923914e57ddeaa5ba809d06e1b6707c2340597a53a33d9311e349ea2ece7b7c45181ecdf4a8b2e33511aab70a08cb081f2d9b30e
+  metadata.gz: 14112a30284f0ececabcf75dda91f6634b3748c44ccec52e19c6d42e7fae59979e6ea82ef276d21ea5503d2b4f35821945b62d2b1afc83c5bcb9d4a6a9ce6bf4
+  data.tar.gz: 87aaa08db88b9495c86ee1135cdcbfb95827fbbed42edf3280500d86025ff269ee3af95c675e20231267e7b561082cea12df7738db004922468246ad437805fb

data/CHANGELOG.md

@@ -1,88 +1,154 @@
 # Release History: opentelemetry-sdk
 
+### v1.0.0.rc2 / 2021-06-23
+
+* BREAKING CHANGE: Remove optional parent_context from in_span [729](https://github.com/open-telemetry/opentelemetry-ruby/pull/729)
+* BREAKING CHANGE: Replace Time.now with Process.clock_gettime [717](https://github.com/open-telemetry/opentelemetry-ruby/pull/717)
+* BREAKING CHANGE: Refactor Baggage to remove Noop* [800](https://github.com/open-telemetry/opentelemetry-ruby/pull/800)
+* BREAKING CHANGE: Remove unnecessary readers from SDK Tracer [820](https://github.com/open-telemetry/opentelemetry-ruby/pull/820)
+  - Tracer no longer surfaces attribute readers for the name, version, or tracer_provider
+* BREAKING CHANGE: Total order constraint on span.status= [805](https://github.com/open-telemetry/opentelemetry-ruby/pull/805)
+
+* ADDED: Add Tracer.non_recording_span to API [799](https://github.com/open-telemetry/opentelemetry-ruby/pull/799)
+* ADDED: Add unnamed tracer warning message [830](https://github.com/open-telemetry/opentelemetry-ruby/pull/830)
+* ADDED: Allow disabling of install messages [831](https://github.com/open-telemetry/opentelemetry-ruby/pull/831)
+* FIXED: Rename cloud.zone to cloud.availability_zone [734](https://github.com/open-telemetry/opentelemetry-ruby/pull/734)
+* FIXED: Improve attribute error messages [742](https://github.com/open-telemetry/opentelemetry-ruby/pull/742)
+* FIXED: Support OTEL_SERVICE_NAME env var [806]https://github.com/open-telemetry/opentelemetry-ruby/pull/806
+* FIXED: Flakey tracer provider test
+
+### v1.0.0.rc1 / 2021-05-21
+
+* BREAKING CHANGE: Remove optional parent_context from in_span
+* BREAKING CHANGE: Replace Time.now with Process.clock_gettime
+
+* FIXED: Remove optional parent_context from in_span
+* FIXED: Replace Time.now with Process.clock_gettime
+* FIXED: Rename cloud.zone to cloud.availability_zone
+* FIXED: Improve attribute error messages
+
+### 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
+* BREAKING CHANGE: Implement Exporter#force_flush
+
+* ADDED: Add force_flush to SDK's TracerProvider
+* ADDED: Add k8s node to gcp resource detector
+* ADDED: Add console option for OTEL_TRACES_EXPORTER
+* ADDED: Span#add_attributes
+* ADDED: Implement Exporter#force_flush
+* FIXED: Update SDK BaggageManager to match API
+* DOCS: Replace Gitter with GitHub Discussions
+
+### v0.15.0 / 2021-02-18
+
+* BREAKING CHANGE: Streamline processor pipeline
+
+* ADDED: Add instrumentation config validation
+* FIXED: Streamline processor pipeline
+* FIXED: OTEL_TRACE -> OTEL_TRACES env vars
+* FIXED: Change limits from 1000 to 128
+* FIXED: OTEL_TRACES_EXPORTER and OTEL_PROPAGATORS
+* FIXED: Add thread error handling to the BSP
+* DOCS: Clarify nil attribute values not allowed
+
 ### v0.14.0 / 2021-02-03
 
-* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators 
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
 
-* ADDED: Replace getter and setter callables and remove rack specific propagators 
+* ADDED: Replace getter and setter callables and remove rack specific propagators
 
 ### v0.13.1 / 2021-02-01
 
-* FIXED: Leaky test 
-* FIXED: Allow env var override of service.name 
+* FIXED: Leaky test
+* FIXED: Allow env var override of service.name
 
 ### v0.13.0 / 2021-01-29
 
-* BREAKING CHANGE: Remove MILLIS from BatchSpanProcessor vars 
+* BREAKING CHANGE: Remove MILLIS from BatchSpanProcessor vars
 
-* ADDED: Process.runtime resource 
-* ADDED: Provide default resource in SDK 
-* ADDED: Add optional attributes to record_exception 
-* FIXED: Resource.merge consistency 
-* FIXED: Remove MILLIS from BatchSpanProcessor vars 
+* ADDED: Process.runtime resource
+* ADDED: Provide default resource in SDK
+* ADDED: Add optional attributes to record_exception
+* FIXED: Resource.merge consistency
+* FIXED: Remove MILLIS from BatchSpanProcessor vars
 
 ### v0.12.1 / 2021-01-13
 
-* FIXED: Fix several BatchSpanProcessor errors related to fork safety 
-* FIXED: Define default value for traceid ratio 
+* FIXED: Fix several BatchSpanProcessor errors related to fork safety
+* FIXED: Define default value for traceid ratio
 
 ### v0.12.0 / 2020-12-24
 
-* ADDED: Structured error handling 
-* ADDED: Pluggable ID generation 
-* FIXED: BSP dropped span buffer full reporting 
-* FIXED: Implement SDK environment variables 
-* FIXED: Remove incorrect TODO 
+* ADDED: Structured error handling
+* ADDED: Pluggable ID generation
+* FIXED: BSP dropped span buffer full reporting
+* FIXED: Implement SDK environment variables
+* FIXED: Remove incorrect TODO
 
 ### v0.11.1 / 2020-12-16
 
-* FIXED: BSP dropped span buffer full reporting 
+* FIXED: BSP dropped span buffer full reporting
 
 ### v0.11.0 / 2020-12-11
 
-* ADDED: Metrics reporting from trace export 
-* FIXED: Copyright comments to not reference year 
+* ADDED: Metrics reporting from trace export
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.0 / 2020-12-03
 
-* BREAKING CHANGE: Allow samplers to modify tracestate 
+* BREAKING CHANGE: Allow samplers to modify tracestate
 
-* FIXED: Allow samplers to modify tracestate 
+* FIXED: Allow samplers to modify tracestate
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Pass full Context to samplers 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Pass full Context to samplers
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Add OTEL_RUBY_BSP_START_THREAD_ON_BOOT env var 
-* ADDED: Add timeout for force_flush and shutdown 
-* FIXED: Signal at batch_size 
-* FIXED: SDK Span.recording? after finish 
-* FIXED: Pass full Context to samplers 
-* DOCS: Add documentation on usage scenarios for span processors 
+* ADDED: Add OTEL_RUBY_BSP_START_THREAD_ON_BOOT env var
+* ADDED: Add timeout for force_flush and shutdown
+* FIXED: Signal at batch_size
+* FIXED: SDK Span.recording? after finish
+* FIXED: Pass full Context to samplers
+* DOCS: Add documentation on usage scenarios for span processors
 
 ### v0.8.0 / 2020-10-27
 
-* BREAKING CHANGE: Move context/span methods to Trace module 
-* BREAKING CHANGE: Remove 'canonical' from status codes 
-* BREAKING CHANGE: Assorted SpanContext fixes 
+* BREAKING CHANGE: Move context/span methods to Trace module
+* BREAKING CHANGE: Remove 'canonical' from status codes
+* BREAKING CHANGE: Assorted SpanContext fixes
 
-* FIXED: Move context/span methods to Trace module 
-* FIXED: Remove 'canonical' from status codes 
-* FIXED: Assorted SpanContext fixes 
+* FIXED: Move context/span methods to Trace module
+* FIXED: Remove 'canonical' from status codes
+* FIXED: Assorted SpanContext fixes
 
 ### v0.7.0 / 2020-10-07
 
-* ADDED: Add service_name setter to configurator 
-* ADDED: Add service_version setter to configurator 
-* FIXED: Fork safety for batch processor 
-* FIXED: Don't generate a span ID unnecessarily 
-* DOCS: Fix Configurator#add_span_processor 
-* DOCS: Standardize toplevel docs structure and readme 
+* ADDED: Add service_name setter to configurator
+* ADDED: Add service_version setter to configurator
+* FIXED: Fork safety for batch processor
+* FIXED: Don't generate a span ID unnecessarily
+* DOCS: Fix Configurator#add_span_processor
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 
-* BREAKING CHANGE: Rename Resource labels to attributes 
+* BREAKING CHANGE: Rename Resource labels to attributes
 * BREAKING CHANGE: Export resource from Span/SpanData instead of library_resource
 * BREAKING CHANGE: Rename CorrelationContext to Baggage
 * BREAKING CHANGE: Rename Text* to TextMap* (propagators, injectors, extractors)
@@ -92,7 +158,7 @@
 
 * ADDED: Add OTLP exporter
 * ADDED: Add support for OTEL_LOG_LEVEL env var
-* FIXED: Rename Resource labels to attributes 
+* FIXED: Rename Resource labels to attributes
 * ADDED: Environment variable resource detection
 * ADDED: BatchSpanProcessor environment variable support
 * FIXED: Remove semver prefix

data/README.md

@@ -56,7 +56,7 @@ For additional examples, see the [examples on github][examples-github].
 
 The `opentelemetry-sdk` gem source is [on github][repo-github], along with related gems including `opentelemetry-api`.
 
-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].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -70,4 +70,4 @@ The `opentelemetry-sdk` gem is distributed under the Apache 2.0 license. See [LI
 [examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples
 [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
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

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
@@ -54,7 +55,7 @@ module OpenTelemetry
     #   Configure everything
     #
     #     OpenTelemetry::SDK.configure do |c|
-    #       c.logger = Logger.new('/dev/null')
+    #       c.logger = Logger.new(File::NULL)
     #       c.add_span_processor SpanProcessor.new(SomeExporter.new)
     #       c.use_all
     #     end
@@ -66,14 +67,14 @@ 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/forwarding_logger'
 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 :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
@@ -33,6 +31,15 @@ module OpenTelemetry
         @logger ||= OpenTelemetry.logger
       end
 
+      # Accepts a logger and wraps it in the {ForwardingLogger} which allows
+      # for controlling the severity level emitted by the OpenTelemetry.logger
+      # independently of the supplied logger.
+      #
+      # @param [Logger] new_logger The logger for OpenTelemetry to use
+      def logger=(new_logger)
+        @logger = ForwardingLogger.new(new_logger, level: ENV['OTEL_LOG_LEVEL'] || Logger::INFO)
+      end
+
       def error_handler
         @error_handler ||= OpenTelemetry.error_handler
       end
@@ -114,7 +121,6 @@ module OpenTelemetry
       def configure
         OpenTelemetry.logger = logger
         OpenTelemetry.error_handler = error_handler
-        OpenTelemetry.baggage = Baggage::Manager.new
         configure_propagation
         configure_span_processors
         tracer_provider.id_generator = @id_generator
@@ -125,7 +131,7 @@ module OpenTelemetry
       private
 
       def tracer_provider
-        @tracer_provider ||= Trace::TracerProvider.new(@resource)
+        @tracer_provider ||= Trace::TracerProvider.new(resource: @resource)
       end
 
       def check_use_mode!(mode)
@@ -136,48 +142,61 @@ 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
 
       def configure_span_processors
-        processors = @span_processors.empty? ? [default_span_processor] : @span_processors
+        processors = @span_processors.empty? ? [wrapped_exporter_from_env].compact : @span_processors
         processors.each { |p| tracer_provider.add_span_processor(p) }
       end
 
-      def default_span_processor
-        Trace::Export::SimpleSpanProcessor.new(
-          Trace::Export::ConsoleSpanExporter.new
-        )
-      end
-
-      def configure_propagation
-        OpenTelemetry.propagation = create_propagator(@injectors || default_injectors,
-                                                      @extractors || default_extractors)
+      def wrapped_exporter_from_env
+        exporter = ENV.fetch('OTEL_TRACES_EXPORTER', 'otlp')
+        case exporter
+        when 'none' then nil
+        when 'otlp' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::OTLP::Exporter')
+        when 'jaeger' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::Jaeger::CollectorExporter')
+        when 'zipkin' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::Zipkin::Exporter')
+        when 'console' then Trace::Export::SimpleSpanProcessor.new(Trace::Export::ConsoleSpanExporter.new)
+        else
+          OpenTelemetry.logger.warn "The #{exporter} exporter is unknown and cannot be configured, spans will not be exported"
+          nil
+        end
       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, extractors)
+      def configure_propagation # rubocop:disable Metrics/CyclomaticComplexity
+        propagators = ENV.fetch('OTEL_PROPAGATORS', 'tracecontext,baggage').split(',').uniq.collect do |propagator|
+          case propagator
+          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')
+          when 'xray' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::XRay')
+          when 'ottrace' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::OTTrace')
+          else
+            OpenTelemetry.logger.warn "The #{propagator} propagator is unknown and cannot be configured"
+            Context::Propagation::NoopTextMapPropagator.new
+          end
         end
+        OpenTelemetry.propagation = Context::Propagation::CompositeTextMapPropagator.compose_propagators((@propagators || propagators).compact)
       end
 
-      def default_injectors
-        [
-          OpenTelemetry::Trace::Propagation::TraceContext.text_map_injector,
-          OpenTelemetry::Baggage::Propagation.text_map_injector
-        ]
+      def fetch_propagator(name, class_name, gem_suffix = name)
+        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
       end
 
-      def default_extractors
-        [
-          OpenTelemetry::Trace::Propagation::TraceContext.text_map_extractor,
-          OpenTelemetry::Baggage::Propagation.text_map_extractor
-        ]
+      def fetch_exporter(name, class_name)
+        Trace::Export::BatchSpanProcessor.new(Kernel.const_get(class_name).new)
+      rescue NameError
+        OpenTelemetry.logger.warn "The #{name} exporter cannot be configured - please add opentelemetry-exporter-#{name} to your Gemfile, spans will not be exported"
+        nil
       end
     end
   end

data/lib/opentelemetry/sdk/forwarding_logger.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module OpenTelemetry
+  module SDK
+    # The ForwardingLogger provides a wrapper to control the OpenTelemetry
+    # log level, while respecting the configured level of the supplied logger.
+    # If the OTEL_LOG_LEVEL is set to debug, and the supplied logger is configured
+    # with an ERROR log level, only OpenTelemetry logs at the ERROR level or higher
+    # will be emitted.
+    class ForwardingLogger
+      def initialize(logger, level:) # rubocop:disable Metrics/CyclomaticComplexity
+        @logger = logger
+
+        if level.is_a?(Integer)
+          @level = level
+        else
+          case level.to_s.downcase
+          when 'debug'
+            @level = Logger::DEBUG
+          when 'info'
+            @level = Logger::INFO
+          when 'warn'
+            @level = Logger::WARN
+          when 'error'
+            @level = Logger::ERROR
+          when 'fatal'
+            @level = Logger::FATAL
+          when 'unknown'
+            @level = Logger::UNKNOWN
+          else
+            raise ArgumentError, "invalid log level: #{level}"
+          end
+        end
+      end
+
+      def add(severity, message = nil, progname = nil)
+        return true if severity < @level
+
+        @logger.add(severity, message, progname)
+      end
+
+      def debug(progname = nil, &block)
+        add(Logger::DEBUG, nil, progname, &block)
+      end
+
+      def info(progname = nil, &block)
+        add(Logger::INFO, nil, progname, &block)
+      end
+
+      def warn(progname = nil, &block)
+        add(Logger::WARN, nil, progname, &block)
+      end
+
+      def error(progname = nil, &block)
+        add(Logger::ERROR, nil, progname, &block)
+      end
+
+      def fatal(progname = nil, &block)
+        add(Logger::FATAL, nil, progname, &block)
+      end
+
+      def unknown(progname = nil, &block)
+        add(Logger::UNKNOWN, nil, progname, &block)
+      end
+    end
+  end
+end