opentelemetry-sdk 1.4.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30876b5f639b980b00d48fbae72e4b01850b3c57cafa01aa4dc5ca580be0918d
-  data.tar.gz: d002cb6584183e04b65a7b770bb75565bee3fe54396ade52714a009a26a5cb92
+  metadata.gz: e3ba5bcaae681a8f24969dd8aa7d886e0d1b57b3c26d46ef71bc2724bf5e7fe4
+  data.tar.gz: 1d41a63a92487100a7f6a0e5fd74a18c92a7d9adf744ee561cc43e8def5c288b
 SHA512:
-  metadata.gz: 940facba296fde53952e694e465b7ab72cbbfabbeaa1e8bec8444476dcd57c6efd5227208021722d7130698eb33f0baf5d332594bac5f79ec946950b3c5231e3
-  data.tar.gz: 3b2f25a049880af16792a74ec5c35b3531555bff41f049ddf91422da7896f836a295c54419fc8e82abfe076cfd6fe003a0093a2a91319e65c246c00dc280e229
+  metadata.gz: d6e3c2646902e1adb9efa33ab7d20b6d0a572c03e077a03b6cc13c1b94d95c2f41bcd1235b60f251384f9cd303fc49c4e3b88c2a6d6654e1de8b2356b3be6212
+  data.tar.gz: 6729117a513daecc2d6f2e09de4601ca77777c51d0b110e3d4eea7a4365bcb1dffef201f529acb3479b20299e840154276fa2e50fd87871c575d7c859d36d848

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History: opentelemetry-sdk
 
+### v1.6.0 / 2024-12-04
+
+* ADDED: Add hooks to configure logs
+
+### v1.5.0 / 2024-07-24
+
+* ADDED: Add add_link to span api/sdk
+* FIXED: Update `untraced` to suppress logging "Calling finish on an ended Span" warnings
+
 ### v1.4.1 / 2024-03-21
 
 * FIXED: ForwardingLogger should forward block param.

data/README.md

@@ -12,13 +12,19 @@ OpenTelemetry provides a single set of APIs, libraries, agents, and collector se
 
 The `opentelemetry-sdk` gem provides the reference implementation of the OpenTelemetry Ruby interfaces defined in the `opentelemetry-api` gem. That is, it includes the *functionality* needed to collect, analyze, and export telemetry data produced using the API.
 
-Generally, Ruby *applications* should install `opentelemetry-sdk` (or other concrete implementation of the OpenTelemetry API). Using the SDK, an application can configure how it wants telemetry data to be handled, including which data should be persisted, how it should be formatted, and where it should be recorded or exported. However, *libraries* that produce telemetry data should generally depend only on `opentelemetry-api`, deferring the choise of concrete implementation to the application developer.
+Generally, Ruby *applications* should install `opentelemetry-sdk` (or
+other concrete implementation of the OpenTelemetry API). Using the SDK,
+an application can configure how it wants telemetry data to be handled,
+including which data should be persisted, how it should be formatted,
+and where it should be recorded or exported. However, *libraries* that
+produce telemetry data should generally depend only on
+`opentelemetry-api`, deferring the choice of concrete implementation to the application developer.
 
 ## How do I get started?
 
 Install the gem using:
 
-```
+```sh
 gem install opentelemetry-sdk
 ```
 
@@ -53,7 +59,7 @@ OpenTelemetry::SDK.configure
 #   c.use 'OpenTelemetry::Instrumentation::Net::HTTP'
 # end
 #
-# Note that the SimpleSpanExporter is not recommended for use in production.
+# Note that the SimpleSpanProcessor is not recommended for use in production.
 
 
 # To start a trace you need to get a Tracer from the TracerProvider
@@ -85,7 +91,6 @@ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special int
 
 The `opentelemetry-sdk` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
 
-
 [opentelemetry-home]: https://opentelemetry.io
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby

data/lib/opentelemetry/sdk/configurator.rb

@@ -90,7 +90,7 @@ module OpenTelemetry
         )
       end
 
-      # Install an instrumentation with specificied optional +config+.
+      # Install an instrumentation with specified 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
@@ -126,13 +126,20 @@ module OpenTelemetry
         @span_processors << span_processor
       end
 
+      # Add a log record processor to the export pipeline
+      #
+      # @param [#emit, #shutdown, #force_flush] log_record_processor A log_record_processor
+      #   that satisfies the duck type #emit, #shutdown, #force_flush. See
+      #   {SimpleLogRecordProcessor} for an example.
+      def add_log_record_processor(log_record_processor); end
+
       # @api private
       # The configure method is where we define the setup process. This allows
       # us to make certain guarantees about which systems and globals are setup
       # at each stage. The setup process is:
       #   - setup logging
       #   - setup propagation
-      #   - setup tracer_provider and meter_provider
+      #   - setup tracer_provider, meter_provider, and logger_provider
       #   - install instrumentation
       def configure
         OpenTelemetry.logger = logger
@@ -142,6 +149,7 @@ module OpenTelemetry
         tracer_provider.id_generator = @id_generator
         OpenTelemetry.tracer_provider = tracer_provider
         metrics_configuration_hook
+        logs_configuration_hook
         install_instrumentation
       end
 
@@ -149,6 +157,8 @@ module OpenTelemetry
 
       def metrics_configuration_hook; end
 
+      def logs_configuration_hook; end
+
       def tracer_provider
         @tracer_provider ||= Trace::TracerProvider.new(resource: @resource)
       end

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

@@ -118,6 +118,37 @@ module OpenTelemetry
           self
         end
 
+        # Add a link to a {Span}.
+        #
+        # Adding links at span creation using the `links` option is preferred
+        # to calling add_link later, because head sampling decisions can only
+        # consider information present during span creation.
+        #
+        # Example:
+        #
+        #   span.add_link(OpenTelemetry::Trace::Link.new(span_to_link_from.context))
+        #
+        # 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 [OpenTelemetry::Trace::Link] the link object to add on the {Span}.
+        #
+        # @return [self] returns itself
+        def add_link(link)
+          @mutex.synchronize do
+            if @ended
+              OpenTelemetry.logger.warn('Calling add_link on an ended Span.')
+            else
+              @links ||= []
+              @links = trim_links(@links << link, @span_limits.link_count_limit, @span_limits.link_attribute_count_limit)
+              @total_recorded_links += 1
+            end
+          end
+          self
+        end
+
         # Add an Event to a {Span}.
         #
         # Example:
@@ -240,8 +271,12 @@ module OpenTelemetry
               return self
             end
             @end_timestamp = relative_timestamp(end_timestamp)
+            @span_processors.each do |processor|
+              processor.on_finishing(self) if processor.respond_to?(:on_finishing)
+            end
             @attributes = validated_attributes(@attributes).freeze
             @events.freeze
+            @links.freeze
             @ended = true
           end
           @span_processors.each { |processor| processor.on_finish(self) }
@@ -373,7 +408,7 @@ module OpenTelemetry
 
           if links.size <= link_count_limit &&
              links.all? { |link| link.span_context.valid? && link.attributes.size <= link_attribute_count_limit && Internal.valid_attributes?(name, 'link', link.attributes) }
-            return links.frozen? ? links : links.clone.freeze
+            return links
           end
 
           # Slow path: trim attributes for each Link.
@@ -386,7 +421,7 @@ module OpenTelemetry
             excess = attrs.size - link_attribute_count_limit
             excess.times { attrs.shift } if excess.positive?
             OpenTelemetry::Trace::Link.new(link.span_context, attrs)
-          end.freeze
+          end
         end
 
         def append_event(events, event) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

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

@@ -41,7 +41,6 @@ module OpenTelemetry
                        event_attribute_count_limit: Integer(OpenTelemetry::Common::Utilities.config_opt('OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT', default: 128)),
                        event_attribute_length_limit: OpenTelemetry::Common::Utilities.config_opt('OTEL_EVENT_ATTRIBUTE_VALUE_LENGTH_LIMIT', 'OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT'),
                        link_attribute_count_limit: Integer(OpenTelemetry::Common::Utilities.config_opt('OTEL_LINK_ATTRIBUTE_COUNT_LIMIT', default: 128)))
-
           raise ArgumentError, 'attribute_count_limit must be positive' unless attribute_count_limit.positive?
           raise ArgumentError, 'attribute_length_limit must not be less than 32' unless attribute_length_limit.nil? || Integer(attribute_length_limit) >= 32
           raise ArgumentError, 'event_count_limit must be positive' unless event_count_limit.positive?

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

@@ -23,6 +23,24 @@ module OpenTelemetry
         #  started span.
         def on_start(span, parent_context); end
 
+        # The on_finishing method is an experimental feature and may have breaking changes.
+        # The OpenTelemetry specification defines it as "On Ending". As `end` is a reserved
+        # keyword in Ruby, we are using `on_finishing` instead.
+        #
+        # Called when a {Span} is ending, after the end timestamp has been set
+        # but before span becomes immutable. This allows for updating the span
+        # by setting attributes or adding links and events.
+        #
+        # This method is called synchronously and should not block the current
+        # thread nor throw exceptions.
+        #
+        # This method is optional on the Span Processor interface. It will only
+        # get called if it exists within the processor.
+        #
+        # @param [Span] span the {Span} that just is ending (still mutable).
+        # @return [void]
+        def on_finishing(span); end
+
         # Called when a {Span} is ended, if the {Span#recording?}
         # returns true.
         #

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

@@ -29,8 +29,6 @@ module OpenTelemetry
 
         def start_span(name, with_parent: nil, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
           with_parent ||= Context.current
-          return super(name, with_parent: with_parent, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind) if Common::Utilities.untraced?(with_parent)
-
           name ||= 'empty'
           kind ||= :internal
 

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

@@ -126,7 +126,7 @@ module OpenTelemetry
         end
 
         # @api private
-        def internal_start_span(name, kind, attributes, links, start_timestamp, parent_context, instrumentation_scope) # rubocop:disable Metrics/MethodLength
+        def internal_start_span(name, kind, attributes, links, start_timestamp, parent_context, instrumentation_scope) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
           parent_span = OpenTelemetry::Trace.current_span(parent_context)
           parent_span_context = parent_span.context
 
@@ -134,8 +134,13 @@ module OpenTelemetry
             parent_span_id = parent_span_context.span_id
             trace_id = parent_span_context.trace_id
           end
-
           trace_id ||= @id_generator.generate_trace_id
+
+          if OpenTelemetry::Common::Utilities.untraced?(parent_context)
+            span_id = parent_span_id || @id_generator.generate_span_id
+            return OpenTelemetry::Trace.non_recording_span(OpenTelemetry::Trace::SpanContext.new(trace_id: trace_id, span_id: span_id))
+          end
+
           result = @sampler.should_sample?(trace_id: trace_id, parent_context: parent_context, links: links, name: name, kind: kind, attributes: attributes)
           span_id = @id_generator.generate_span_id
           if result.recording? && !@stopped

data/lib/opentelemetry/sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.6.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: '1.65'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: '1.65'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -294,10 +294,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/v1.4.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.6.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/v1.4.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v1.6.0
 post_install_message: 
 rdoc_options: []
 require_paths: