opentelemetry-sdk 1.0.0.rc1 → 1.0.1

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

@@ -1,205 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Resources
-      module Constants
-        # Attributes describing a service instance.
-        SERVICE_RESOURCE = {
-          # Logical name of the service.
-          name: 'service.name',
-
-          # A namespace for `service.name`.
-          namespace: 'service.namespace',
-
-          # The string ID of the service instance.
-          instance_id: 'service.instance.id',
-
-          # The version string of the service API or implementation.
-          version: 'service.version'
-        }.freeze
-
-        # Attributes describing the telemetry library.
-        TELEMETRY_SDK_RESOURCE = {
-          # The name of the telemetry library.
-          name: 'telemetry.sdk.name',
-
-          # The language of the telemetry library and of the code instrumented with it.
-          language: 'telemetry.sdk.language',
-
-          # The version string of the telemetry library
-          version: 'telemetry.sdk.version'
-        }.freeze
-
-        # Attributes defining a compute unit (e.g. Container, Process, Lambda
-        # Function).
-        CONTAINER_RESOURCE = {
-          # The container name.
-          name: 'container.name',
-
-          # The name of the image the container was built on.
-          image_name: 'container.image.name',
-
-          # The container image tag.
-          image_tag: 'container.image.tag'
-        }.freeze
-
-        FAAS_RESOURCE = {
-          # The name of the function being executed.
-          name: 'faas.name',
-
-          # The unique name of the function being executed.
-          id: 'faas.id',
-
-          # The version string of the function being executed.
-          version: 'faas.version',
-
-          # The execution environment ID as a string.
-          instance: 'faas.instance'
-        }.freeze
-
-        # Attributes defining a deployment service (e.g. Kubernetes).
-        K8S_RESOURCE = {
-          # The name of the cluster that the pod is running in.
-          cluster_name: 'k8s.cluster.name',
-
-          # The name of the Node.
-          node_name: 'k8s.node.name',
-
-          # The UID of the Node.
-          node_uid: 'k8s.node.uid',
-
-          # The name of the namespace that the pod is running in.
-          namespace_name: 'k8s.namespace.name',
-
-          # The name of the pod.
-          pod_name: 'k8s.pod.name',
-
-          # The UID of the Pod.
-          pod_uid: 'k8s.pod.uid',
-
-          #  The name of the Container in a Pod template.
-          container_name: 'k8s.container.name',
-
-          # The UID of the ReplicaSet.
-          replicaset_uid: 'k8s.replicaset.uid',
-
-          # The name of the ReplicaSet.
-          replicaset_name: 'k8s.replicaset.name',
-
-          # The UID of the Deployment.
-          deployment_uid: 'k8s.deployment.uid',
-
-          # The name of the deployment.
-          deployment_name: 'k8s.deployment.name',
-
-          # The UID of the StatefulSet.
-          statefulset_uid: 'k8s.statefulset.uid',
-
-          # The name of the StatefulSet.
-          statefulset_name: 'k8s.statefulset.name',
-
-          # The UID of the DaemonSet.
-          daemonset_uid: 'k8s.daemonset.uid',
-
-          # The name of the DaemonSet.
-          daemonset_name: 'k8s.daemonset.name',
-
-          # The UID of the Job.
-          job_uid: 'k8s.job.uid',
-
-          # The name of the Job.
-          job_name: 'k8s.job.name',
-
-          # The UID of the CronJob.
-          cronjob_uid: 'k8s.cronjob.uid',
-
-          # The name of the CronJob.
-          cronjob_name: 'k8s.cronjob.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
-          # cloud provider
-          id: 'host.id',
-
-          # Name of the host. It may contain what hostname returns on Unix systems,
-          # the fully qualified, or a name specified by the user.
-          name: 'host.name',
-
-          # Type of host. For Cloud this must be the machine type.
-          type: 'host.type',
-
-          # Name of the VM image or OS install the host was instantiated from.
-          image_name: 'host.image.name',
-
-          # VM image id. For Cloud, this value is from the provider.
-          image_id: 'host.image.id',
-
-          # The version string of the VM image.
-          image_version: 'host.image.version'
-        }.freeze
-
-        # Attributes defining a running environment (e.g. Cloud, Data Center).
-        CLOUD_RESOURCE = {
-          # Name of the cloud provider. Example values are aws, azure, gcp.
-          provider: 'cloud.provider',
-
-          # The cloud account id used to identify different entities.
-          account_id: 'cloud.account.id',
-
-          # A specific geographical location where different entities can run.
-          region: 'cloud.region',
-
-          # Availability zones are a sub set of the region connected through low-latency links.
-          availability_zone: 'cloud.availability_zone'
-        }.freeze
-      end
-    end
-  end
-end

data/lib/opentelemetry/sdk/trace/config/trace_config.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Trace
-      module Config
-        # Class that holds global trace parameters.
-        class TraceConfig
-          # The global default sampler (see {Samplers}).
-          attr_reader :sampler
-
-          # The global default max number of attributes per {Span}.
-          attr_reader :max_attributes_count
-
-          # The global default max length of attribute value per {Span}.
-          attr_reader :max_attributes_length
-
-          # The global default max number of {OpenTelemetry::SDK::Trace::Event}s per {Span}.
-          attr_reader :max_events_count
-
-          # The global default max number of {OpenTelemetry::Trace::Link} entries per {Span}.
-          attr_reader :max_links_count
-
-          # The global default max number of attributes per {OpenTelemetry::SDK::Trace::Event}.
-          attr_reader :max_attributes_per_event
-
-          # The global default max number of attributes per {OpenTelemetry::Trace::Link}.
-          attr_reader :max_attributes_per_link
-
-          # Returns a {TraceConfig} with the desired values.
-          #
-          # @return [TraceConfig] with the desired values.
-          # @raise [ArgumentError] if any of the max numbers are not positive.
-          def initialize(sampler: sampler_from_environment(Samplers.parent_based(root: Samplers::ALWAYS_ON)), # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-                         max_attributes_count: Integer(ENV.fetch('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT', 128)),
-                         max_attributes_length: ENV['OTEL_RUBY_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT'],
-                         max_events_count: Integer(ENV.fetch('OTEL_SPAN_EVENT_COUNT_LIMIT', 128)),
-                         max_links_count: Integer(ENV.fetch('OTEL_SPAN_LINK_COUNT_LIMIT', 128)),
-                         max_attributes_per_event: max_attributes_count,
-                         max_attributes_per_link: max_attributes_count)
-            raise ArgumentError, 'max_attributes_count must be positive' unless max_attributes_count.positive?
-            raise ArgumentError, 'max_attributes_length must not be less than 32' unless max_attributes_length.nil? || Integer(max_attributes_length) >= 32
-            raise ArgumentError, 'max_events_count must be positive' unless max_events_count.positive?
-            raise ArgumentError, 'max_links_count must be positive' unless max_links_count.positive?
-            raise ArgumentError, 'max_attributes_per_event must be positive' unless max_attributes_per_event.positive?
-            raise ArgumentError, 'max_attributes_per_link must be positive' unless max_attributes_per_link.positive?
-
-            @sampler = sampler
-            @max_attributes_count = max_attributes_count
-            @max_attributes_length = max_attributes_length.nil? ? nil : Integer(max_attributes_length)
-            @max_events_count = max_events_count
-            @max_links_count = max_links_count
-            @max_attributes_per_event = max_attributes_per_event
-            @max_attributes_per_link = max_attributes_per_link
-          end
-
-          # TODO: from_proto
-          private
-
-          def sampler_from_environment(default_sampler) # rubocop:disable Metrics/CyclomaticComplexity
-            case ENV['OTEL_TRACES_SAMPLER']
-            when 'always_on' then Samplers::ALWAYS_ON
-            when 'always_off' then Samplers::ALWAYS_OFF
-            when 'traceidratio' then Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACES_SAMPLER_ARG', 1.0)))
-            when 'parentbased_always_on' then Samplers.parent_based(root: Samplers::ALWAYS_ON)
-            when 'parentbased_always_off' then Samplers.parent_based(root: Samplers::ALWAYS_OFF)
-            when 'parentbased_traceidratio' then Samplers.parent_based(root: Samplers.trace_id_ratio_based(Float(ENV.fetch('OTEL_TRACES_SAMPLER_ARG', 1.0))))
-            else default_sampler
-            end
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e, message: "installing default sampler #{default_sampler.description}")
-            default_sampler
-          end
-
-          # The default {TraceConfig}.
-          DEFAULT = new
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Trace
-      # The Config module contains the configuration logic for the
-      # OpenTelemetry SDK.
-      module Config
-      end
-    end
-  end
-end
-
-require 'opentelemetry/sdk/trace/config/trace_config'

data/lib/opentelemetry/sdk/trace/export/multi_span_exporter.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Trace
-      module Export
-        # Implementation of the SpanExporter duck type that simply forwards all
-        # received spans to a collection of SpanExporters.
-        #
-        # Can be used to export to multiple backends using the same
-        # SpanProcessor like a {SimpleSpanProcessor} or a
-        # {BatchSpanProcessor}.
-        class MultiSpanExporter
-          def initialize(span_exporters)
-            @span_exporters = span_exporters.clone.freeze
-          end
-
-          # Called to export sampled {Span}s.
-          #
-          # @param [Enumerable<Span>] spans the list of sampled {Span}s to be
-          #   exported.
-          # @param [optional Numeric] timeout An optional timeout in seconds.
-          # @return [Integer] the result of the export.
-          def export(spans, timeout: nil)
-            start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
-            results = @span_exporters.map do |span_exporter|
-              span_exporter.export(spans, timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
-            rescue => e # rubocop:disable Style/RescueStandardError
-              OpenTelemetry.logger.warn("exception raised by export - #{e}")
-              FAILURE
-            end
-            results.uniq.max || SUCCESS
-          end
-
-          # Called when {TracerProvider#force_flush} is called, if this exporter is
-          # registered to a {TracerProvider} object.
-          #
-          # @param [optional Numeric] timeout An optional timeout in seconds.
-          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
-          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
-          def force_flush(timeout: nil)
-            start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
-            results = @span_exporters.map do |processor|
-              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
-              return TIMEOUT if remaining_timeout&.zero?
-
-              processor.force_flush(timeout: remaining_timeout)
-            end
-            results.uniq.max || SUCCESS
-          end
-
-          # Called when {TracerProvider#shutdown} is called, if this exporter is
-          # registered to a {TracerProvider} object.
-          #
-          # @param [optional Numeric] timeout An optional timeout in seconds.
-          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
-          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
-          def shutdown(timeout: nil)
-            start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
-            results = @span_exporters.map do |processor|
-              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
-              return TIMEOUT if remaining_timeout&.zero?
-
-              processor.shutdown(timeout: remaining_timeout)
-            end
-            results.uniq.max || SUCCESS
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module SDK
-    module Trace
-      # Implementation of the SpanProcessor duck type that simply forwards all
-      # received events to a list of SpanProcessors.
-      class MultiSpanProcessor
-        # Creates a new {MultiSpanProcessor}.
-        #
-        # @param [Enumerable<SpanProcessor>] span_processors a collection of
-        #   SpanProcessors.
-        # @return [MultiSpanProcessor]
-        def initialize(span_processors)
-          @span_processors = span_processors.to_a.freeze
-        end
-
-        # Called when a {Span} is started, if the {Span#recording?}
-        # returns true.
-        #
-        # This method is called synchronously on the execution thread, should
-        # not throw or block the execution thread.
-        #
-        # @param [Span] span the {Span} that just started.
-        # @param [Context] parent_context the parent {Context} of the newly
-        #  started span.
-        def on_start(span, parent_context)
-          @span_processors.each { |processor| processor.on_start(span, parent_context) }
-        end
-
-        # Called when a {Span} is ended, if the {Span#recording?}
-        # returns true.
-        #
-        # This method is called synchronously on the execution thread, should
-        # not throw or block the execution thread.
-        #
-        # @param [Span] span the {Span} that just ended.
-        def on_finish(span)
-          @span_processors.each { |processor| processor.on_finish(span) }
-        end
-
-        # Export all ended spans to the configured `Exporter` that have not yet
-        # been exported.
-        #
-        # 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.
-        #
-        # @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)
-          start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
-          results = @span_processors.map do |processor|
-            remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
-            return Export::TIMEOUT if remaining_timeout&.zero?
-
-            processor.force_flush(timeout: remaining_timeout)
-          end
-          results.uniq.max
-        end
-
-        # Called when {TracerProvider#shutdown} is called.
-        #
-        # @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 shutdown(timeout: nil)
-          start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
-          results = @span_processors.map do |processor|
-            remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
-            return Export::TIMEOUT if remaining_timeout&.zero?
-
-            processor.shutdown(timeout: remaining_timeout)
-          end
-          results.uniq.max
-        end
-      end
-    end
-  end
-end