opentelemetry-instrumentation-base 0.18.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef678a885af528bd4d2b24d485b7de14aad90a8b133997fbdf18ede04907ec71
-  data.tar.gz: ee08c3e58f40a36722e8800b790c5067e18e30b55561ef5e2a23bcef870b9d8a
+  metadata.gz: 36880f3027db5ce9434787fc96f373497e7e4a0986bba01db8936abd6a6c6f60
+  data.tar.gz: 2b6e9ef13f8ccad67f9c3d1138343192b4ea9df5fc0393acea2351b3bc498cf4
 SHA512:
-  metadata.gz: 9a4ff219a55ec280b6a1ff75d2d51cf2172bd4298d01c3b41c37e38b99b811709b304e522270cd71abe747f4831967e7e86367d52c34db2c893d564a31206bf7
-  data.tar.gz: 05fc7bf280714bdbfcddbd1a50131da5a8765eff0b0b8e0069070f19d0113944205a266dba0e05254920949058b123c9a7a376dbc4462a05bce998f70d86f29a
+  metadata.gz: 90af953fd300ccbf1dbde0381999279d3773d79a02297b97ad5148eb070ea6fab7cbcaf38b82f6f2f3b60e4256b49302f0f844e77cfecfcd7d9d4b11b05fe095
+  data.tar.gz: e58a221f4f846955c7d122b15766b2afba00007343ae54e8fa890346ad3d3ff56c08bdb9d297084ba0c84da6cd9152dba27b09e74850811737143181cd47c24f

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History: opentelemetry-instrumentation-base
 
+### 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)
+
 ### v0.18.2 / 2021-08-12
 
 * (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/registry.rb

@@ -76,7 +76,7 @@ module OpenTelemetry
 
       def install_instrumentation(instrumentation, config)
         if instrumentation.install(config)
-          OpenTelemetry.logger.info "Instrumentation: #{instrumentation.name} was successfully installed"
+          OpenTelemetry.logger.info "Instrumentation: #{instrumentation.name} was successfully installed with the following options #{instrumentation.config}"
         else
           OpenTelemetry.logger.warn "Instrumentation: #{instrumentation.name} failed to install"
         end

data/lib/opentelemetry/instrumentation/version.rb

@@ -6,6 +6,6 @@
 
 module OpenTelemetry
   module Instrumentation
-    VERSION = '0.18.2'
+    VERSION = '0.20.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-base
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.20.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,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
@@ -142,10 +156,10 @@ 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.2/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.20.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.2
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.20.0
 post_install_message: 
 rdoc_options: []
 require_paths: