opentelemetry-sdk 0.12.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '079e4ea0a93345e6e014c3f7760425e042544ae619cf5761cb08813dac99a728'
-  data.tar.gz: f36464e88c42bd56a60060854da46daa42b35b720619201ed30e8a038ea567c7
+  metadata.gz: 0231dc6f06956325ffb14fc4a209f579001c7cc059659da14d4a4790fd07efeb
+  data.tar.gz: 676299747265e10f02eb15ffda455bfcd70155a9969e1f021804fb37c26ba768
 SHA512:
-  metadata.gz: 7305bdedc102299c04c3c0798d9137fc74919e4edd3eb37a4b239c739218274427b82f925d97cdcdebd192559033f025a6cad2f729f5d05c5856b6aa6e9e2170
-  data.tar.gz: efcd32dc9aa6c9e260b05829d790c294308e08bc7ca275647c33f54b03ac463a63da7962a9038917c6fe3571ae10dc61efaa09dfc17eb5bfae4ed040719a8c80
+  metadata.gz: ea3a1003fd132137846cbf7957da2524e21dca19d0899c9663cebbc5836bd5ce1adafe4b0ecf8f899600a94701b410534ea1eca56409da9e2dc3de658b0cb4c7
+  data.tar.gz: ee4b4487c397cee00f0d40854c3c19b7e405bfff70f145ee8520f1ceb924ac7a99cb8b15a43af30c826f59d08028345ab62535d5fef0164c89e43bd6b221d43c

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Release History: opentelemetry-sdk
 
+### 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 
+
+* 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 
+
+### v0.13.0 / 2021-01-29
+
+* 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 
+
 ### v0.12.1 / 2021-01-13
 
 * FIXED: Fix several BatchSpanProcessor errors related to fork safety 

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
 
@@ -66,8 +66,8 @@ The `opentelemetry-sdk` gem is distributed under the Apache 2.0 license. See [LI
 [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
-[examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/examples
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[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/baggage/manager.rb

@@ -22,7 +22,7 @@ module OpenTelemetry
         # @param [optional Context] context The context to update with with new
         #   modified baggage. Defaults to +Context.current+
         # @return [Context]
-        def build_context(context: Context.current)
+        def build(context: Context.current)
           builder = Builder.new(baggage_for(context).dup)
           yield builder
           context.set_value(BAGGAGE_KEY, builder.entries)

data/lib/opentelemetry/sdk/configurator.rb

@@ -15,19 +15,17 @@ module OpenTelemetry
 
       private_constant :USE_MODE_UNSPECIFIED, :USE_MODE_ONE, :USE_MODE_ALL
 
-      attr_writer :logger, :http_extractors, :http_injectors, :text_map_extractors,
-                  :text_map_injectors, :error_handler, :id_generator
+      attr_writer :logger, :extractors, :injectors, :error_handler,
+                  :id_generator
 
       def initialize
         @instrumentation_names = []
         @instrumentation_config_map = {}
-        @http_extractors = nil
-        @http_injectors = nil
-        @text_map_extractors = nil
-        @text_map_injectors = nil
+        @injectors = nil
+        @extractors = nil
         @span_processors = []
         @use_mode = USE_MODE_UNSPECIFIED
-        @resource = Resources::Resource.telemetry_sdk
+        @resource = Resources::Resource.default
         @id_generator = OpenTelemetry::Trace
       end
 
@@ -46,7 +44,7 @@ module OpenTelemetry
       #
       # @param [Resource] new_resource The resource to be merged
       def resource=(new_resource)
-        @resource = new_resource.merge(@resource)
+        @resource = @resource.merge(new_resource)
       end
 
       # Accepts a string that is merged in as the service.name resource attribute.
@@ -54,9 +52,9 @@ module OpenTelemetry
       # calls to this setter.
       # @param [String] service_name The value to be used as the service name
       def service_name=(service_name)
-        @resource = OpenTelemetry::SDK::Resources::Resource.create(
+        self.resource = OpenTelemetry::SDK::Resources::Resource.create(
           OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:name] => service_name
-        ).merge(@resource)
+        )
       end
 
       # Accepts a string that is merged in as the service.version resource attribute.
@@ -64,9 +62,9 @@ module OpenTelemetry
       # calls to this setter.
       # @param [String] service_version The value to be used as the service version
       def service_version=(service_version)
-        @resource = OpenTelemetry::SDK::Resources::Resource.create(
+        self.resource = OpenTelemetry::SDK::Resources::Resource.create(
           OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:version] => service_version
-        ).merge(@resource)
+        )
       end
 
       # Install an instrumentation with specificied optional +config+.
@@ -145,54 +143,67 @@ module OpenTelemetry
       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
-        )
+      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 configure_propagation
-        OpenTelemetry.propagation.http = create_propagator(@http_injectors || default_http_injectors,
-                                                           @http_extractors || default_http_extractors)
-        OpenTelemetry.propagation.text = create_propagator(@text_map_injectors || default_text_map_injectors,
-                                                           @text_map_extractors || default_text_map_extractors)
+      def configure_propagation # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        propagators = ENV.fetch('OTEL_PROPAGATORS', 'tracecontext,baggage').split(',')
+        injectors, extractors = propagators.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 '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::NoopInjector.new, Context::Propagation::NoopExtractor.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, extractors)
+          Context::Propagation::Propagator.new(injectors.first, extractors.first)
         end
       end
 
-      def default_http_injectors
-        default_text_map_injectors
-      end
-
-      def default_http_extractors
-        [
-          OpenTelemetry::Trace::Propagation::TraceContext.rack_extractor,
-          OpenTelemetry::Baggage::Propagation.rack_extractor
-        ]
-      end
-
-      def default_text_map_injectors
-        [
-          OpenTelemetry::Trace::Propagation::TraceContext.text_map_injector,
-          OpenTelemetry::Baggage::Propagation.text_map_injector
-        ]
+      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]
+      rescue NameError
+        OpenTelemetry.logger.warn "The #{name} propagator cannot be configured - please add opentelemetry-propagator-#{gem_suffix} to your Gemfile"
+        [nil, nil]
       end
 
-      def default_text_map_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/resources/constants.rb

@@ -67,14 +67,99 @@ module OpenTelemetry
           # The name of the cluster that the pod is running in.
           cluster_name: 'k8s.cluster.name',
 
+          # The name of the Node.
+          node_name: 'k8s.node.name',
+
+          # The UID of the Node.
+          node_uid: 'k8s.node.uid',
+
           # The name of the namespace that the pod is running in.
           namespace_name: 'k8s.namespace.name',
 
           # The name of the pod.
           pod_name: 'k8s.pod.name',
 
+          # The UID of the Pod.
+          pod_uid: 'k8s.pod.uid',
+
+          #  The name of the Container in a Pod template.
+          container_name: 'k8s.container.name',
+
+          # The UID of the ReplicaSet.
+          replicaset_uid: 'k8s.replicaset.uid',
+
+          # The name of the ReplicaSet.
+          replicaset_name: 'k8s.replicaset.name',
+
+          # The UID of the Deployment.
+          deployment_uid: 'k8s.deployment.uid',
+
           # The name of the deployment.
-          deployment_name: 'k8s.deployment.name'
+          deployment_name: 'k8s.deployment.name',
+
+          # The UID of the StatefulSet.
+          statefulset_uid: 'k8s.statefulset.uid',
+
+          # The name of the StatefulSet.
+          statefulset_name: 'k8s.statefulset.name',
+
+          # The UID of the DaemonSet.
+          daemonset_uid: 'k8s.daemonset.uid',
+
+          # The name of the DaemonSet.
+          daemonset_name: 'k8s.daemonset.name',
+
+          # The UID of the Job.
+          job_uid: 'k8s.job.uid',
+
+          # The name of the Job.
+          job_name: 'k8s.job.name',
+
+          # The UID of the CronJob.
+          cronjob_uid: 'k8s.cronjob.uid',
+
+          # The name of the CronJob.
+          cronjob_name: 'k8s.cronjob.name'
+        }.freeze
+
+        # Attributes defining an operating system process.
+        PROCESS_RESOURCE = {
+          # Process identifier (PID).
+          pid: 'process.pid',
+
+          # The name of the process executable.
+          executable_name: 'process.executable.name',
+
+          # The full path to the process executable.
+          executable_path: 'process.executable.path',
+
+          # The command used to launch the process (i.e. the command name).
+          command: 'process.command',
+
+          # The full command used to launch the process as a single string
+          # representing the full command.
+          command_line: 'process.command_line',
+
+          # All the command arguments (including the command/executable itself)
+          # as received by the process.
+          command_args: 'process.command_args',
+
+          # The username of the user that owns the process.
+          owner: 'process.owner'
+        }.freeze
+
+        # Attributes defining the single (language) runtime instance which is monitored.
+        PROCESS_RUNTIME_RESOURCE = {
+          # The name of the runtime of this process.
+          name: 'process.runtime.name',
+
+          # The version of the runtime of this process, as returned by the runtime
+          # without modification.
+          version: 'process.runtime.version',
+
+          # An additional description about the runtime of the process, for example
+          # a specific vendor customization of the runtime environment.
+          description: 'process.runtime.description'
         }.freeze
 
         # Attributes defining a computing instance (e.g. host).

data/lib/opentelemetry/sdk/resources/resource.rb

@@ -30,6 +30,10 @@ module OpenTelemetry
             new(frozen_attributes)
           end
 
+          def default
+            @default ||= create(Constants::SERVICE_RESOURCE[:name] => 'unknown_service').merge(process).merge(telemetry_sdk)
+          end
+
           def telemetry_sdk
             resource_attributes = {
               Constants::TELEMETRY_SDK_RESOURCE[:name] => 'opentelemetry',
@@ -48,6 +52,18 @@ module OpenTelemetry
             resource_attributes.delete_if { |_key, value| value.nil? || value.empty? }
             create(resource_attributes)
           end
+
+          def process
+            resource_attributes = {
+              Constants::PROCESS_RESOURCE[:pid] => Process.pid,
+              Constants::PROCESS_RESOURCE[:command] => $PROGRAM_NAME,
+              Constants::PROCESS_RUNTIME_RESOURCE[:name] => RUBY_ENGINE,
+              Constants::PROCESS_RUNTIME_RESOURCE[:version] => RUBY_VERSION,
+              Constants::PROCESS_RUNTIME_RESOURCE[:description] => RUBY_DESCRIPTION
+            }
+
+            create(resource_attributes)
+          end
         end
 
         # @api private
@@ -79,11 +95,7 @@ module OpenTelemetry
         def merge(other)
           return self unless other.is_a?(Resource)
 
-          merged_attributes = attributes.merge(other.attributes) do |_, old_v, new_v|
-            old_v.empty? ? new_v : old_v
-          end
-
-          self.class.send(:new, merged_attributes.freeze)
+          self.class.send(:new, attributes.merge(other.attributes).freeze)
         end
 
         protected

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

@@ -33,9 +33,9 @@ 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)),
-                         max_attributes_count: Integer(ENV.fetch('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 1000)),
-                         max_events_count: Integer(ENV.fetch('OTEL_SPAN_EVENT_COUNT_LIMIT', 1000)),
-                         max_links_count: Integer(ENV.fetch('OTEL_SPAN_LINK_COUNT_LIMIT', 1000)),
+                         max_attributes_count: Integer(ENV.fetch('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 128)),
+                         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?
@@ -56,13 +56,13 @@ module OpenTelemetry
           private
 
           def sampler_from_environment(default_sampler) # rubocop:disable Metrics/CyclomaticComplexity
-            case ENV['OTEL_TRACE_SAMPLER']
+            case ENV['OTEL_TRACES_SAMPLER']
             when 'always_on' then Samplers::ALWAYS_ON
             when 'always_off' then Samplers::ALWAYS_OFF
-            when 'traceidratio' then Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACE_SAMPLER_ARG', 1.0)))
+            when 'traceidratio' then Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACES_SAMPLER_ARG', 1.0)))
             when 'parentbased_always_on' then Samplers.parent_based(root: Samplers::ALWAYS_ON)
             when 'parentbased_always_off' then Samplers.parent_based(root: Samplers::ALWAYS_OFF)
-            when 'parentbased_traceidratio' then Samplers.parent_based(root: Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACE_SAMPLER_ARG', 1.0))))
+            when 'parentbased_traceidratio' then Samplers.parent_based(root: Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACES_SAMPLER_ARG', 1.0))))
             else default_sampler
             end
           rescue StandardError => e

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

@@ -19,7 +19,7 @@ module OpenTelemetry
         # All spans reported by the SDK implementation are first added to a
         # synchronized queue (with a {max_queue_size} maximum size, after the
         # size is reached spans are dropped) and exported every
-        # schedule_delay_millis to the exporter pipeline in batches of
+        # schedule_delay to the exporter pipeline in batches of
         # max_export_batch_size.
         #
         # If the queue gets half full a preemptive notification is sent to the
@@ -28,12 +28,13 @@ module OpenTelemetry
         class BatchSpanProcessor # rubocop:disable Metrics/ClassLength
           # Returns a new instance of the {BatchSpanProcessor}.
           #
-          # @param [SpanExporter] exporter
-          # @param [Numeric] exporter_timeout_millis the delay interval between two
-          #   consecutive exports. Defaults to the value of the OTEL_BSP_EXPORT_TIMEOUT_MILLIS
+          # @param [SpanExporter] exporter the (duck type) SpanExporter to where the
+          #   recorded Spans are pushed after batching.
+          # @param [Numeric] exporter_timeout the delay interval between two
+          #   consecutive exports. Defaults to the value of the OTEL_BSP_EXPORT_TIMEOUT
           #   environment variable, if set, or 30,000 (30 seconds).
-          # @param [Numeric] schedule_delay_millis the maximum allowed time to export data.
-          #   Defaults to the value of the OTEL_BSP_SCHEDULE_DELAY_MILLIS environment
+          # @param [Numeric] schedule_delay the maximum allowed time to export data.
+          #   Defaults to the value of the OTEL_BSP_SCHEDULE_DELAY environment
           #   variable, if set, or 5,000 (5 seconds).
           # @param [Integer] max_queue_size the maximum queue size in spans.
           #   Defaults to the value of the OTEL_BSP_MAX_QUEUE_SIZE environment
@@ -43,9 +44,9 @@ module OpenTelemetry
           #   variable, if set, or 512.
           #
           # @return a new instance of the {BatchSpanProcessor}.
-          def initialize(exporter:,
-                         exporter_timeout_millis: Float(ENV.fetch('OTEL_BSP_EXPORT_TIMEOUT_MILLIS', 30_000)),
-                         schedule_delay_millis: Float(ENV.fetch('OTEL_BSP_SCHEDULE_DELAY_MILLIS', 5_000)),
+          def initialize(exporter,
+                         exporter_timeout: Float(ENV.fetch('OTEL_BSP_EXPORT_TIMEOUT', 30_000)),
+                         schedule_delay: Float(ENV.fetch('OTEL_BSP_SCHEDULE_DELAY', 5_000)),
                          max_queue_size: Integer(ENV.fetch('OTEL_BSP_MAX_QUEUE_SIZE', 2048)),
                          max_export_batch_size: Integer(ENV.fetch('OTEL_BSP_MAX_EXPORT_BATCH_SIZE', 512)),
                          start_thread_on_boot: String(ENV['OTEL_RUBY_BSP_START_THREAD_ON_BOOT']) !~ /false/i,
@@ -53,12 +54,12 @@ module OpenTelemetry
             raise ArgumentError if max_export_batch_size > max_queue_size
 
             @exporter = exporter
-            @exporter_timeout_seconds = exporter_timeout_millis / 1000.0
+            @exporter_timeout_seconds = exporter_timeout / 1000.0
             @mutex = Mutex.new
             @export_mutex = Mutex.new
             @condition = ConditionVariable.new
             @keep_running = true
-            @delay_seconds = schedule_delay_millis / 1000.0
+            @delay_seconds = schedule_delay / 1000.0
             @max_queue_size = max_queue_size
             @batch_size = max_export_batch_size
             @metrics_reporter = metrics_reporter || OpenTelemetry::SDK::Trace::Export::MetricsReporter
@@ -113,7 +114,7 @@ module OpenTelemetry
               return result_code unless result_code == SUCCESS
             end
 
-            SUCCESS
+            @exporter.force_flush(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
           ensure
             # Unshift the remaining spans if we timed out. We drop excess spans from
             # the snapshot because they're older than any spans in the spans buffer.
@@ -176,6 +177,9 @@ module OpenTelemetry
             @pid = pid
             spans.clear
             @thread = restart_thread ? Thread.new { work } : nil
+          rescue ThreadError => e
+            @metrics_reporter.add_to_counter('otel.bsp.error', labels: { 'reason' => 'ThreadError' })
+            OpenTelemetry.handle_error(exception: e, message: 'unexpected error in BatchSpanProcessor#reset_on_fork')
           end
 
           def export_batch(batch, timeout: @exporter_timeout_seconds)

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

@@ -26,6 +26,10 @@ module OpenTelemetry
             SUCCESS
           end
 
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
           def shutdown(timeout: nil)
             @stopped = true
             SUCCESS

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

@@ -72,6 +72,16 @@ module OpenTelemetry
             SUCCESS
           end
 
+          # Called when {TracerProvider#force_flush} is called, if this exporter is
+          # registered to a {TracerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #

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

@@ -36,6 +36,23 @@ module OpenTelemetry
             results.uniq.max || SUCCESS
           end
 
+          # Called when {TracerProvider#force_flush} is called, if this exporter is
+          # registered to a {TracerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            start_time = Time.now
+            results = @span_exporters.map do |processor|
+              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+              return TIMEOUT if remaining_timeout&.zero?
+
+              processor.force_flush(timeout: remaining_timeout)
+            end
+            results.uniq.max || SUCCESS
+          end
+
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #

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

@@ -31,6 +31,16 @@ module OpenTelemetry
             FAILURE
           end
 
+          # Called when {TracerProvider#force_flush} is called, if this exporter is
+          # registered to a {TracerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #

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

@@ -61,7 +61,7 @@ module OpenTelemetry
           end
 
           # Export all ended spans to the configured `Exporter` that have not yet
-          # been exported.
+          # been exported, then call {Exporter#force_flush}.
           #
           # This method should only be called in cases where it is absolutely
           # necessary, such as when using some FaaS providers that may suspend
@@ -72,7 +72,7 @@ module OpenTelemetry
           # @return [Integer] SUCCESS if no error occurred, FAILURE if a
           #   non-specific failure occurred, TIMEOUT if a timeout occurred.
           def force_flush(timeout: nil)
-            SUCCESS
+            @span_exporter&.force_flush(timeout: timeout) || SUCCESS
           end
 
           # Called when {TracerProvider#shutdown} is called.

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

@@ -64,6 +64,9 @@ module OpenTelemetry
         #
         # @param [String] key
         # @param [String, Boolean, Numeric, Array<String, Numeric, Boolean>] value
+        #   Values must be non-nil and (array of) string, boolean or numeric type.
+        #   Array values must not contain nil elements and all elements must be of
+        #   the same basic type (string, numeric, boolean).
         #
         # @return [self] returns itself
         def set_attribute(key, value)
@@ -82,6 +85,34 @@ module OpenTelemetry
         end
         alias []= set_attribute
 
+        # Add attributes
+        #
+        # Note that the OpenTelemetry project
+        # {https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md
+        # documents} certain "standard attributes" that have prescribed semantic
+        # meanings.
+        #
+        # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+        #   Values must be non-nil and (array of) string, boolean or numeric type.
+        #   Array values must not contain nil elements and all elements must be of
+        #   the same basic type (string, numeric, boolean).
+        #
+        # @return [self] returns itself
+        def add_attributes(attributes)
+          super
+          @mutex.synchronize do
+            if @ended
+              OpenTelemetry.logger.warn('Calling add_attributes on an ended Span.')
+            else
+              @attributes ||= {}
+              @attributes.merge!(attributes)
+              trim_span_attributes(@attributes)
+              @total_recorded_attributes += attributes.size
+            end
+          end
+          self
+        end
+
         # Add an Event to a {Span}.
         #
         # Example:
@@ -96,7 +127,7 @@ module OpenTelemetry
         # @param [String] name Name of the event.
         # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
         #   One or more key:value pairs, where the keys must be strings and the
-        #   values may be string, boolean or numeric type.
+        #   values may be (array of) string, boolean or numeric type.
         # @param [optional Time] timestamp Optional timestamp for the event.
         #
         # @return [self] returns itself
@@ -120,15 +151,20 @@ module OpenTelemetry
         # can be recorded on a span.
         #
         # @param [Exception] exception The exception to be recorded
+        # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
+        #   attributes One or more key:value pairs, where the keys must be
+        #   strings and the values may be (array of) string, boolean or numeric
+        #   type.
         #
         # @return [void]
-        def record_exception(exception)
-          add_event('exception',
-                    attributes: {
-                      'exception.type' => exception.class.to_s,
-                      'exception.message' => exception.message,
-                      'exception.stacktrace' => exception.full_message(highlight: false, order: :top)
-                    })
+        def record_exception(exception, attributes: nil)
+          event_attributes = {
+            'exception.type' => exception.class.to_s,
+            'exception.message' => exception.message,
+            'exception.stacktrace' => exception.full_message(highlight: false, order: :top)
+          }
+          event_attributes.merge!(attributes) unless attributes.nil?
+          add_event('exception', attributes: event_attributes)
         end
 
         # Sets the Status to the Span

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

@@ -42,7 +42,7 @@ module OpenTelemetry
           @mutex.synchronize { @registry[Key.new(name, version)] ||= Tracer.new(name, version, self) }
         end
 
-        # Attempts to stop all the activity for this {Tracer}. Calls
+        # Attempts to stop all the activity for this {TracerProvider}. Calls
         # SpanProcessor#shutdown for all registered SpanProcessors.
         #
         # This operation may block until all the Spans are processed. Must be
@@ -63,12 +63,26 @@ module OpenTelemetry
           end
         end
 
-        # Adds a new SpanProcessor to this {Tracer}.
+        # Immediately export all spans that have not yet been exported for all the
+        # registered SpanProcessors.
+        #
+        # This method should only be called in cases where it is absolutely
+        # necessary, such as when using some FaaS providers that may suspend
+        # the process after an invocation, but before the `Processor` exports
+        # the completed spans.
         #
-        # Any registered processor causes overhead, consider to use an
-        # async/batch processor especially for span exporting, and export to
-        # multiple backends using the
-        # {io.opentelemetry.sdk.trace.export.MultiSpanExporter}.
+        # @param [optional Numeric] timeout An optional timeout in seconds.
+        # @return [Integer] Export::SUCCESS if no error occurred, Export::FAILURE if
+        #   a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.
+        def force_flush(timeout: nil)
+          @mutex.synchronize do
+            return Export::SUCCESS if @stopped
+
+            @active_span_processor.force_flush(timeout: timeout)
+          end
+        end
+
+        # Adds a new SpanProcessor to this {Tracer}.
         #
         # @param span_processor the new SpanProcessor to be added.
         def add_span_processor(span_processor)
@@ -78,7 +92,11 @@ module OpenTelemetry
               return
             end
             @registered_span_processors << span_processor
-            @active_span_processor = MultiSpanProcessor.new(@registered_span_processors.dup)
+            @active_span_processor = if @registered_span_processors.size == 1
+                                       span_processor
+                                     else
+                                       MultiSpanProcessor.new(@registered_span_processors.dup)
+                                     end
           end
         end
       end

data/lib/opentelemetry/sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.16.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-jaeger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -201,10 +215,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.12.1/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/sdk
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.16.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.12.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.16.0
 post_install_message: 
 rdoc_options: []
 require_paths: