opentelemetry-instrumentation-base 0.18.3 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5fdd5b15b00d59effe03fc6b2d0973e9e7e8679d86d009987915829effd3578
-  data.tar.gz: 99852fa23dd1b29a54521c2c5e780691cf2fbab3eb9e472cbf004704eefb0576
+  metadata.gz: 99e6450e5fe0a34262181644384ac289093fb11dc924dcdb44be21e46715cddb
+  data.tar.gz: 91dcb93efdcabe5db3619fe0fb962f0512373759aafb34bcabee9ea31f1092c1
 SHA512:
-  metadata.gz: 7589e2cc7be76cec38a7d0852f0c7404053a8f83502089dc260cf9c4ab6e36b9d13b52f5a665f6d0dbde15383b9ae8d923839b5a80c28c5a60be717de0e63b6c
-  data.tar.gz: 855cc418aada657e81dc792a73940b678d1e4db16883726217eabf853e39f834f520e7aa834a1059b20d3c407191a3551cfd7b9fe6124edad87585b2e73020ed
+  metadata.gz: e4da44cb456ec692d62577aee339c9bcf3b1cd57aa49d5e6a8e96b0a6ab2da1f8b3b367a10f8593751b1caa4c163c257d9760b8842d94bc66839816828456c2c
+  data.tar.gz: 54de81f111d50c53305054975bd43e6dbb8bebe3386eed876dc7a36ed4f42ef5416c5668f25962b1427a911fbdcde7ea1c87892f5fcc9fdb9407f83c4e392a65

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release History: opentelemetry-instrumentation-base
 
+### v0.21.0 / 2022-05-26
+
+* BREAKING CHANGE: This requires upgrading both the SDK and Instrumentation gem in tandem
+
+
+### v0.20.0 / 2022-05-02
+
+* ADDED: Validate Using Enums 
+* FIXED: RubyGems Fallback 
+
+### v0.19.0 / 2021-12-01
+
+* ADDED: Add default options config helper + env var config option support 
+
 ### v0.18.3 / 2021-09-29
 
 * (No significant changes)

data/lib/opentelemetry/instrumentation/base.rb

@@ -32,7 +32,7 @@ module OpenTelemetry
     #
     #         # if the target library is present, is it compatible?
     #         compatible do
-    #           Gem.loaded_specs['sinatra'].version > MIN_VERSION
+    #           Gem::Version.new(Sinatra::VERSION)) > MIN_VERSION
     #         end
     #       end
     #     end
@@ -146,11 +146,20 @@ module OpenTelemetry
         # a key in the VALIDATORS hash.  The supported keys are, :array, :boolean,
         # :callable, :integer, :string.
         def option(name, default:, validate:)
-          validate = VALIDATORS[validate] || validate
-          raise ArgumentError, "validate must be #{VALIDATORS.keys.join(', ')}, or a callable" unless validate.respond_to?(:call)
+          validator = VALIDATORS[validate] || validate
+          raise ArgumentError, "validate must be #{VALIDATORS.keys.join(', ')}, or a callable" unless validator.respond_to?(:call) || validator.respond_to?(:include?)
 
           @options ||= []
-          @options << { name: name, default: default, validate: validate }
+
+          validation_type = if VALIDATORS[validate]
+                              validate
+                            elsif validate.respond_to?(:include?)
+                              :enum
+                            else
+                              :callable
+                            end
+
+          @options << { name: name, default: default, validator: validator, validation_type: validation_type }
         end
 
         def instance
@@ -257,16 +266,24 @@ module OpenTelemetry
       # Invalid configuration values are logged, and replaced by the default.
       #
       # @param [Hash] user_config The user supplied configuration hash
-      def config_options(user_config) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def config_options(user_config) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         @options ||= {}
         user_config ||= {}
+        config_overrides = config_overrides_from_env
         validated_config = @options.each_with_object({}) do |option, h|
           option_name = option[:name]
           config_value = user_config[option_name]
+          config_override = coerce_env_var(config_overrides[option_name], option[:validation_type]) if config_overrides[option_name]
 
-          value = if config_value.nil?
+          value = if config_value.nil? && config_override.nil?
                     option[:default]
-                  elsif option[:validate].call(config_value)
+                  elsif option[:validator].respond_to?(:include?) && option[:validator].include?(config_override)
+                    config_override
+                  elsif option[:validator].respond_to?(:include?) && option[:validator].include?(config_value)
+                    config_value
+                  elsif option[:validator].respond_to?(:call) && option[:validator].call(config_override)
+                    config_override
+                  elsif option[:validator].respond_to?(:call) && option[:validator].call(config_value)
                     config_value
                   else
                     OpenTelemetry.logger.warn(
@@ -303,6 +320,49 @@ module OpenTelemetry
         end
         ENV[var_name] != 'false'
       end
+
+      def config_overrides_from_env
+        var_name = name.dup.tap do |n|
+          n.upcase!
+          n.gsub!('::', '_')
+          n.gsub!('OPENTELEMETRY_', 'OTEL_RUBY_')
+          n << '_CONFIG_OPTS'
+        end
+
+        environment_config_overrides = {}
+        env_config_options = ENV[var_name]&.split(';')
+
+        return environment_config_overrides if env_config_options.nil?
+
+        env_config_options.each_with_object(environment_config_overrides) do |env_config_option, eco|
+          parts = env_config_option.split('=')
+          option_name = parts[0].to_sym
+          eco[option_name] = parts[1]
+        end
+
+        environment_config_overrides
+      end
+
+      def coerce_env_var(env_var, validation_type) # rubocop:disable Metrics/CyclomaticComplexity
+        case validation_type
+        when :array
+          env_var.split(',').map(&:strip)
+        when :boolean
+          env_var.to_s.strip.downcase == 'true'
+        when :integer
+          env_var.to_i
+        when :string
+          env_var.to_s.strip
+        when :enum
+          env_var.to_s.strip.to_sym
+        when :callable
+          OpenTelemetry.logger.warn(
+            "Instrumentation #{name} options that accept a callable are not " \
+            "configurable using environment variables. Ignoring raw value: #{env_var}"
+          )
+          nil
+        end
+      end
     end
   end
 end

data/lib/opentelemetry/instrumentation/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Instrumentation
-    VERSION = '0.18.3'
+    VERSION = '0.21.0'
   end
 end

data/lib/opentelemetry/instrumentation.rb

@@ -5,19 +5,12 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
-require 'opentelemetry/instrumentation/registry'
+require 'opentelemetry-registry'
 require 'opentelemetry/instrumentation/base'
 
 module OpenTelemetry
   # The instrumentation module contains functionality to register and install
   # instrumentation
   module Instrumentation
-    extend self
-
-    # @return [Registry] registry containing all known
-    #  instrumentation
-    def registry
-      @registry ||= Registry.new
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-base
 version: !ruby/object:Gem::Version
-  version: 0.18.3
+  version: 0.21.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-registry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-test-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,16 +164,15 @@ files:
 - lib/opentelemetry-instrumentation-base.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/base.rb
-- lib/opentelemetry/instrumentation/registry.rb
 - lib/opentelemetry/instrumentation/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.18.3/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.21.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/base
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.18.3
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.21.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -154,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/opentelemetry/instrumentation/registry.rb

@@ -1,88 +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)
-            if instrumentation.nil?
-              OpenTelemetry.logger.warn "Could not install #{instrumentation_name} because it was not found"
-            else
-              install_instrumentation(instrumentation, instrumentation_config_map[instrumentation.name])
-            end
-          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