opentelemetry-api 0.13.0 → 1.0.0.rc1

data/lib/opentelemetry/instrumentation/registry.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    # The instrumentation Registry contains information about instrumentation
-    # available and facilitates discovery, installation and
-    # configuration. This functionality is primarily useful for SDK
-    # implementors.
-    class Registry
-      def initialize
-        @lock = Mutex.new
-        @instrumentation = []
-      end
-
-      # @api private
-      def register(instrumentation)
-        @lock.synchronize do
-          @instrumentation << instrumentation
-        end
-      end
-
-      # Lookup an instrumentation definition by name. Returns nil if +instrumentation_name+
-      # is not found.
-      #
-      # @param [String] instrumentation_name A stringified class name for an instrumentation
-      # @return [Instrumentation]
-      def lookup(instrumentation_name)
-        @lock.synchronize do
-          find_instrumentation(instrumentation_name)
-        end
-      end
-
-      # Install the specified instrumentation with optionally specified configuration.
-      #
-      # @param [Array<String>] instrumentation_names An array of instrumentation names to
-      #   install
-      # @param [optional Hash<String, Hash>] instrumentation_config_map A map of
-      #   instrumentation_name to config. This argument is optional and config can be
-      #   passed for as many or as few instrumentations as desired.
-      def install(instrumentation_names, instrumentation_config_map = {})
-        @lock.synchronize do
-          instrumentation_names.each do |instrumentation_name|
-            instrumentation = find_instrumentation(instrumentation_name)
-            OpenTelemetry.logger.warn "Could not install #{instrumentation_name} because it was not found" unless instrumentation
-
-            install_instrumentation(instrumentation, instrumentation_config_map[instrumentation.name])
-          end
-        end
-      end
-
-      # Install all instrumentation available and installable in this process.
-      #
-      # @param [optional Hash<String, Hash>] instrumentation_config_map A map of
-      #   instrumentation_name to config. This argument is optional and config can be
-      #   passed for as many or as few instrumentations as desired.
-      def install_all(instrumentation_config_map = {})
-        @lock.synchronize do
-          @instrumentation.map(&:instance).each do |instrumentation|
-            install_instrumentation(instrumentation, instrumentation_config_map[instrumentation.name])
-          end
-        end
-      end
-
-      private
-
-      def find_instrumentation(instrumentation_name)
-        @instrumentation.detect { |a| a.instance.name == instrumentation_name }
-                   &.instance
-      end
-
-      def install_instrumentation(instrumentation, config)
-        if instrumentation.install(config)
-          OpenTelemetry.logger.info "Instrumentation: #{instrumentation.name} was successfully installed"
-        else
-          OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} failed to install"
-        end
-      rescue => e # rubocop:disable Style/RescueStandardError
-        OpenTelemetry.handle_error(exception: e, message: "Instrumentation: #{instrumentation.name} unhandled exception during install: #{e.backtrace}")
-      end
-    end
-  end
-end

data/lib/opentelemetry/metrics.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-require 'opentelemetry/metrics/handles'
-require 'opentelemetry/metrics/instruments'
-require 'opentelemetry/metrics/meter'
-require 'opentelemetry/metrics/meter_provider'
-
-module OpenTelemetry
-  # The Metrics API allows reporting raw measurements as well as metrics with known aggregation and labels.
-  module Metrics
-  end
-end

data/lib/opentelemetry/metrics/handles.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Metrics
-    # In situations where performance is a requirement and a metric is
-    # repeatedly used with the same labels, the developer may elect to
-    # use instrument {Handles} as an optimization. For handles to be a benefit,
-    # it requires that a specific instrument will be re-used with specific
-    # labels. If an instrument will be used with the same labels more than
-    # once, obtaining an instrument handle corresponding to the labels
-    # ensures the highest performance available.
-    #
-    # To obtain a handle given an instrument and labels, use the  #handle
-    # method to return an interface that supports the #add or #record
-    # method of the instrument in question.
-    #
-    # Instrument handles may consume SDK resources indefinitely.
-    module Handles
-      # A float counter handle.
-      class FloatCounter
-        def add(value); end
-      end
-
-      # An integer counter handle.
-      class IntegerCounter
-        def add(value); end
-      end
-
-      # A float measure handle.
-      class FloatMeasure
-        def record(value); end
-      end
-
-      # An integer measure handle.
-      class IntegerMeasure
-        def record(value); end
-      end
-    end
-  end
-end

data/lib/opentelemetry/metrics/instruments.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Metrics
-    # The user-facing metrics API supports producing diagnostic measurements
-    # using three basic kinds of instrument. "Metrics" are the thing being
-    # produced -- mathematical, statistical summaries of certain observable
-    # behavior in the program. "Instruments" are the devices used by the
-    # program to record observations about their behavior. Therefore, we use
-    # "metric instrument" to refer to a program object, allocated through the
-    # API, used for recording metrics. There are three distinct instruments in
-    # the Metrics API, commonly known as Counters, Observers, and Measures.
-    module Instruments
-      # TODO: Observers.
-
-      # A float counter instrument.
-      class FloatCounter
-        def add(value, labels = {}); end
-
-        # Obtain a handle from the instrument and labels.
-        #
-        # @param [optional Hash<String, String>] labels A Hash of Strings.
-        # @return [Handles::FloatCounter]
-        def handle(labels = {})
-          Handles::FloatCounter.new
-        end
-
-        # Return a measurement to be recorded via {Meter#record_batch}.
-        #
-        # @param [Float] value
-        # @return [Object, Measurement]
-        def measurement(value)
-          NOOP_MEASUREMENT
-        end
-      end
-
-      # An integer counter instrument.
-      class IntegerCounter
-        def add(value, labels = {}); end
-
-        # Obtain a handle from the instrument and labels.
-        #
-        # @param [optional Hash<String, String>] labels A Hash of Strings.
-        # @return [Handles::IntegerCounter]
-        def handle(labels = {})
-          Handles::IntegerCounter.new
-        end
-
-        # Return a measurement to be recorded via {Meter#record_batch}.
-        #
-        # @param [Integer] value
-        # @return [Object, Measurement]
-        def measurement(value)
-          NOOP_MEASUREMENT
-        end
-      end
-
-      # A float measure instrument.
-      class FloatMeasure
-        def record(value, labels = {}); end
-
-        # Obtain a handle from the instrument and labels.
-        #
-        # @param [optional Hash<String, String>] labels A Hash of Strings.
-        # @return [Handles::FloatMeasure]
-        def handle(labels = {})
-          Handles::FloatMeasure.new
-        end
-
-        # Return a measurement to be recorded via {Meter#record_batch}.
-        #
-        # @param [Float] value
-        # @return [Object, Measurement]
-        def measurement(value)
-          NOOP_MEASUREMENT
-        end
-      end
-
-      # An integer measure instrument.
-      class IntegerMeasure
-        def record(value, labels = {}); end
-
-        # Obtain a handle from the instrument and labels.
-        #
-        # @param [optional Hash<String, String>] labels A Hash of Strings.
-        # @return [Handles::IntegerMeasure]
-        def handle(labels = {})
-          Handles::IntegerMeasure.new
-        end
-
-        # Return a measurement to be recorded via {Meter#record_batch}.
-        #
-        # @param [Integer] value
-        # @return [Object, Measurement]
-        def measurement(value)
-          NOOP_MEASUREMENT
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/metrics/meter.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Metrics
-    # No-op implementation of Meter.
-    class Meter
-      def record_batch(*measurements, labels: nil); end
-
-      # TODO: Observers.
-
-      # Create and return a floating point counter.
-      #
-      # @param [String] name Name of the metric. See {Meter} for required metric name syntax.
-      # @param [optional String] description Descriptive text documenting the instrument.
-      # @param [optional String] unit Unit specified according to http://unitsofmeasure.org/ucum.html.
-      # @param [optional Enumerable<String>] recommended_label_keys Recommended grouping keys for this instrument.
-      # @param [optional Boolean] monotonic Whether the counter accepts only monotonic updates. Defaults to true.
-      # @return [FloatCounter]
-      def create_float_counter(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: true)
-        raise ArgumentError if name.nil?
-
-        Instruments::FloatCounter.new
-      end
-
-      # Create and return an integer counter.
-      #
-      # @param [String] name Name of the metric. See {Meter} for required metric name syntax.
-      # @param [optional String] description Descriptive text documenting the instrument.
-      # @param [optional String] unit Unit specified according to http://unitsofmeasure.org/ucum.html.
-      # @param [optional Enumerable<String>] recommended_label_keys Recommended grouping keys for this instrument.
-      # @param [optional Boolean] monotonic Whether the counter accepts only monotonic updates. Defaults to true.
-      # @return [IntegerCounter]
-      def create_integer_counter(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: true)
-        raise ArgumentError if name.nil?
-
-        Instruments::IntegerCounter.new
-      end
-
-      # Create and return a floating point measure.
-      #
-      # @param [String] name Name of the metric. See {Meter} for required metric name syntax.
-      # @param [optional String] description Descriptive text documenting the instrument.
-      # @param [optional String] unit Unit specified according to http://unitsofmeasure.org/ucum.html.
-      # @param [optional Enumerable<String>] recommended_label_keys Recommended grouping keys for this instrument.
-      # @param [optional Boolean] absolute Whether the measure accepts only non-negative updates. Defaults to true.
-      # @return [FloatMeasure]
-      def create_float_measure(name, description: nil, unit: nil, recommended_label_keys: nil, absolute: true)
-        raise ArgumentError if name.nil?
-
-        Instruments::FloatMeasure.new
-      end
-
-      # Create and return an integer measure.
-      #
-      # @param [String] name Name of the metric. See {Meter} for required metric name syntax.
-      # @param [optional String] description Descriptive text documenting the instrument.
-      # @param [optional String] unit Unit specified according to http://unitsofmeasure.org/ucum.html.
-      # @param [optional Enumerable<String>] recommended_label_keys Recommended grouping keys for this instrument.
-      # @param [optional Boolean] absolute Whether the measure accepts only non-negative updates. Defaults to true.
-      # @return [IntegerMeasure]
-      def create_integer_measure(name, description: nil, unit: nil, recommended_label_keys: nil, absolute: true)
-        raise ArgumentError if name.nil?
-
-        Instruments::IntegerMeasure.new
-      end
-    end
-  end
-end

data/lib/opentelemetry/metrics/meter_provider.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Metrics
-    # No-op implementation of a meter provider.
-    class MeterProvider
-      # Returns a {Meter} instance.
-      #
-      # @param [optional String] name Instrumentation package name
-      # @param [optional String] version Instrumentation package version
-      #
-      # @return [Meter]
-      def meter(name = nil, version = nil)
-        @meter ||= Meter.new
-      end
-    end
-  end
-end

data/lib/opentelemetry/trace/propagation/trace_context/text_map_extractor.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-module OpenTelemetry
-  module Trace
-    module Propagation
-      module TraceContext
-        # Extracts context from carriers in the W3C Trace Context format
-        class TextMapExtractor
-          include Context::Propagation::DefaultGetter
-
-          # Returns a new TextMapExtractor that extracts context using the
-          # specified header keys
-          #
-          # @param [String] traceparent_key The traceparent header key used in the carrier
-          # @param [String] tracestate_key The tracestate header key used in the carrier
-          # @return [TextMapExtractor]
-          def initialize(traceparent_key: 'traceparent',
-                         tracestate_key: 'tracestate')
-            @traceparent_key = traceparent_key
-            @tracestate_key = tracestate_key
-          end
-
-          # Extract a remote {Trace::SpanContext} from the supplied carrier.
-          # Invalid headers will result in a new, valid, non-remote {Trace::SpanContext}.
-          #
-          # @param [Carrier] carrier The carrier to get the header from.
-          # @param [Context] context The context to be updated with extracted context
-          # @param [optional Callable] getter An optional callable that takes a carrier and a key and
-          #   returns the value associated with the key. If omitted the default getter will be used
-          #   which expects the carrier to respond to [] and []=.
-          # @yield [Carrier, String] if an optional getter is provided, extract will yield the carrier
-          #   and the header key to the getter.
-          # @return [Context] Updated context with span context from the header, or the original
-          #   context if parsing fails.
-          def extract(carrier, context, &getter)
-            getter ||= default_getter
-            tp = TraceParent.from_string(getter.call(carrier, @traceparent_key))
-            tracestate = Tracestate.from_string(getter.call(carrier, @tracestate_key))
-
-            span_context = Trace::SpanContext.new(trace_id: tp.trace_id,
-                                                  span_id: tp.span_id,
-                                                  trace_flags: tp.flags,
-                                                  tracestate: tracestate,
-                                                  remote: true)
-            span = Trace::Span.new(span_context: span_context)
-            OpenTelemetry::Trace.context_with_span(span)
-          rescue OpenTelemetry::Error
-            context
-          end
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/trace/propagation/trace_context/text_map_injector.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-module OpenTelemetry
-  module Trace
-    module Propagation
-      module TraceContext
-        # Injects context into carriers using the W3C Trace Context format
-        class TextMapInjector
-          include Context::Propagation::DefaultSetter
-
-          # Returns a new TextMapInjector that injects context using the
-          # specified header keys
-          #
-          # @param [String] traceparent_key The traceparent header key used in the carrier
-          # @param [String] tracestate_key The tracestate header key used in the carrier
-          # @return [TextMapInjector]
-          def initialize(traceparent_key: 'traceparent',
-                         tracestate_key: 'tracestate')
-            @traceparent_key = traceparent_key
-            @tracestate_key = tracestate_key
-          end
-
-          # Set the span context on the supplied carrier.
-          #
-          # @param [Context] context The active {Context}.
-          # @param [optional Callable] setter An optional callable that takes a carrier and a key and
-          #   a value and assigns the key-value pair in the carrier. If omitted the default setter
-          #   will be used which expects the carrier to respond to [] and []=.
-          # @yield [Carrier, String, String] if an optional setter is provided, inject will yield
-          #   carrier, header key, header value to the setter.
-          # @return [Object] the carrier with context injected
-          def inject(carrier, context, &setter)
-            return carrier unless (span_context = span_context_from(context))
-
-            setter ||= DEFAULT_SETTER
-            setter.call(carrier, @traceparent_key, TraceParent.from_span_context(span_context).to_s)
-            setter.call(carrier, @tracestate_key, span_context.tracestate.to_s) unless span_context.tracestate.empty?
-
-            carrier
-          end
-
-          private
-
-          def span_context_from(context)
-            OpenTelemetry::Trace.current_span(context).context
-          end
-        end
-      end
-    end
-  end
-end