opentelemetry-instrumentation-base 0.18.3 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5fdd5b15b00d59effe03fc6b2d0973e9e7e8679d86d009987915829effd3578
-  data.tar.gz: 99852fa23dd1b29a54521c2c5e780691cf2fbab3eb9e472cbf004704eefb0576
+  metadata.gz: 164a4d7f0afcc437a79f2e2569ff80d904644d512a7a241a462eb26054127cff
+  data.tar.gz: 1807fe5154e3d77093429e7a6355bd952615f410ffe199f3e587b3af22c45184
 SHA512:
-  metadata.gz: 7589e2cc7be76cec38a7d0852f0c7404053a8f83502089dc260cf9c4ab6e36b9d13b52f5a665f6d0dbde15383b9ae8d923839b5a80c28c5a60be717de0e63b6c
-  data.tar.gz: 855cc418aada657e81dc792a73940b678d1e4db16883726217eabf853e39f834f520e7aa834a1059b20d3c407191a3551cfd7b9fe6124edad87585b2e73020ed
+  metadata.gz: 83b29693b52c0d2d0e3e668f7fb4229be83149c1833146604fc719d794566a504029fd9c9d241d1e25b1c28fd166ae286da7f383b609afdbf2d6f8195839b3b0
+  data.tar.gz: e86bdac3678dde4c77a56402a3ea0fb4fb8289dbc82fa31ac134d38f943372c7083542a5d35110ed674ea08d99724e5b15cc2bbf51cec0591847381351231cbb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-base
 
+### 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

@@ -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.19.0'
   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.19.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -142,10 +142,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.3/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-base/v0.19.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.19.0
 post_install_message: 
 rdoc_options: []
 require_paths: