opentelemetry-sdk 0.13.1 → 1.0.0.rc1

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

@@ -10,24 +10,24 @@ module OpenTelemetry
     # implementation.
     module Trace
       # SpanData is a Struct containing {Span} data for export.
-      SpanData = Struct.new(:name,
-                            :kind,
-                            :status,
-                            :parent_span_id,
-                            :total_recorded_attributes,
-                            :total_recorded_events,
-                            :total_recorded_links,
-                            :start_timestamp,
-                            :end_timestamp,
-                            :attributes,
-                            :links,
-                            :events,
-                            :resource,
-                            :instrumentation_library,
-                            :span_id,
-                            :trace_id,
-                            :trace_flags,
-                            :tracestate) do
+      SpanData = Struct.new(:name,                      # String
+                            :kind,                      # Symbol: :internal, :producer, :consumer, :client, :server
+                            :status,                    # Status
+                            :parent_span_id,            # String (8 byte binary), may be OpenTelemetry::Trace::INVALID_SPAN_ID
+                            :total_recorded_attributes, # Integer
+                            :total_recorded_events,     # Integer
+                            :total_recorded_links,      # Integer
+                            :start_timestamp,           # Integer nanoseconds since Epoch
+                            :end_timestamp,             # Integer nanoseconds since Epoch
+                            :attributes,                # optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}
+                            :links,                     # optional Array[OpenTelemetry::Trace::Link]
+                            :events,                    # optional Array[Event]
+                            :resource,                  # OpenTelemetry::SDK::Resources::Resource
+                            :instrumentation_library,   # OpenTelemetry::SDK::InstrumentationLibrary
+                            :span_id,                   # String (8 byte binary)
+                            :trace_id,                  # String (16-byte binary)
+                            :trace_flags,               # Integer (8-bit byte of bit flags)
+                            :tracestate) do             # OpenTelemetry::Trace::Tracestate
                               # Returns the lowercase [hex encoded](https://tools.ietf.org/html/rfc4648#section-8) span ID.
                               #
                               # @return [String] A 16-hex-character lowercase string.
@@ -41,6 +41,13 @@ module OpenTelemetry
                               def hex_trace_id
                                 trace_id.unpack1('H*')
                               end
+
+                              # Returns the lowercase [hex encoded](https://tools.ietf.org/html/rfc4648#section-8) parent span ID.
+                              #
+                              # @return [String] A 16-hex-character lowercase string.
+                              def hex_parent_span_id
+                                parent_span_id.unpack1('H*')
+                              end
                             end
     end
   end

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

@@ -66,7 +66,7 @@ module OpenTelemetry
               tracer_provider.active_span_processor,
               attributes,
               links,
-              start_timestamp || Time.now,
+              start_timestamp,
               tracer_provider.resource,
               @instrumentation_library
             )

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.13.1'
+    VERSION = '1.0.0.rc1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-05-21 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.13.0
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,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.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -163,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
@@ -201,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.13.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.0.0.rc1/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.13.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.0.0.rc1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -216,11 +241,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 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: 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