opentelemetry-config 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6920e5ca17ba99ef990626f22fb6d1d5b09fd0f07a02039c48c7fb420e59d2b
-  data.tar.gz: 3cf56fdd238b6903c3209b150860e5998ad7dbcd26e8e8588b18ea0699115543
+  metadata.gz: 17b22f9a07db4efa7182ceefc5d35e2654a69a2222f914be8263ade344c1e7a1
+  data.tar.gz: 8bc97d2d66b57afce05ae6e4beb26eeba5c3b4d716485ee783a2ed665bd1ab0b
 SHA512:
-  metadata.gz: 677ce312429f98ce5c1555c4d53172ae8ee4fc0c44bff5052844f3afd735d576299306f5d36964afdf1b41d4b115d5c2540a35b7c38d615df33fd8125125e37f
-  data.tar.gz: 60eb6aa2db9e5efec14a2e6c23c2c9fa93d1f6f02ad22998f064836d0a2532ca8b585c8f2a36072f5d52a20093f1eea1b666b9e29d1aec650eb0ec33189363c2
+  metadata.gz: 73a690631b026066700a372a69987670b5de3bb75fa1911ccff8e84eeb7739cdc3ef1bc847c1393ec02c53443e180173a21884d9f404b82763ea5bece743709d
+  data.tar.gz: acf18866d0dd78f50ddd4b895f58cfb6267be49428847cd0a3a009f52250cd461d68d82f1f04a3e7992eb652a19d00e079da06563878f21d943d1dd9c01a5e35

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-config
 
+### v0.1.1 / 2026-10-13
+
+* FIXED: Ignore SDK env defaults in declarative config (#2429)
+
 ### v0.1.0 / 2026-09-29
 
 * ADDED: Declarative configuration for trace_provider (#2161)

data/README.md

@@ -22,7 +22,6 @@ This code is still under development and is not a complete implementation of the
 
 Some features we still need to implement include:
 
-- Configuration file precedence over environment variables
 - Using declarative configuration without a call in your code
 - Declarative configuration instrumentation API and SDK
 
@@ -65,6 +64,36 @@ If you have a config file path at hand, call `configure_from_file` instead:
 sdk = OpenTelemetry::Config.configure_from_file('/path/to/otel-config.yaml')
 ```
 
+### Environment variables and SDK-specific settings
+
+File-based configuration uses the values in the YAML file and the schema defaults
+for omitted settings. It does not inherit the SDK's `OTEL_*` environment-variable
+defaults.
+
+Some Ruby-specific SDK settings have no equivalent in the configuration schema:
+
+- `OTEL_RUBY_BSP_START_THREAD_ON_BOOT` is ignored. A configured batch span
+  processor starts its worker thread during construction. Applications that need
+  to delay worker startup should use programmatic SDK configuration instead.
+- `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE` and
+  `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` are ignored. The OTLP HTTP exporter
+  verifies the server certificate. For a private certificate authority, set
+  `tls.ca_file` rather than disabling verification. For mutual TLS, also set
+  `tls.cert_file` and `tls.key_file`.
+
+```yaml
+tracer_provider:
+  processors:
+    - batch:
+        exporter:
+          otlp_http:
+            endpoint: https://collector.example.com:4318/v1/traces
+            tls:
+              ca_file: /path/to/ca.pem
+              cert_file: /path/to/client.pem
+              key_file: /path/to/client-key.pem
+```
+
 ### Parse, create, and install
 
 `configure` is a convenience wrapper around the three [SDK operations][sdk-operations]. Call them individually when you need to inspect the configuration model or delay installing the global state:

data/lib/opentelemetry/config/defaults.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Config
+    # Schema defaults for omitted or null properties. Keys use schema names;
+    # durations are in milliseconds and are converted by the builders.
+    module Defaults
+      BATCH_SPAN_PROCESSOR = {
+        schedule_delay: 5_000,
+        export_timeout: 30_000,
+        max_queue_size: 2048,
+        max_export_batch_size: 512
+      }.freeze
+
+      SPAN_LIMITS = {
+        attribute_count_limit: 128,
+        attribute_value_length_limit: nil,
+        event_count_limit: 128,
+        link_count_limit: 128,
+        event_attribute_count_limit: 128,
+        link_attribute_count_limit: 128
+      }.freeze
+
+      OTLP_HTTP_EXPORTER = {
+        compression: 'none',
+        timeout: 10_000
+      }.freeze
+
+      OTLP_HTTP_TRACES_ENDPOINT = 'http://localhost:4318/v1/traces'
+    end
+
+    private_constant :Defaults
+  end
+end

data/lib/opentelemetry/config/resource.rb

@@ -11,7 +11,7 @@ module OpenTelemetry
 
       # Priority: attributes > attribute_list > detected > base
       def build_resource(resource_cfg)
-        base = OpenTelemetry::SDK::Resources::Resource.default
+        base = default_resource
 
         return base unless resource_cfg
 
@@ -38,6 +38,20 @@ module OpenTelemetry
         base.merge(custom)
       end
 
+      # Builds the intrinsic SDK resource without consulting OTEL_* environment
+      # variables. File-based configuration and environment configuration are
+      # intentionally separate sources.
+      def default_resource
+        resource_class = OpenTelemetry::SDK::Resources::Resource
+
+        resource_class.create(
+          OpenTelemetry::SemanticConventions::Resource::SERVICE_NAME => 'unknown_service',
+          OpenTelemetry::SemanticConventions::Resource::TELEMETRY_SDK_NAME => 'opentelemetry',
+          OpenTelemetry::SemanticConventions::Resource::TELEMETRY_SDK_LANGUAGE => 'ruby',
+          OpenTelemetry::SemanticConventions::Resource::TELEMETRY_SDK_VERSION => OpenTelemetry::SDK::VERSION
+        ).merge(resource_class.process)
+      end
+
       # type coercion
       def coerce_attribute_value(value, type)
         case type

data/lib/opentelemetry/config/trace.rb

@@ -3,6 +3,8 @@
 # Copyright The OpenTelemetry Authors
 # SPDX-License-Identifier: Apache-2.0
 
+require 'openssl'
+
 module OpenTelemetry
   module Config
     # Trace component builder for configuring TracerProvider from declarative config.
@@ -46,15 +48,17 @@ module OpenTelemetry
         end
       end
 
-      # Builds a BatchSpanProcessor with exporter and optional tuning options.
+      # Builds a BatchSpanProcessor with exporter and schema defaults. Passing
+      # environment-backed options explicitly prevents it from reading OTEL_*.
       def build_batch_span_processor(cfg)
         exporter = build_span_exporter(cfg.exporter)
         opts = {
-          schedule_delay: cfg.schedule_delay&.to_f,
-          exporter_timeout: cfg.export_timeout&.to_f,
-          max_queue_size: cfg.max_queue_size&.to_i,
-          max_export_batch_size: cfg.max_export_batch_size&.to_i
-        }.compact
+          schedule_delay: (cfg.schedule_delay || Defaults::BATCH_SPAN_PROCESSOR[:schedule_delay]).to_f,
+          exporter_timeout: (cfg.export_timeout || Defaults::BATCH_SPAN_PROCESSOR[:export_timeout]).to_f,
+          max_queue_size: (cfg.max_queue_size || Defaults::BATCH_SPAN_PROCESSOR[:max_queue_size]).to_i,
+          max_export_batch_size: (cfg.max_export_batch_size || Defaults::BATCH_SPAN_PROCESSOR[:max_export_batch_size]).to_i,
+          start_thread_on_boot: true
+        }
 
         OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(exporter, **opts)
       end
@@ -88,17 +92,19 @@ module OpenTelemetry
         exporter
       end
 
-      # Builds an OTLP HTTP span exporter from the given endpoint/headers config.
+      # Builds an OTLP HTTP span exporter from declarative values and schema
+      # defaults, without falling back to exporter environment variables.
       def build_otlp_http_span_exporter(cfg)
-        headers = headers_to_hash(cfg)
-        opts = {
-          endpoint: cfg.endpoint,
-          headers: headers.empty? ? nil : headers,
-          compression: cfg.compression,
-          timeout: cfg.timeout && (cfg.timeout / 1000.0) # YAML ms → Ruby seconds
-        }.compact
-
-        OpenTelemetry::Exporter::OTLP::Exporter.new(**opts)
+        OpenTelemetry::Exporter::OTLP::Exporter.new(
+          endpoint: cfg.endpoint || Defaults::OTLP_HTTP_TRACES_ENDPOINT,
+          certificate_file: cfg.tls&.ca_file,
+          client_certificate_file: cfg.tls&.cert_file,
+          client_key_file: cfg.tls&.key_file,
+          ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER,
+          headers: headers_to_hash(cfg),
+          compression: cfg.compression || Defaults::OTLP_HTTP_EXPORTER[:compression],
+          timeout: (cfg.timeout || Defaults::OTLP_HTTP_EXPORTER[:timeout]) / 1000.0
+        )
       end
 
       # Builds a sampler from config; defaults to ParentBased(ALWAYS_ON).
@@ -139,20 +145,17 @@ module OpenTelemetry
         s.parent_based(**opts)
       end
 
-      # Builds SpanLimits from config; returns the SDK default when config is nil.
+      # Builds SpanLimits from declarative values and schema defaults.
       def build_span_limits(limits_cfg)
-        return OpenTelemetry::SDK::Trace::SpanLimits::DEFAULT unless limits_cfg
-
-        opts = {
-          attribute_count_limit: limits_cfg.attribute_count_limit,
-          attribute_length_limit: limits_cfg.attribute_value_length_limit,
-          event_count_limit: limits_cfg.event_count_limit,
-          link_count_limit: limits_cfg.link_count_limit,
-          event_attribute_count_limit: limits_cfg.event_attribute_count_limit,
-          link_attribute_count_limit: limits_cfg.link_attribute_count_limit
-        }.compact
-
-        OpenTelemetry::SDK::Trace::SpanLimits.new(**opts)
+        OpenTelemetry::SDK::Trace::SpanLimits.new(
+          attribute_count_limit: limits_cfg&.attribute_count_limit || Defaults::SPAN_LIMITS[:attribute_count_limit],
+          attribute_length_limit: limits_cfg&.attribute_value_length_limit || Defaults::SPAN_LIMITS[:attribute_value_length_limit],
+          event_count_limit: limits_cfg&.event_count_limit || Defaults::SPAN_LIMITS[:event_count_limit],
+          link_count_limit: limits_cfg&.link_count_limit || Defaults::SPAN_LIMITS[:link_count_limit],
+          event_attribute_count_limit: limits_cfg&.event_attribute_count_limit || Defaults::SPAN_LIMITS[:event_attribute_count_limit],
+          event_attribute_length_limit: nil,
+          link_attribute_count_limit: limits_cfg&.link_attribute_count_limit || Defaults::SPAN_LIMITS[:link_attribute_count_limit]
+        )
       end
 
       # Converts the OTLP exporter headers (array of NameStringValuePair structs)

data/lib/opentelemetry/config/version.rb

@@ -5,6 +5,6 @@
 
 module OpenTelemetry
   module Config
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/opentelemetry/config.rb

@@ -6,6 +6,7 @@
 require 'date'
 require 'yaml'
 
+require_relative 'config/defaults'
 require_relative 'config/propagation'
 require_relative 'config/resource'
 require_relative 'config/constants'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -78,6 +78,7 @@ files:
 - lib/opentelemetry-config.rb
 - lib/opentelemetry/config.rb
 - lib/opentelemetry/config/constants.rb
+- lib/opentelemetry/config/defaults.rb
 - lib/opentelemetry/config/generated_constants.rb
 - lib/opentelemetry/config/propagation.rb
 - lib/opentelemetry/config/resource.rb
@@ -87,10 +88,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-config/0.1.0/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-config/v0.1.0/config
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-config/0.1.1/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-config/v0.1.1/config
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-config/0.1.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-config/0.1.1
 rdoc_options: []
 require_paths:
 - lib