opentelemetry-sdk 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '079e4ea0a93345e6e014c3f7760425e042544ae619cf5761cb08813dac99a728'
-  data.tar.gz: f36464e88c42bd56a60060854da46daa42b35b720619201ed30e8a038ea567c7
+  metadata.gz: b64da58e8086f08efd2f7bace98369ec16936abcf95996588bda288a592d5912
+  data.tar.gz: 4d67cd982c51998cf0396531bcbaae6f62f23b89314793def72410624c87a645
 SHA512:
-  metadata.gz: 7305bdedc102299c04c3c0798d9137fc74919e4edd3eb37a4b239c739218274427b82f925d97cdcdebd192559033f025a6cad2f729f5d05c5856b6aa6e9e2170
-  data.tar.gz: efcd32dc9aa6c9e260b05829d790c294308e08bc7ca275647c33f54b03ac463a63da7962a9038917c6fe3571ae10dc61efaa09dfc17eb5bfae4ed040719a8c80
+  metadata.gz: 3d8d0331a351e32cf184a512c155c6d3944bb5bbbb2857aad27636bdc7eca58081d45e6d778eecd50681e1a1c471c75f9cf7d8116b57ba5c5c5b7a5838f3a648
+  data.tar.gz: ef884f72a85e1457b1d160d2075313df169f895cfe92831d87e77022244db6b6d980f7a36f6c88926886fd67538e916c2e813728ce80aa2897ef24da216d2924

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History: opentelemetry-sdk
 
+### 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

@@ -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

data/lib/opentelemetry/sdk/configurator.rb

@@ -27,7 +27,7 @@ module OpenTelemetry
         @text_map_injectors = nil
         @span_processors = []
         @use_mode = USE_MODE_UNSPECIFIED
-        @resource = Resources::Resource.telemetry_sdk
+        @resource = Resources::Resource.default
         @id_generator = OpenTelemetry::Trace
       end
 
@@ -46,7 +46,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 +54,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 +64,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+.

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

@@ -77,6 +77,46 @@ module OpenTelemetry
           deployment_name: 'k8s.deployment.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).
         HOST_RESOURCE = {
           # Unique host id. For Cloud this must be the instance_id assigned by the

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

@@ -30,6 +30,10 @@ module OpenTelemetry
             new(frozen_attributes)
           end
 
+          def default
+            @default ||= telemetry_sdk.merge(process).merge(create(Constants::SERVICE_RESOURCE[:name] => 'unknown_service'))
+          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/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
@@ -29,11 +29,11 @@ module OpenTelemetry
           # 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 [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
@@ -44,8 +44,8 @@ module OpenTelemetry
           #
           # @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)),
+                         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 +53,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

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

@@ -120,15 +120,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/version.rb

@@ -7,6 +7,6 @@
 module OpenTelemetry
   module SDK
     ## Current OpenTelemetry version
-    VERSION = '0.12.1'
+    VERSION = '0.13.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.13.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-01-30 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.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,10 +201,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.13.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.13.0
 post_install_message: 
 rdoc_options: []
 require_paths: