opentelemetry-sdk 0.5.1

data/lib/opentelemetry/sdk/correlation_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/sdk/correlation_context/builder'
+require 'opentelemetry/sdk/correlation_context/manager'
+
+module OpenTelemetry
+  module SDK
+    # Contains operational implementations of the CorrelationContext::Manager
+    module CorrelationContext
+    end
+  end
+end

data/lib/opentelemetry/sdk/correlation_context/builder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module CorrelationContext
+      # SDK implementation of CorrelationContext::Builder
+      class Builder
+        attr_reader :entries
+
+        def initialize(entries)
+          @entries = entries
+        end
+
+        # Set key-value in the to-be-created correlation context
+        #
+        # @param [String] key The key to store this value under
+        # @param [String] value String value to be stored under key
+        def set_value(key, value)
+          @entries[key] = value.to_s
+        end
+
+        # Removes key from the to-be-created correlation context
+        #
+        # @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
+        def clear
+          @entries.clear
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/correlation_context/manager.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module CorrelationContext
+      # Manages correlation context
+      class Manager
+        CORRELATION_CONTEXT_KEY = OpenTelemetry::CorrelationContext::Propagation::ContextKeys.correlation_context_key
+        EMPTY_CORRELATION_CONTEXT = {}.freeze
+        private_constant(:CORRELATION_CONTEXT_KEY, :EMPTY_CORRELATION_CONTEXT)
+
+        # 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
+        # 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+
+        # @return [Context]
+        def build_context(context: Context.current)
+          builder = Builder.new(correlations_for(context).dup)
+          yield builder
+          context.set_value(CORRELATION_CONTEXT_KEY, builder.entries)
+        end
+
+        # Returns a new context with empty correlations
+        #
+        # @param [optional Context] context Context to clear correlations from. Defaults
+        #   to +Context.current+
+        # @return [Context]
+        def clear(context: Context.current)
+          context.set_value(CORRELATION_CONTEXT_KEY, EMPTY_CORRELATION_CONTEXT)
+        end
+
+        # Returns the corresponding correlation value (or nil) for key
+        #
+        # @param [String] key The lookup key
+        # @param [optional Context] context The context from which to retrieve
+        #   the key.
+        #   Defaults to +Context.current+
+        # @return [String]
+        def value(key, context: Context.current)
+          correlations_for(context)[key]
+        end
+
+        # Returns a new context with new key-value pair
+        #
+        # @param [String] key The key to store this value under
+        # @param [String] value String value to be stored under key
+        # @param [optional Context] context The context to update with new
+        #   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)
+        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
+        #   from. Defaults to +Context.current+
+        # @return [Context]
+        def remove_value(key, context: Context.current)
+          correlations = correlations_for(context)
+          return context unless correlations.key?(key)
+
+          new_correlations = correlations.dup
+          new_correlations.delete(key)
+          context.set_value(CORRELATION_CONTEXT_KEY, new_correlations)
+        end
+
+        private
+
+        def correlations_for(context)
+          context.value(CORRELATION_CONTEXT_KEY) || EMPTY_CORRELATION_CONTEXT
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/instrumentation_library.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # InstrumentationLibrary is a struct containing library information for export.
+    InstrumentationLibrary = Struct.new(:name,
+                                        :version)
+  end
+end

data/lib/opentelemetry/sdk/internal.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # @api private
+    #
+    # Internal contains helpers used by the reference implementation.
+    module Internal
+      extend self
+
+      def boolean?(value)
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+
+      def valid_key?(key)
+        key.instance_of?(String)
+      end
+
+      def valid_simple_value?(value)
+        value.instance_of?(String) || value == false || value == true || value.is_a?(Numeric)
+      end
+
+      def valid_array_value?(value)
+        return false unless value.is_a?(Array)
+        return true if value.empty?
+
+        case value.first
+        when String
+          value.all? { |v| v.instance_of?(String) }
+        when TrueClass, FalseClass
+          value.all? { |v| boolean?(v) }
+        when Numeric
+          value.all? { |v| v.is_a?(Numeric) }
+        else
+          false
+        end
+      end
+
+      def valid_value?(value)
+        valid_simple_value?(value) || valid_array_value?(value)
+      end
+
+      def valid_attributes?(attrs)
+        attrs.nil? || attrs.all? { |k, v| valid_key?(k) && valid_value?(v) }
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/resources.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # Resources contains the {Resource} class.
+    module Resources
+    end
+  end
+end
+
+require 'opentelemetry/sdk/resources/resource'
+require 'opentelemetry/sdk/resources/constants'

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 namespace that the pod is running in.
+          namespace_name: 'k8s.namespace.name',
+
+          # The name of the pod.
+          pod_name: 'k8s.pod.name',
+
+          # The name of the deployment.
+          deployment_name: 'k8s.deployment.name'
+        }.freeze
+
+        # 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',
+
+          # 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',
+
+          # Zones are a sub set of the region connected through low-latency links.
+          zone: 'cloud.zone'
+        }.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Resources
+      # Resource represents a resource, which captures identifying information about the entities
+      # for which telemetry (metrics or traces) is reported.
+      class Resource
+        class << self
+          private :new # rubocop:disable Style/AccessModifierDeclarations
+
+          # Returns a newly created {Resource} with the specified labels
+          #
+          # @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
+          # @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)
+
+              memo[-k] = v.freeze
+            end.freeze
+
+            new(frozen_labels)
+          end
+
+          def telemetry_sdk
+            create(
+              Constants::TELEMETRY_SDK_RESOURCE[:name] => 'opentelemetry',
+              Constants::TELEMETRY_SDK_RESOURCE[:language] => 'ruby',
+              Constants::TELEMETRY_SDK_RESOURCE[:version] => "semver:#{OpenTelemetry::SDK::VERSION}"
+            )
+          end
+        end
+
+        # @api private
+        # The constructor is private and only for use internally by the class.
+        # 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
+        # @return [Resource]
+        def initialize(frozen_labels)
+          @labels = frozen_labels
+        end
+
+        # Returns an enumerator for labels of this {Resource}
+        #
+        # @return [Enumerator]
+        def label_enumerator
+          @label_enumerator ||= labels.to_enum
+        end
+
+        # Returns a new, merged {Resource} by merging the current {Resource} with
+        # the other {Resource}. In case of a collision, the current {Resource}
+        # takes precedence
+        #
+        # @param [Resource] other The other resource to merge
+        # @return [Resource] A new resource formed by merging the current resource
+        #   with other
+        def merge(other)
+          return self unless other.is_a?(Resource)
+
+          merged_labels = labels.merge(other.labels) do |_, old_v, new_v|
+            old_v.empty? ? new_v : old_v
+          end
+
+          self.class.send(:new, merged_labels.freeze)
+        end
+
+        protected
+
+        attr_reader :labels
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/trace.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # The Trace module contains the OpenTelemetry tracing reference
+    # implementation.
+    module Trace
+    end
+  end
+end
+
+require 'opentelemetry/sdk/trace/samplers'
+require 'opentelemetry/sdk/trace/config'
+require 'opentelemetry/sdk/trace/export'
+require 'opentelemetry/sdk/trace/multi_span_processor'
+require 'opentelemetry/sdk/trace/noop_span_processor'
+require 'opentelemetry/sdk/trace/span_data'
+require 'opentelemetry/sdk/trace/span'
+require 'opentelemetry/sdk/trace/tracer'
+require 'opentelemetry/sdk/trace/tracer_provider'