opentelemetry-sdk 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4e07f01a74b3728fc3e3b7624bc4bc8e2b82ec2fdfcd8512544ba9fb28b202
-  data.tar.gz: a28f74743c88d4cb4b06917061c6995805550d3d048bddda10db850e83399259
+  metadata.gz: b5510dccb3f3f94057ab6f17a625b8c71fbeeb958d2ec2de2eb732bfc59a4225
+  data.tar.gz: 768a8e36a2a5a34458d6872584339a93d14d83b0302ed998626d21d97d4592b7
 SHA512:
-  metadata.gz: 19e27ad4c599e28e9f9bd5156af4228b3fd0e043b793cff9f87e4ef84e82efc3e22053a8406ce2c24a47527194e398243ea137bc6e9b32ec15b0dafc490c456d
-  data.tar.gz: 2e82d76bca14d45cec4cacc92255c8779d4ccb272b72b8d854c93e9a455675e496a5c562ee4932cb2bc00c971e932be7494db36d78277486e91f7568da44e4f1
+  metadata.gz: ab2eb7f6eec8f1c62812e8a6f53502a2f29d017489078ede3c5fc4b4b9928435e71658c2cb506b73a16098ef681fffd9d088a028fd6938fec3da0d6a30cc3ec8
+  data.tar.gz: a1ee4191297bdb3491988e0bca431274f29685057578781e3911bd9f34e66042826aa1528c5eda9172d65beeaf6aeed269185665eb0f6a2361500de09a311c10

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,33 @@
 # Release History: opentelemetry-sdk
+
+### 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/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2020 OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

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

@@ -30,13 +30,13 @@ module OpenTelemetry
     #   Install instrumentation individually with optional config
     #
     #     OpenTelemetry::SDK.configure do |c|
-    #       c.use 'OpenTelemetry::Adapters::Faraday', tracer_middleware: SomeMiddleware
+    #       c.use 'OpenTelemetry::Instrumentation::Faraday', tracer_middleware: SomeMiddleware
     #     end
     #
     #   Install all instrumentation with optional config
     #
     #     OpenTelemetry::SDK.configure do |c|
-    #       c.use_all 'OpenTelemetry::Adapters::Faraday' => { tracer_middleware: SomeMiddleware }
+    #       c.use_all 'OpenTelemetry::Instrumentation::Faraday' => { tracer_middleware: SomeMiddleware }
     #     end
     #
     #   Add a span processor
@@ -61,8 +61,9 @@ 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'
 require 'opentelemetry/sdk/trace'
 require 'opentelemetry/sdk/version'

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

@@ -8,63 +8,93 @@ module OpenTelemetry
   module SDK
     # The configurator provides defaults and facilitates configuring the
     # SDK for use.
-    class Configurator
+    class Configurator # rubocop:disable Metrics/ClassLength
       USE_MODE_UNSPECIFIED = 0
       USE_MODE_ONE = 1
       USE_MODE_ALL = 2
 
       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
-        @adapter_names = []
-        @adapter_config_map = {}
+        @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
-        @tracer_provider = Trace::TracerProvider.new
+        @resource = Resources::Resource.telemetry_sdk
       end
 
       def logger
-        @logger ||= Logger.new(STDOUT)
+        @logger ||= OpenTelemetry.logger
       end
 
-      # Install an instrumentation adapter with specificied optional +config+.
-      # Use can be called multiple times to install multiple instrumentation
-      # adapters. Only +use+ or +use_all+, but not both when installing
+      # 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 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 = 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+.
+      # Use can be called multiple times to install multiple instrumentation.
+      # Only +use+ or +use_all+, but not both when installing
       # instrumentation. A call to +use_all+ after +use+ will result in an
       # exception.
       #
-      # @param [String] adapter_name The name of the instrumentation adapter
-      # @param [optional Hash] config The config for this adapter
-      def use(adapter_name, config = nil)
+      # @param [String] instrumentation_name The name of the instrumentation
+      # @param [optional Hash] config The config for this instrumentation
+      def use(instrumentation_name, config = nil)
         check_use_mode!(USE_MODE_ONE)
-        @adapter_names << adapter_name
-        @adapter_config_map[adapter_name] = config if config
+        @instrumentation_names << instrumentation_name
+        @instrumentation_config_map[instrumentation_name] = config if config
       end
 
       # Install all registered instrumentation. Configuration for specific
-      # adapters can be provided with the optional +adapter_config_map+
+      # instrumentation can be provided with the optional +instrumentation_config_map+
       # parameter. Only +use+ or +use_all+, but not both when installing
       # instrumentation. A call to +use+ after +use_all+ will result in an
       # exception.
       #
-      # @param [optional Hash<String,Hash>] adapter_config_map A map with string keys
-      #   representing the adapter name and values specifying the adapter config
-      def use_all(adapter_config_map = {})
+      # @param [optional Hash<String,Hash>] instrumentation_config_map A map with string keys
+      #   representing the instrumentation name and values specifying the instrumentation config
+      def use_all(instrumentation_config_map = {})
         check_use_mode!(USE_MODE_ALL)
-        @adapter_config_map = adapter_config_map
+        @instrumentation_config_map = instrumentation_config_map
       end
 
       # 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
@@ -80,15 +110,19 @@ 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
+        OpenTelemetry.tracer_provider = tracer_provider
         install_instrumentation
       end
 
       private
 
+      def tracer_provider
+        @tracer_provider ||= Trace::TracerProvider.new(@resource)
+      end
+
       def check_use_mode!(mode)
         @use_mode = mode if @use_mode == USE_MODE_UNSPECIFIED
         raise 'Use either `use_all` or `use`, but not both' unless @use_mode == mode
@@ -97,15 +131,15 @@ module OpenTelemetry
       def install_instrumentation
         case @use_mode
         when USE_MODE_ONE
-          OpenTelemetry.instrumentation_registry.install(@adapter_names, @adapter_config_map)
+          OpenTelemetry.instrumentation_registry.install(@instrumentation_names, @instrumentation_config_map)
         when USE_MODE_ALL
-          OpenTelemetry.instrumentation_registry.install_all(@adapter_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.each { |p| @tracer_provider.add_span_processor(p) }
+        processors.each { |p| tracer_provider.add_span_processor(p) }
       end
 
       def default_span_processor
@@ -117,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)
@@ -130,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