opentelemetry-sdk 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1929c4e29a936b51b4f2eca8ec7b4e2f7a597e43e72039e6e963aa72cd00f65f
-  data.tar.gz: cbf9a0ade97c3dab0a8005cf84729ab8d549c6f0768ea9446d8a71585d676d4f
+  metadata.gz: 92bb8c4a7792c37eb367fc10a3093b3fe27339592bc8689cdac308f21ba8ffa7
+  data.tar.gz: 2a0b6df150bbf2cb0987d1d4e5aa29fb37323bb740786ee2171e3ae037ff60ac
 SHA512:
-  metadata.gz: de2f88ace625de9e494a6800291462330c58d12e0ecac2e8a7a184a8c34382557639aea59eea3dbf16a603355c604446e00cd2b9fe8f2ad3cb009f21c68186cb
-  data.tar.gz: 42342b8cee795fd241a650b2abae0b8f3f4f73a202605bdcce6ec861de5fe53325fc3e273fe8c06e386df4b42a76ab3d0667990a502f31a0636de733f62b2aef
+  metadata.gz: 59acf74f4d8cd4d4b1b7206690b6b0ddff389e98a76d151eb3cc08b97168af5c876a67a537123d81f2a3c7e65e3d52aea07f502bff02b7f8736863c8d299587e
+  data.tar.gz: b99ebe6b214387d35d530d01d154f017cb5ae9ea11f6922773c12d1b2fa2807a1051d5d3f021816ad6970d152794ccb1b2e9af37c46b5fde768d4c8574d8833b

data/.yardopts

@@ -1,9 +1,9 @@
 --no-private
 --title=OpenTelemetry SDK
 --markup=markdown
---main=OVERVIEW.md
+--main=README.md
 ./lib/opentelemetry/sdk/**/*.rb
 ./lib/opentelemetry/sdk.rb
 -
-OVERVIEW.md
+README.md
 CHANGELOG.md

data/CHANGELOG.md

@@ -1 +1,55 @@
 # Release History: opentelemetry-sdk
+
+### v0.9.0 / 2020-11-27
+
+* 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 
+
+### 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 
+
+* 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 
+
+### v0.6.0 / 2020-09-10
+
+* 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)
+* BREAKING CHANGE: Rename span.record_error to span.record_exception
+* BREAKING CHANGE: Update samplers to match spec
+* BREAKING CHANGE: Remove support for lazy event creation
+
+* ADDED: Add OTLP exporter
+* ADDED: Add support for OTEL_LOG_LEVEL env var
+* FIXED: Rename Resource labels to attributes 
+* ADDED: Environment variable resource detection
+* ADDED: BatchSpanProcessor environment variable support
+* FIXED: Remove semver prefix
+* FIXED: Docs for array valued attributes
+* ADDED: Add hex_trace_id and hex_span_id helpers to SpanData
+* FIXED: Fix ProbabilitySampler
+* ADDED: Implement GetCorrelations
+* FIXED: Change default Sampler to ParentOrElse(AlwaysOn)
+* FIXED: Fix probability sampler

data/README.md

@@ -41,7 +41,7 @@ tracer.in_span('foo') do |span|
   # set an attribute
   span.set_attribute('platform', 'osx')
   # add an event
-  span.add_event(name: 'event in bar')
+  span.add_event('event in bar')
   # create bar as child of foo
   tracer.in_span('bar') do |child_span|
     # inspect the span

data/lib/opentelemetry/sdk.rb

@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry/common'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation
@@ -61,7 +62,7 @@ module OpenTelemetry
 end
 
 require 'opentelemetry/sdk/configurator'
-require 'opentelemetry/sdk/correlation_context'
+require 'opentelemetry/sdk/baggage'
 require 'opentelemetry/sdk/internal'
 require 'opentelemetry/sdk/instrumentation_library'
 require 'opentelemetry/sdk/resources'

data/lib/opentelemetry/sdk/baggage.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright 2019 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/{correlation_context → baggage}/builder.rb

@@ -6,8 +6,8 @@
 
 module OpenTelemetry
   module SDK
-    module CorrelationContext
-      # SDK implementation of CorrelationContext::Builder
+    module Baggage
+      # SDK implementation of Baggage::Builder
       class Builder
         attr_reader :entries
 
@@ -15,7 +15,7 @@ module OpenTelemetry
           @entries = entries
         end
 
-        # Set key-value in the to-be-created correlation context
+        # 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
@@ -23,14 +23,14 @@ module OpenTelemetry
           @entries[key] = value.to_s
         end
 
-        # Removes key from the to-be-created correlation context
+        # 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 correlations from the to-be-created correlation context
+        # Clears all baggage from the to-be-created baggage
         def clear
           @entries.clear
         end

data/lib/opentelemetry/sdk/{correlation_context → baggage}/manager.rb

@@ -6,38 +6,38 @@
 
 module OpenTelemetry
   module SDK
-    module CorrelationContext
-      # Manages correlation context
+    module Baggage
+      # Manages baggage
       class Manager
-        CORRELATION_CONTEXT_KEY = OpenTelemetry::CorrelationContext::Propagation::ContextKeys.correlation_context_key
-        EMPTY_CORRELATION_CONTEXT = {}.freeze
-        private_constant(:CORRELATION_CONTEXT_KEY, :EMPTY_CORRELATION_CONTEXT)
+        BAGGAGE_KEY = OpenTelemetry::Baggage::Propagation::ContextKeys.baggage_key
+        EMPTY_BAGGAGE = {}.freeze
+        private_constant(:BAGGAGE_KEY, :EMPTY_BAGGAGE)
 
-        # Used to chain modifications to correlation context. The result is a
-        # context with an updated correlation context. If only a single
-        # modification is being made to correlation context, use the other
+        # 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 correlation context. Defaults to +Context.current+
+        #   modified baggage. Defaults to +Context.current+
         # @return [Context]
         def build_context(context: Context.current)
-          builder = Builder.new(correlations_for(context).dup)
+          builder = Builder.new(baggage_for(context).dup)
           yield builder
-          context.set_value(CORRELATION_CONTEXT_KEY, builder.entries)
+          context.set_value(BAGGAGE_KEY, builder.entries)
         end
 
-        # Returns a new context with empty correlations
+        # Returns a new context with empty baggage
         #
-        # @param [optional Context] context Context to clear correlations from. Defaults
+        # @param [optional Context] context Context to clear baggage from. Defaults
         #   to +Context.current+
         # @return [Context]
         def clear(context: Context.current)
-          context.set_value(CORRELATION_CONTEXT_KEY, EMPTY_CORRELATION_CONTEXT)
+          context.set_value(BAGGAGE_KEY, EMPTY_BAGGAGE)
         end
 
-        # Returns the corresponding correlation value (or nil) for key
+        # 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
@@ -45,7 +45,17 @@ module OpenTelemetry
         #   Defaults to +Context.current+
         # @return [String]
         def value(key, context: Context.current)
-          correlations_for(context)[key]
+          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
@@ -56,30 +66,30 @@ module OpenTelemetry
         #   value. Defaults to +Context.current+
         # @return [Context]
         def set_value(key, value, context: Context.current)
-          new_correlations = correlations_for(context).dup
-          new_correlations[key] = value
-          context.set_value(CORRELATION_CONTEXT_KEY, new_correlations)
+          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 correlation
+        # @param [optional Context] context The context to remove baggage
         #   from. Defaults to +Context.current+
         # @return [Context]
         def remove_value(key, context: Context.current)
-          correlations = correlations_for(context)
-          return context unless correlations.key?(key)
+          baggage = baggage_for(context)
+          return context unless baggage.key?(key)
 
-          new_correlations = correlations.dup
-          new_correlations.delete(key)
-          context.set_value(CORRELATION_CONTEXT_KEY, new_correlations)
+          new_baggage = baggage.dup
+          new_baggage.delete(key)
+          context.set_value(BAGGAGE_KEY, new_baggage)
         end
 
         private
 
-        def correlations_for(context)
-          context.value(CORRELATION_CONTEXT_KEY) || EMPTY_CORRELATION_CONTEXT
+        def baggage_for(context)
+          context.value(BAGGAGE_KEY) || EMPTY_BAGGAGE
         end
       end
     end

data/lib/opentelemetry/sdk/configurator.rb

@@ -15,32 +15,53 @@ module OpenTelemetry
 
       private_constant :USE_MODE_UNSPECIFIED, :USE_MODE_ONE, :USE_MODE_ALL
 
-      attr_writer :logger, :http_extractors, :http_injectors, :text_extractors,
-                  :text_injectors
+      attr_writer :logger, :http_extractors, :http_injectors, :text_map_extractors,
+                  :text_map_injectors
 
       def initialize
         @instrumentation_names = []
         @instrumentation_config_map = {}
         @http_extractors = nil
         @http_injectors = nil
-        @text_extractors = nil
-        @text_injectors = nil
+        @text_map_extractors = nil
+        @text_map_injectors = nil
         @span_processors = []
         @use_mode = USE_MODE_UNSPECIFIED
         @resource = Resources::Resource.telemetry_sdk
       end
 
       def logger
-        @logger ||= Logger.new(STDOUT)
+        @logger ||= OpenTelemetry.logger
       end
 
       # Accepts a resource object that is merged with the default telemetry sdk
       # resource. The use of this method is optional, and is provided as means
-      # to add additional resource information.
+      # to include additional resource information.
+      # If a resource key collision occurs the passed in resource takes priority.
       #
       # @param [Resource] new_resource The resource to be merged
       def resource=(new_resource)
-        @resource = @resource.merge(new_resource)
+        @resource = new_resource.merge(@resource)
+      end
+
+      # Accepts a string that is merged in as the service.name resource attribute.
+      # The most recent assigned value will be used in the event of repeated
+      # 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(
+          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.
+      # The most recent assigned value will be used in the event of repeated
+      # 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(
+          OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:version] => service_version
+        ).merge(@resource)
       end
 
       # Install an instrumentation with specificied optional +config+.
@@ -72,8 +93,8 @@ module OpenTelemetry
 
       # Add a span processor to the export pipeline
       #
-      # @param [#on_start, #on_finish, #shutdown] span_processor A span_processor
-      #   that satisfies the duck type #on_start, #on_finish, #shutdown. See
+      # @param [#on_start, #on_finish, #shutdown, #force_flush] span_processor A span_processor
+      #   that satisfies the duck type #on_start, #on_finish, #shutdown, #force_flush. See
       #   {SimpleSpanProcessor} for an example.
       def add_span_processor(span_processor)
         @span_processors << span_processor
@@ -89,7 +110,7 @@ module OpenTelemetry
       #   - install instrumentation
       def configure
         OpenTelemetry.logger = logger
-        OpenTelemetry.correlations = CorrelationContext::Manager.new
+        OpenTelemetry.baggage = Baggage::Manager.new
         configure_propagation
         configure_span_processors
         OpenTelemetry.tracer_provider = tracer_provider
@@ -130,8 +151,8 @@ module OpenTelemetry
       def configure_propagation
         OpenTelemetry.propagation.http = create_propagator(@http_injectors || default_http_injectors,
                                                            @http_extractors || default_http_extractors)
-        OpenTelemetry.propagation.text = create_propagator(@text_injectors || default_text_injectors,
-                                                           @text_extractors || default_text_extractors)
+        OpenTelemetry.propagation.text = create_propagator(@text_map_injectors || default_text_map_injectors,
+                                                           @text_map_extractors || default_text_map_extractors)
       end
 
       def create_propagator(injectors, extractors)
@@ -143,27 +164,27 @@ module OpenTelemetry
       end
 
       def default_http_injectors
-        default_text_injectors
+        default_text_map_injectors
       end
 
       def default_http_extractors
         [
           OpenTelemetry::Trace::Propagation::TraceContext.rack_extractor,
-          OpenTelemetry::CorrelationContext::Propagation.rack_extractor
+          OpenTelemetry::Baggage::Propagation.rack_extractor
         ]
       end
 
-      def default_text_injectors
+      def default_text_map_injectors
         [
-          OpenTelemetry::Trace::Propagation::TraceContext.text_injector,
-          OpenTelemetry::CorrelationContext::Propagation.text_injector
+          OpenTelemetry::Trace::Propagation::TraceContext.text_map_injector,
+          OpenTelemetry::Baggage::Propagation.text_map_injector
         ]
       end
 
-      def default_text_extractors
+      def default_text_map_extractors
         [
-          OpenTelemetry::Trace::Propagation::TraceContext.text_extractor,
-          OpenTelemetry::CorrelationContext::Propagation.text_extractor
+          OpenTelemetry::Trace::Propagation::TraceContext.text_map_extractor,
+          OpenTelemetry::Baggage::Propagation.text_map_extractor
         ]
       end
     end

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

@@ -79,10 +79,6 @@ module OpenTelemetry
 
         # Attributes defining a computing instance (e.g. host).
         HOST_RESOURCE = {
-          # Hostname of the host. It contains what the hostname command returns on the
-          # host machine.
-          hostname: 'host.hostname',
-
           # Unique host id. For Cloud this must be the instance_id assigned by the
           # cloud provider
           id: 'host.id',

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

@@ -13,29 +13,40 @@ module OpenTelemetry
         class << self
           private :new # rubocop:disable Style/AccessModifierDeclarations
 
-          # Returns a newly created {Resource} with the specified labels
+          # Returns a newly created {Resource} with the specified attributes
           #
-          # @param [Hash{String => String, Numeric, Boolean} labels Hash of key-value pairs to be used
-          #   as labels for this resource
-          # @raise [ArgumentError] If label keys and values are not strings
+          # @param [Hash{String => String, Numeric, Boolean} attributes Hash of key-value pairs to be used
+          #   as attributes for this resource
+          # @raise [ArgumentError] If attribute keys and values are not strings
           # @return [Resource]
-          def create(labels = {})
-            frozen_labels = labels.each_with_object({}) do |(k, v), memo|
-              raise ArgumentError, 'label keys must be strings' unless k.is_a?(String)
-              raise ArgumentError, 'label values must be strings, integers, floats, or booleans' unless Internal.valid_value?(v)
+          def create(attributes = {})
+            frozen_attributes = attributes.each_with_object({}) do |(k, v), memo|
+              raise ArgumentError, 'attribute keys must be strings' unless k.is_a?(String)
+              raise ArgumentError, 'attribute values must be strings, integers, floats, or booleans' unless Internal.valid_value?(v)
 
               memo[-k] = v.freeze
             end.freeze
 
-            new(frozen_labels)
+            new(frozen_attributes)
           end
 
           def telemetry_sdk
-            create(
+            resource_attributes = {
               Constants::TELEMETRY_SDK_RESOURCE[:name] => 'opentelemetry',
               Constants::TELEMETRY_SDK_RESOURCE[:language] => 'ruby',
-              Constants::TELEMETRY_SDK_RESOURCE[:version] => "semver:#{OpenTelemetry::SDK::VERSION}"
-            )
+              Constants::TELEMETRY_SDK_RESOURCE[:version] => OpenTelemetry::SDK::VERSION
+            }
+
+            resource_pairs = ENV['OTEL_RESOURCE_ATTRIBUTES']
+            return create(resource_attributes) unless resource_pairs.is_a?(String)
+
+            resource_pairs.split(',').each do |pair|
+              key, value = pair.split('=')
+              resource_attributes[key] = value
+            end
+
+            resource_attributes.delete_if { |_key, value| value.nil? || value.empty? }
+            create(resource_attributes)
           end
         end
 
@@ -44,18 +55,18 @@ module OpenTelemetry
         # Users should use the {create} factory method to obtain a {Resource}
         # instance.
         #
-        # @param [Hash<String, String>] frozen_labels Frozen-hash of frozen-string
-        #  key-value pairs to be used as labels for this resource
+        # @param [Hash<String, String>] frozen_attributes Frozen-hash of frozen-string
+        #  key-value pairs to be used as attributes for this resource
         # @return [Resource]
-        def initialize(frozen_labels)
-          @labels = frozen_labels
+        def initialize(frozen_attributes)
+          @attributes = frozen_attributes
         end
 
-        # Returns an enumerator for labels of this {Resource}
+        # Returns an enumerator for attributes of this {Resource}
         #
         # @return [Enumerator]
-        def label_enumerator
-          @label_enumerator ||= labels.to_enum
+        def attribute_enumerator
+          @attribute_enumerator ||= attributes.to_enum
         end
 
         # Returns a new, merged {Resource} by merging the current {Resource} with
@@ -68,16 +79,16 @@ module OpenTelemetry
         def merge(other)
           return self unless other.is_a?(Resource)
 
-          merged_labels = labels.merge(other.labels) do |_, old_v, new_v|
+          merged_attributes = attributes.merge(other.attributes) do |_, old_v, new_v|
             old_v.empty? ? new_v : old_v
           end
 
-          self.class.send(:new, merged_labels.freeze)
+          self.class.send(:new, merged_attributes.freeze)
         end
 
         protected
 
-        attr_reader :labels
+        attr_reader :attributes
       end
     end
   end