Declarative Configuration

Complete reference for OpenTelemetry SDK declarative configuration schema types, properties, and constraints

Overview

OpenTelemetry supports declarative configuration through a standardized YAML/JSON schema that allows you to configure SDK behavior without writing code. This approach provides a consistent configuration experience across all languages that implement the specification.

Related Resources:

Language Implementation Status - See which languages support which types
Configuration Schema Repository - Official schema repository
File Configuration Specification - Official specification

Search types

Type category

Showing 0 of 0 types

Declarative Configuration Schema

This page documents all configuration types for the OpenTelemetry SDK declarative configuration.

Note

Properties marked with ^* are required.
Default behavior will also apply if a property is explicitly set to null.

Stable Types

Aggregation

Property	Type	Default Behavior	Description
`base2_exponential_bucket_histogram`	`Base2ExponentialBucketHistogramAggregation`	If omitted, ignore.	Configures the stream to collect data for the exponential histogram metric point, which uses a base-2 exponential formula to determine bucket boundaries and an integer scale parameter to control resolution. (See here for more details).
`default`	`DefaultAggregation`	If omitted, ignore.	Configures the stream to use the instrument kind to select an aggregation and advisory parameters to influence aggregation configuration parameters. (See here for more details).
`drop`	`DropAggregation`	If omitted, ignore.	Configures the stream to ignore/drop all instrument measurements. (See here for more details).
`explicit_bucket_histogram`	`ExplicitBucketHistogramAggregation`	If omitted, ignore.	Configures the stream to collect data for the histogram metric point using a set of explicit boundary values for histogram bucketing. (See here for more details)
`last_value`	`LastValueAggregation`	If omitted, ignore.	Configures the stream to collect data using the last measurement. (See here for more details).
`sum`	`SumAggregation`	If omitted, ignore.	Configures the stream to collect the arithmetic sum of measurement values. (See here for more details).

Constraints:

• additionalProperties: false
• minProperties: 1
• maxProperties: 1

AlwaysOffSampler

No properties.

Constraints:

additionalProperties: false

AlwaysOnSampler

No properties.

Constraints:

additionalProperties: false

AttributeLimits

Property	Type	Default Behavior	Constraints	Description
`attribute_count_limit`	one of: • `integer` • `null`	If omitted or null, 128 is used.	`minimum`: `0`	Configure max attribute count. Value must be non-negative.
`attribute_value_length_limit`	one of: • `integer` • `null`	If omitted or null, there is no limit.	`minimum`: `0`	Configure max attribute value size. Value must be non-negative.

Constraints:

additionalProperties: false

AttributeNameValue

Property	Type	Default Behavior	Description
`name`^*	`string`	Property is required and must be non-null.	The attribute name.
`type`	`AttributeType`	If omitted, string is used.	The attribute type.
`value`^*	`oneOf`	Property is required and must be non-null.	The attribute value. The type of value must match .type.

Constraints:

• additionalProperties: false
• required: ["name","value"]

AttributeType

This is an enum type.

Value	Description
`bool`	Boolean attribute value.
`bool_array`	Boolean array attribute value.
`double`	Double attribute value.
`double_array`	Double array attribute value.
`int`	Integer attribute value.
`int_array`	Integer array attribute value.
`string`	String attribute value.
`string_array`	String array attribute value.

B3MultiPropagator

No properties.

Constraints:

additionalProperties: false

B3Propagator

No properties.

Constraints:

additionalProperties: false

BaggagePropagator

No properties.

Constraints:

additionalProperties: false

Base2ExponentialBucketHistogramAggregation

Property	Type	Default Behavior	Constraints	Description
`max_scale`	one of: • `integer` • `null`	If omitted or null, 20 is used.	• `minimum`: `-10` • `maximum`: `20`	Configure the max scale factor.
`max_size`	one of: • `integer` • `null`	If omitted or null, 160 is used.	`minimum`: `2`	Configure the maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket.
`record_min_max`	one of: • `boolean` • `null`	If omitted or null, true is used.	None.	Configure whether or not to record min and max.

Constraints:

additionalProperties: false

BatchLogRecordProcessor

Property	Type	Default Behavior	Constraints	Description
`export_timeout`	one of: • `integer` • `null`	If omitted or null, 30000 is used.	`minimum`: `0`	Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity).
`exporter`^*	`LogRecordExporter`	Property is required and must be non-null.	None.	Configure exporter.
`max_export_batch_size`	one of: • `integer` • `null`	If omitted or null, 512 is used.	`exclusiveMinimum`: `0`	Configure maximum batch size. Value must be positive.
`max_queue_size`	one of: • `integer` • `null`	If omitted or null, 2048 is used.	`exclusiveMinimum`: `0`	Configure maximum queue size. Value must be positive.
`schedule_delay`	one of: • `integer` • `null`	If omitted or null, 1000 is used.	`minimum`: `0`	Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative.

Constraints:

• additionalProperties: false
• required: ["exporter"]

BatchSpanProcessor

Property	Type	Default Behavior	Constraints	Description
`export_timeout`	one of: • `integer` • `null`	If omitted or null, 30000 is used.	`minimum`: `0`	Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity).
`exporter`^*	`SpanExporter`	Property is required and must be non-null.	None.	Configure exporter.
`max_export_batch_size`	one of: • `integer` • `null`	If omitted or null, 512 is used.	`exclusiveMinimum`: `0`	Configure maximum batch size. Value must be positive.
`max_queue_size`	one of: • `integer` • `null`	If omitted or null, 2048 is used.	`exclusiveMinimum`: `0`	Configure maximum queue size. Value must be positive.
`schedule_delay`	one of: • `integer` • `null`	If omitted or null, 5000 is used.	`minimum`: `0`	Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative.

Constraints:

• additionalProperties: false
• required: ["exporter"]

CardinalityLimits

Property	Type	Default Behavior	Constraints	Description
`counter`	one of: • `integer` • `null`	If omitted or null, the value from .default is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for counter instruments.
`default`	one of: • `integer` • `null`	If omitted or null, 2000 is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority.
`gauge`	one of: • `integer` • `null`	If omitted or null, the value from .default is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for gauge instruments.
`histogram`	one of: • `integer` • `null`	If omitted or null, the value from .default is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for histogram instruments.
`observable_counter`	one of: • `integer` • `null`	If omitted or null, the value from .default is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for observable_counter instruments.
`observable_gauge`	one of: • `integer` • `null`	If omitted or null, the value from .default is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for observable_gauge instruments.
`observable_up_down_counter`	one of: • `integer` • `null`	If omitted or null, the value from .default is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for observable_up_down_counter instruments.
`up_down_counter`	one of: • `integer` • `null`	If omitted or null, the value from .default is used.	`exclusiveMinimum`: `0`	Configure default cardinality limit for up_down_counter instruments.

Constraints:

additionalProperties: false

ConsoleExporter

No properties.

Constraints:

additionalProperties: false

ConsoleMetricExporter

Property	Type	Default Behavior	Description
`default_histogram_aggregation`	`ExporterDefaultHistogramAggregation`	If omitted, explicit_bucket_histogram is used.	Configure default histogram aggregation.
`temporality_preference`	`ExporterTemporalityPreference`	If omitted, cumulative is used.	Configure temporality preference.

Constraints:

additionalProperties: false

DefaultAggregation

No properties.

Constraints:

additionalProperties: false

Distribution

No properties.

Constraints:

• additionalProperties: {"type":"object"}
• minProperties: 1

DropAggregation

No properties.

Constraints:

additionalProperties: false

ExemplarFilter

This is an enum type.

Value	Description
`always_off`	ExemplarFilter which makes no measurements eligible for being an Exemplar.
`always_on`	ExemplarFilter which makes all measurements eligible for being an Exemplar.
`trace_based`	ExemplarFilter which makes measurements recorded in the context of a sampled parent span eligible for being an Exemplar.

ExplicitBucketHistogramAggregation

Property	Type	Default Behavior	Constraints	Description
`boundaries`	`array` of `number`	If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used.	`minItems`: `0`	Configure bucket boundaries.
`record_min_max`	one of: • `boolean` • `null`	If omitted or null, true is used.	None.	Configure record min and max.

Constraints:

additionalProperties: false

ExporterDefaultHistogramAggregation

This is an enum type.

Value	Description
`base2_exponential_bucket_histogram`	Use base2 exponential histogram as the default aggregation for histogram instruments.
`explicit_bucket_histogram`	Use explicit bucket histogram as the default aggregation for histogram instruments.

ExporterTemporalityPreference

This is an enum type.

Value	Description
`cumulative`	Use cumulative aggregation temporality for all instrument types.
`delta`	Use delta aggregation for all instrument types except up down counter and asynchronous up down counter.
`low_memory`	Use delta aggregation temporality for counter and histogram instrument types. Use cumulative aggregation temporality for all other instrument types.

GrpcTls

Property	Type	Default Behavior	Description
`ca_file`	one of: • `string` • `null`	If omitted or null, system default certificate verification is used for secure connections.	Configure certificate used to verify a server’s TLS credentials. Absolute path to certificate file in PEM format.
`cert_file`	one of: • `string` • `null`	If omitted or null, mTLS is not used.	Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
`insecure`	one of: • `boolean` • `null`	If omitted or null, false is used.	Configure client transport security for the exporter’s connection. Only applicable when .endpoint is provided without http or https scheme. Implementations may choose to ignore .insecure.
`key_file`	one of: • `string` • `null`	If omitted or null, mTLS is not used.	Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set.

Constraints:

additionalProperties: false

HttpTls

Property	Type	Default Behavior	Description
`ca_file`	one of: • `string` • `null`	If omitted or null, system default certificate verification is used for secure connections.	Configure certificate used to verify a server’s TLS credentials. Absolute path to certificate file in PEM format.
`cert_file`	one of: • `string` • `null`	If omitted or null, mTLS is not used.	Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
`key_file`	one of: • `string` • `null`	If omitted or null, mTLS is not used.	Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set.

Constraints:

additionalProperties: false

IncludeExclude

Property	Type	Default Behavior	Constraints	Description
`excluded`	`array` of `string`	If omitted, .included attributes are included.	`minItems`: `1`	Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included). Values are evaluated to match as follows: If the value exactly matches. If the value matches the wildcard pattern, where ‘?’ matches any single character and ‘*’ matches any number of characters including none.
`included`	`array` of `string`	If omitted, all values are included.	`minItems`: `1`	Configure list of value patterns to include. Values are evaluated to match as follows: If the value exactly matches. If the value matches the wildcard pattern, where ‘?’ matches any single character and ‘*’ matches any number of characters including none.

Constraints:

additionalProperties: false

InstrumentType

This is an enum type.

Value	Description
`counter`	Synchronous counter instruments.
`gauge`	Synchronous gauge instruments.
`histogram`	Synchronous histogram instruments.
`observable_counter`	Asynchronous counter instruments.
`observable_gauge`	Asynchronous gauge instruments.
`observable_up_down_counter`	Asynchronous up down counter instruments.
`up_down_counter`	Synchronous up down counter instruments.

JaegerPropagator

No properties.

Constraints:

additionalProperties: false

LastValueAggregation

No properties.

Constraints:

additionalProperties: false

LoggerProvider

Property	Type	Default Behavior	Constraints	Description
`limits`	`LogRecordLimits`	If omitted, default values as described in LogRecordLimits are used.	None.	Configure log record limits. See also attribute_limits.
`processors`^*	`array` of `LogRecordProcessor`	Property is required and must be non-null.	`minItems`: `1`	Configure log record processors.
`logger_configurator/development` ⚠ Experimental	`ExperimentalLoggerConfigurator`	If omitted, all loggers use default values as described in ExperimentalLoggerConfig.	None.	Configure loggers.

Constraints:

• additionalProperties: false
• required: ["processors"]

LogRecordExporter

LogRecordExporter is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`console`	`ConsoleExporter`	If omitted, ignore.	Configure exporter to be console.
`otlp_grpc`	`OtlpGrpcExporter`	If omitted, ignore.	Configure exporter to be OTLP with gRPC transport.
`otlp_http`	`OtlpHttpExporter`	If omitted, ignore.	Configure exporter to be OTLP with HTTP transport.
`otlp_file/development` ⚠ Experimental	`ExperimentalOtlpFileExporter`	If omitted, ignore.	Configure exporter to be OTLP with file transport.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

LogRecordLimits

Property	Type	Default Behavior	Constraints	Description
`attribute_count_limit`	one of: • `integer` • `null`	If omitted or null, 128 is used.	`minimum`: `0`	Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative.
`attribute_value_length_limit`	one of: • `integer` • `null`	If omitted or null, there is no limit.	`minimum`: `0`	Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative.

Constraints:

additionalProperties: false

LogRecordProcessor

LogRecordProcessor is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`batch`	`BatchLogRecordProcessor`	If omitted, ignore.	Configure a batch log record processor.
`simple`	`SimpleLogRecordProcessor`	If omitted, ignore.	Configure a simple log record processor.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

MeterProvider

Property	Type	Default Behavior	Constraints	Description
`exemplar_filter`	`ExemplarFilter`	If omitted, trace_based is used.	None.	Configure the exemplar filter.
`readers`^*	`array` of `MetricReader`	Property is required and must be non-null.	`minItems`: `1`	Configure metric readers.
`views`	`array` of `View`	If omitted, no views are registered.	`minItems`: `1`	Configure views. Each view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s).
`meter_configurator/development` ⚠ Experimental	`ExperimentalMeterConfigurator`	If omitted, all meters use default values as described in ExperimentalMeterConfig.	None.	Configure meters.

Constraints:

• additionalProperties: false
• required: ["readers"]

MetricProducer

MetricProducer is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`opencensus`	`OpenCensusMetricProducer`	If omitted, ignore.	Configure metric producer to be opencensus.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

MetricReader

Property	Type	Default Behavior	Description
`periodic`	`PeriodicMetricReader`	If omitted, ignore.	Configure a periodic metric reader.
`pull`	`PullMetricReader`	If omitted, ignore.	Configure a pull based metric reader.

Constraints:

• additionalProperties: false
• minProperties: 1
• maxProperties: 1

NameStringValuePair

Property	Type	Default Behavior	Description
`name`^*	`string`	Property is required and must be non-null.	The name of the pair.
`value`^*	one of: • `string` • `null`	Property must be present, but if null the behavior is dependent on usage context.	The value of the pair.

Constraints:

• additionalProperties: false
• required: ["name","value"]

OpenCensusMetricProducer

No properties.

Constraints:

additionalProperties: false

OpenTelemetryConfiguration

Property	Type	Default Behavior	Description
`attribute_limits`	`AttributeLimits`	If omitted, default values as described in AttributeLimits are used.	Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.
`disabled`	one of: • `boolean` • `null`	If omitted or null, false is used.	Configure if the SDK is disabled or not.
`distribution`	`Distribution`	If omitted, distribution defaults are used.	Defines configuration parameters specific to a particular OpenTelemetry distribution or vendor. This section provides a standardized location for distribution-specific settings that are not part of the OpenTelemetry configuration model. It allows vendors to expose their own extensions and general configuration options.
`file_format`^*	`string`	Property is required and must be non-null.	The file format version. Represented as a string including the semver major, minor version numbers (and optionally the meta tag). For example: “0.4”, “1.0-rc.2”, “1.0” (after stable release). (See here for more details). The yaml format is documented at https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
`log_level`	`SeverityNumber`	If omitted, INFO is used.	Configure the log level of the internal logger used by the SDK.
`logger_provider`	`LoggerProvider`	If omitted, a noop logger provider is used.	Configure logger provider.
`meter_provider`	`MeterProvider`	If omitted, a noop meter provider is used.	Configure meter provider.
`propagator`	`Propagator`	If omitted, a noop propagator is used.	Configure text map context propagators.
`resource`	`Resource`	If omitted, the default resource is used.	Configure resource for all signals.
`tracer_provider`	`TracerProvider`	If omitted, a noop tracer provider is used.	Configure tracer provider.
`instrumentation/development` ⚠ Experimental	`ExperimentalInstrumentation`	If omitted, instrumentation defaults are used.	Configure instrumentation.

Constraints:

• additionalProperties: true
• required: ["file_format"]

OpenTracingPropagator

No properties.

Constraints:

additionalProperties: false

OtlpGrpcExporter

Property	Type	Default Behavior	Constraints	Description
`compression`	one of: • `string` • `null`	If omitted or null, none is used.	None.	Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms.
`endpoint`	one of: • `string` • `null`	If omitted or null, http://localhost:4317 is used.	None.	Configure endpoint.
`headers`	`array` of `NameStringValuePair`	If omitted, no headers are added.	`minItems`: `1`	Configure headers. Entries have higher priority than entries from .headers_list. If an entry’s .value is null, the entry is ignored.
`headers_list`	one of: • `string` • `null`	If omitted or null, no headers are added.	None.	Configure headers. Entries have lower priority than entries from .headers. The value is a list of comma separated key-value pairs matching the format of OTEL_EXPORTER_OTLP_HEADERS. (See here for more details).
`timeout`	one of: • `integer` • `null`	If omitted or null, 10000 is used.	`minimum`: `0`	Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity).
`tls`	`GrpcTls`	If omitted, system default TLS settings are used.	None.	Configure TLS settings for the exporter.

Constraints:

additionalProperties: false

OtlpGrpcMetricExporter

Property	Type	Default Behavior	Constraints	Description
`compression`	one of: • `string` • `null`	If omitted or null, none is used.	None.	Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms.
`default_histogram_aggregation`	`ExporterDefaultHistogramAggregation`	If omitted, explicit_bucket_histogram is used.	None.	Configure default histogram aggregation.
`endpoint`	one of: • `string` • `null`	If omitted or null, http://localhost:4317 is used.	None.	Configure endpoint.
`headers`	`array` of `NameStringValuePair`	If omitted, no headers are added.	`minItems`: `1`	Configure headers. Entries have higher priority than entries from .headers_list. If an entry’s .value is null, the entry is ignored.
`headers_list`	one of: • `string` • `null`	If omitted or null, no headers are added.	None.	Configure headers. Entries have lower priority than entries from .headers. The value is a list of comma separated key-value pairs matching the format of OTEL_EXPORTER_OTLP_HEADERS. (See here for more details).
`temporality_preference`	`ExporterTemporalityPreference`	If omitted, cumulative is used.	None.	Configure temporality preference.
`timeout`	one of: • `integer` • `null`	If omitted or null, 10000 is used.	`minimum`: `0`	Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity).
`tls`	`GrpcTls`	If omitted, system default TLS settings are used.	None.	Configure TLS settings for the exporter.

Constraints:

additionalProperties: false

OtlpHttpEncoding

This is an enum type.

Value	Description
`json`	Protobuf JSON encoding.
`protobuf`	Protobuf binary encoding.

OtlpHttpExporter

Property	Type	Default Behavior	Constraints	Description
`compression`	one of: • `string` • `null`	If omitted or null, none is used.	None.	Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms.
`encoding`	`OtlpHttpEncoding`	If omitted, protobuf is used.	None.	Configure the encoding used for messages. Implementations may not support json.
`endpoint`	one of: • `string` • `null`	If omitted or null, the http://localhost:4318/v1/{signal} (where signal is ’traces’, ’logs’, or ‘metrics’) is used.	None.	Configure endpoint, including the signal specific path.
`headers`	`array` of `NameStringValuePair`	If omitted, no headers are added.	`minItems`: `1`	Configure headers. Entries have higher priority than entries from .headers_list. If an entry’s .value is null, the entry is ignored.
`headers_list`	one of: • `string` • `null`	If omitted or null, no headers are added.	None.	Configure headers. Entries have lower priority than entries from .headers. The value is a list of comma separated key-value pairs matching the format of OTEL_EXPORTER_OTLP_HEADERS. (See here for more details).
`timeout`	one of: • `integer` • `null`	If omitted or null, 10000 is used.	`minimum`: `0`	Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity).
`tls`	`HttpTls`	If omitted, system default TLS settings are used.	None.	Configure TLS settings for the exporter.

Constraints:

additionalProperties: false

OtlpHttpMetricExporter

Property	Type	Default Behavior	Constraints	Description
`compression`	one of: • `string` • `null`	If omitted or null, none is used.	None.	Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms.
`default_histogram_aggregation`	`ExporterDefaultHistogramAggregation`	If omitted, explicit_bucket_histogram is used.	None.	Configure default histogram aggregation.
`encoding`	`OtlpHttpEncoding`	If omitted, protobuf is used.	None.	Configure the encoding used for messages. Implementations may not support json.
`endpoint`	one of: • `string` • `null`	If omitted or null, http://localhost:4318/v1/metrics is used.	None.	Configure endpoint.
`headers`	`array` of `NameStringValuePair`	If omitted, no headers are added.	`minItems`: `1`	Configure headers. Entries have higher priority than entries from .headers_list. If an entry’s .value is null, the entry is ignored.
`headers_list`	one of: • `string` • `null`	If omitted or null, no headers are added.	None.	Configure headers. Entries have lower priority than entries from .headers. The value is a list of comma separated key-value pairs matching the format of OTEL_EXPORTER_OTLP_HEADERS. (See here for more details).
`temporality_preference`	`ExporterTemporalityPreference`	If omitted, cumulative is used.	None.	Configure temporality preference.
`timeout`	one of: • `integer` • `null`	If omitted or null, 10000 is used.	`minimum`: `0`	Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity).
`tls`	`HttpTls`	If omitted, system default TLS settings are used.	None.	Configure TLS settings for the exporter.

Constraints:

additionalProperties: false

ParentBasedSampler

Property	Type	Default Behavior	Description
`local_parent_not_sampled`	`Sampler`	If omitted, always_off is used.	Configure local_parent_not_sampled sampler.
`local_parent_sampled`	`Sampler`	If omitted, always_on is used.	Configure local_parent_sampled sampler.
`remote_parent_not_sampled`	`Sampler`	If omitted, always_off is used.	Configure remote_parent_not_sampled sampler.
`remote_parent_sampled`	`Sampler`	If omitted, always_on is used.	Configure remote_parent_sampled sampler.
`root`	`Sampler`	If omitted, always_on is used.	Configure root sampler.

Constraints:

additionalProperties: false

PeriodicMetricReader

Property	Type	Default Behavior	Constraints	Description
`cardinality_limits`	`CardinalityLimits`	If omitted, default values as described in CardinalityLimits are used.	None.	Configure cardinality limits.
`exporter`^*	`PushMetricExporter`	Property is required and must be non-null.	None.	Configure exporter.
`interval`	one of: • `integer` • `null`	If omitted or null, 60000 is used.	`minimum`: `0`	Configure delay interval (in milliseconds) between start of two consecutive exports. Value must be non-negative.
`producers`	`array` of `MetricProducer`	If omitted, no metric producers are added.	`minItems`: `1`	Configure metric producers.
`timeout`	one of: • `integer` • `null`	If omitted or null, 30000 is used.	`minimum`: `0`	Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity).

Constraints:

• additionalProperties: false
• required: ["exporter"]

Propagator

Property	Type	Default Behavior	Constraints	Description
`composite`	`array` of `TextMapPropagator`	If omitted, and .composite_list is omitted or null, a noop propagator is used.	`minItems`: `1`	Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out. Built-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray.
`composite_list`	one of: • `string` • `null`	If omitted or null, and .composite is omitted or null, a noop propagator is used.	None.	Configure the propagators in the composite text map propagator. Entries are appended to .composite with duplicates filtered out. The value is a comma separated list of propagator identifiers matching the format of OTEL_PROPAGATORS. (See here for more details). Built-in propagator identifiers include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party identifiers include: xray.

Constraints:

additionalProperties: false

PullMetricExporter

PullMetricExporter is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`prometheus/development` ⚠ Experimental	`ExperimentalPrometheusMetricExporter`	If omitted, ignore.	Configure exporter to be prometheus.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

PullMetricReader

Property	Type	Default Behavior	Constraints	Description
`cardinality_limits`	`CardinalityLimits`	If omitted, default values as described in CardinalityLimits are used.	None.	Configure cardinality limits.
`exporter`^*	`PullMetricExporter`	Property is required and must be non-null.	None.	Configure exporter.
`producers`	`array` of `MetricProducer`	If omitted, no metric producers are added.	`minItems`: `1`	Configure metric producers.

Constraints:

• additionalProperties: false
• required: ["exporter"]

PushMetricExporter

PushMetricExporter is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`console`	`ConsoleMetricExporter`	If omitted, ignore.	Configure exporter to be console.
`otlp_grpc`	`OtlpGrpcMetricExporter`	If omitted, ignore.	Configure exporter to be OTLP with gRPC transport.
`otlp_http`	`OtlpHttpMetricExporter`	If omitted, ignore.	Configure exporter to be OTLP with HTTP transport.
`otlp_file/development` ⚠ Experimental	`ExperimentalOtlpFileMetricExporter`	If omitted, ignore.	Configure exporter to be OTLP with file transport.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

Resource

Property	Type	Default Behavior	Constraints	Description
`attributes`	`array` of `AttributeNameValue`	If omitted, no resource attributes are added.	`minItems`: `1`	Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.
`attributes_list`	one of: • `string` • `null`	If omitted or null, no resource attributes are added.	None.	Configure resource attributes. Entries have lower priority than entries from .resource.attributes. The value is a list of comma separated key-value pairs matching the format of OTEL_RESOURCE_ATTRIBUTES. (See here for more details).
`schema_url`	one of: • `string` • `null`	If omitted or null, no schema URL is used.	None.	Configure resource schema URL.
`detection/development` ⚠ Experimental	`ExperimentalResourceDetection`	If omitted, resource detection is disabled.	None.	Configure resource detection.

Constraints:

additionalProperties: false

Sampler

Sampler is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`always_off`	`AlwaysOffSampler`	If omitted, ignore.	Configure sampler to be always_off.
`always_on`	`AlwaysOnSampler`	If omitted, ignore.	Configure sampler to be always_on.
`parent_based`	`ParentBasedSampler`	If omitted, ignore.	Configure sampler to be parent_based.
`trace_id_ratio_based`	`TraceIdRatioBasedSampler`	If omitted, ignore.	Configure sampler to be trace_id_ratio_based.
`composite/development` ⚠ Experimental	`ExperimentalComposableSampler`	If omitted, ignore.	Configure sampler to be composite.
`jaeger_remote/development` ⚠ Experimental	`ExperimentalJaegerRemoteSampler`	If omitted, ignore.	Configure sampler to be jaeger_remote.
`probability/development` ⚠ Experimental	`ExperimentalProbabilitySampler`	If omitted, ignore.	Configure sampler to be probability.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

SeverityNumber

This is an enum type.

Value	Description
`debug`	debug, severity number 5.
`debug2`	debug2, severity number 6.
`debug3`	debug3, severity number 7.
`debug4`	debug4, severity number 8.
`error`	error, severity number 17.
`error2`	error2, severity number 18.
`error3`	error3, severity number 19.
`error4`	error4, severity number 20.
`fatal`	fatal, severity number 21.
`fatal2`	fatal2, severity number 22.
`fatal3`	fatal3, severity number 23.
`fatal4`	fatal4, severity number 24.
`info`	info, severity number 9.
`info2`	info2, severity number 10.
`info3`	info3, severity number 11.
`info4`	info4, severity number 12.
`trace`	trace, severity number 1.
`trace2`	trace2, severity number 2.
`trace3`	trace3, severity number 3.
`trace4`	trace4, severity number 4.
`warn`	warn, severity number 13.
`warn2`	warn2, severity number 14.
`warn3`	warn3, severity number 15.
`warn4`	warn4, severity number 16.

SimpleLogRecordProcessor

Property	Type	Default Behavior	Description
`exporter`^*	`LogRecordExporter`	Property is required and must be non-null.	Configure exporter.

Constraints:

• additionalProperties: false
• required: ["exporter"]

SimpleSpanProcessor

Property	Type	Default Behavior	Description
`exporter`^*	`SpanExporter`	Property is required and must be non-null.	Configure exporter.

Constraints:

• additionalProperties: false
• required: ["exporter"]

SpanExporter

SpanExporter is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`console`	`ConsoleExporter`	If omitted, ignore.	Configure exporter to be console.
`otlp_grpc`	`OtlpGrpcExporter`	If omitted, ignore.	Configure exporter to be OTLP with gRPC transport.
`otlp_http`	`OtlpHttpExporter`	If omitted, ignore.	Configure exporter to be OTLP with HTTP transport.
`otlp_file/development` ⚠ Experimental	`ExperimentalOtlpFileExporter`	If omitted, ignore.	Configure exporter to be OTLP with file transport.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

SpanKind

This is an enum type.

Value	Description
`client`	client, a client span.
`consumer`	consumer, a consumer span.
`internal`	internal, an internal span.
`producer`	producer, a producer span.
`server`	server, a server span.

SpanLimits

Property	Type	Default Behavior	Constraints	Description
`attribute_count_limit`	one of: • `integer` • `null`	If omitted or null, 128 is used.	`minimum`: `0`	Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative.
`attribute_value_length_limit`	one of: • `integer` • `null`	If omitted or null, there is no limit.	`minimum`: `0`	Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative.
`event_attribute_count_limit`	one of: • `integer` • `null`	If omitted or null, 128 is used.	`minimum`: `0`	Configure max attributes per span event. Value must be non-negative.
`event_count_limit`	one of: • `integer` • `null`	If omitted or null, 128 is used.	`minimum`: `0`	Configure max span event count. Value must be non-negative.
`link_attribute_count_limit`	one of: • `integer` • `null`	If omitted or null, 128 is used.	`minimum`: `0`	Configure max attributes per span link. Value must be non-negative.
`link_count_limit`	one of: • `integer` • `null`	If omitted or null, 128 is used.	`minimum`: `0`	Configure max span link count. Value must be non-negative.

Constraints:

additionalProperties: false

SpanProcessor

SpanProcessor is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`batch`	`BatchSpanProcessor`	If omitted, ignore.	Configure a batch span processor.
`simple`	`SimpleSpanProcessor`	If omitted, ignore.	Configure a simple span processor.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

SumAggregation

No properties.

Constraints:

additionalProperties: false

TextMapPropagator

TextMapPropagator is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`b3`	`B3Propagator`	If omitted, ignore.	Include the zipkin b3 propagator.
`b3multi`	`B3MultiPropagator`	If omitted, ignore.	Include the zipkin b3 multi propagator.
`baggage`	`BaggagePropagator`	If omitted, ignore.	Include the w3c baggage propagator.
`jaeger`	`JaegerPropagator`	If omitted, ignore.	Include the jaeger propagator.
`ottrace`	`OpenTracingPropagator`	If omitted, ignore.	Include the opentracing propagator.
`tracecontext`	`TraceContextPropagator`	If omitted, ignore.	Include the w3c trace context propagator.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

TraceContextPropagator

No properties.

Constraints:

additionalProperties: false

TraceIdRatioBasedSampler

Property	Type	Default Behavior	Constraints	Description
`ratio`	one of: • `number` • `null`	If omitted or null, 1.0 is used.	• `minimum`: `0` • `maximum`: `1`	Configure trace_id_ratio.

Constraints:

additionalProperties: false

TracerProvider

Property	Type	Default Behavior	Constraints	Description
`limits`	`SpanLimits`	If omitted, default values as described in SpanLimits are used.	None.	Configure span limits. See also attribute_limits.
`processors`^*	`array` of `SpanProcessor`	Property is required and must be non-null.	`minItems`: `1`	Configure span processors.
`sampler`	`Sampler`	If omitted, parent based sampler with a root of always_on is used.	None.	Configure the sampler.
`tracer_configurator/development` ⚠ Experimental	`ExperimentalTracerConfigurator`	If omitted, all tracers use default values as described in ExperimentalTracerConfig.	None.	Configure tracers.

Constraints:

• additionalProperties: false
• required: ["processors"]

View

Property	Type	Default Behavior	Description
`selector`^*	`ViewSelector`	Property is required and must be non-null.	Configure view selector. Selection criteria is additive as described in </docs/specs/otel/metrics/sdk.md#instrument-selection-criteria>.
`stream`^*	`ViewStream`	Property is required and must be non-null.	Configure view stream.

Constraints:

• additionalProperties: false
• required: ["selector","stream"]

ViewSelector

Property	Type	Default Behavior	Description
`instrument_name`	one of: • `string` • `null`	If omitted or null, all instrument names match.	Configure instrument name selection criteria.
`instrument_type`	`InstrumentType`	If omitted, all instrument types match.	Configure instrument type selection criteria.
`meter_name`	one of: • `string` • `null`	If omitted or null, all meter names match.	Configure meter name selection criteria.
`meter_schema_url`	one of: • `string` • `null`	If omitted or null, all meter schema URLs match.	Configure meter schema url selection criteria.
`meter_version`	one of: • `string` • `null`	If omitted or null, all meter versions match.	Configure meter version selection criteria.
`unit`	one of: • `string` • `null`	If omitted or null, all instrument units match.	Configure the instrument unit selection criteria.

Constraints:

additionalProperties: false

ViewStream

Property	Type	Default Behavior	Constraints	Description
`aggregation`	`Aggregation`	If omitted, default is used.	None.	Configure aggregation of the resulting stream(s).
`aggregation_cardinality_limit`	one of: • `integer` • `null`	If omitted or null, the metric reader’s default cardinality limit is used.	`exclusiveMinimum`: `0`	Configure the aggregation cardinality limit.
`attribute_keys`	`IncludeExclude`	If omitted, all attribute keys are retained.	None.	Configure attribute keys retained in the resulting stream(s).
`description`	one of: • `string` • `null`	If omitted or null, the instrument’s origin description is used.	None.	Configure metric description of the resulting stream(s).
`name`	one of: • `string` • `null`	If omitted or null, the instrument’s original name is used.	None.	Configure metric name of the resulting stream(s).

Constraints:

additionalProperties: false

Experimental Types

Warning: Experimental types are subject to breaking changes.

ExperimentalComposableAlwaysOffSampler

No properties.

Constraints:

additionalProperties: false

ExperimentalComposableAlwaysOnSampler

No properties.

Constraints:

additionalProperties: false

ExperimentalComposableParentThresholdSampler

Property	Type	Default Behavior	Description
`root`^*	`ExperimentalComposableSampler`	Property is required and must be non-null.	Sampler to use when there is no parent.

Constraints:

• additionalProperties: false
• required: ["root"]

ExperimentalComposableProbabilitySampler

Property	Type	Default Behavior	Constraints	Description
`ratio`	one of: • `number` • `null`	If omitted or null, 1.0 is used.	• `minimum`: `0` • `maximum`: `1`	Configure ratio.

Constraints:

additionalProperties: false

ExperimentalComposableRuleBasedSampler

Property	Type	Default Behavior	Description
`rules`	one of: • `array` • `null`	If omitted or null, no span is sampled.	The rules for the sampler, matched in order. If no rules match, the span is not sampled.

Constraints:

additionalProperties: false

ExperimentalComposableRuleBasedSamplerRule

A rule for ExperimentalComposableRuleBasedSampler. A rule can have multiple match conditions - the sampler will be applied if all match. If no conditions are specified, the rule matches all spans that reach it.

Property	Type	Default Behavior	Constraints	Description
`attribute_patterns`	`ExperimentalComposableRuleBasedSamplerRuleAttributePatterns`	If omitted, ignore.	None.	Patterns to match against a single attribute. Non-string attributes are matched using their string representation: for example, a pattern of “4*” would match any http.response.status_code in 400-499. For array attributes, if any item matches, it is considered a match.
`attribute_values`	`ExperimentalComposableRuleBasedSamplerRuleAttributeValues`	If omitted, ignore.	None.	Values to match against a single attribute. Non-string attributes are matched using their string representation: for example, a value of “404” would match the http.response.status_code 404. For array attributes, if any item matches, it is considered a match.
`parent`	`array` of `ExperimentalSpanParent`	If omitted, ignore.	`minItems`: `1`	The parent span types to match.
`sampler`^*	`ExperimentalComposableSampler`	Property is required and must be non-null.	None.	The sampler to use for matching spans.
`span_kinds`	`array` of `SpanKind`	If omitted, ignore.	`minItems`: `1`	The span kinds to match. If the span’s kind matches any of these, it matches.

Constraints:

• additionalProperties: false
• required: ["sampler"]

ExperimentalComposableRuleBasedSamplerRuleAttributePatterns

Property	Type	Default Behavior	Constraints	Description
`excluded`	`array` of `string`	If omitted, .included attributes are included.	`minItems`: `1`	Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included). Values are evaluated to match as follows: If the value exactly matches. If the value matches the wildcard pattern, where ‘?’ matches any single character and ‘*’ matches any number of characters including none.
`included`	`array` of `string`	If omitted, all values are included.	`minItems`: `1`	Configure list of value patterns to include. Values are evaluated to match as follows: If the value exactly matches. If the value matches the wildcard pattern, where ‘?’ matches any single character and ‘*’ matches any number of characters including none.
`key`^*	`string`	Property is required and must be non-null.	None.	The attribute key to match against.

Constraints:

• additionalProperties: false
• required: ["key"]

ExperimentalComposableRuleBasedSamplerRuleAttributeValues

Property	Type	Default Behavior	Constraints	Description
`key`^*	`string`	Property is required and must be non-null.	None.	The attribute key to match against.
`values`^*	`array` of `string`	Property is required and must be non-null.	`minItems`: `1`	The attribute values to match against. If the attribute’s value matches any of these, it matches.

Constraints:

• additionalProperties: false
• required: ["key","values"]

ExperimentalComposableSampler

Property	Type	Default Behavior	Description
`always_off`	`ExperimentalComposableAlwaysOffSampler`	If omitted, ignore.	Configure sampler to be always_off.
`always_on`	`ExperimentalComposableAlwaysOnSampler`	If omitted, ignore.	Configure sampler to be always_on.
`parent_threshold`	`ExperimentalComposableParentThresholdSampler`	If omitted, ignore.	Configure sampler to be parent_threshold.
`probability`	`ExperimentalComposableProbabilitySampler`	If omitted, ignore.	Configure sampler to be probability.
`rule_based`	`ExperimentalComposableRuleBasedSampler`	If omitted, ignore.	Configure sampler to be rule_based.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

ExperimentalContainerResourceDetector

No properties.

Constraints:

additionalProperties: false

ExperimentalGeneralInstrumentation

Property	Type	Default Behavior	Description
`http`	`ExperimentalHttpInstrumentation`	If omitted, defaults as described in ExperimentalHttpInstrumentation are used.	Configure instrumentations following the http semantic conventions. See http semantic conventions: </docs/specs/semconv/http/>
`peer`	`ExperimentalPeerInstrumentation`	If omitted, defaults as described in ExperimentalPeerInstrumentation are used.	Configure instrumentations following the peer semantic conventions. See peer semantic conventions: </docs/specs/semconv/attributes-registry/peer/>

Constraints:

additionalProperties: false

ExperimentalHostResourceDetector

No properties.

Constraints:

additionalProperties: false

ExperimentalHttpClientInstrumentation

Property	Type	Default Behavior	Constraints	Description
`request_captured_headers`	`array` of `string`	If omitted, no outbound request headers are captured.	`minItems`: `1`	Configure headers to capture for outbound http requests.
`response_captured_headers`	`array` of `string`	If omitted, no inbound response headers are captured.	`minItems`: `1`	Configure headers to capture for inbound http responses.

Constraints:

additionalProperties: false

ExperimentalHttpInstrumentation

Property	Type	Default Behavior	Description
`client`	`ExperimentalHttpClientInstrumentation`	If omitted, defaults as described in ExperimentalHttpClientInstrumentation are used.	Configure instrumentations following the http client semantic conventions.
`server`	`ExperimentalHttpServerInstrumentation`	If omitted, defaults as described in ExperimentalHttpServerInstrumentation are used.	Configure instrumentations following the http server semantic conventions.

Constraints:

additionalProperties: false

ExperimentalHttpServerInstrumentation

Property	Type	Default Behavior	Constraints	Description
`request_captured_headers`	`array` of `string`	If omitted, no request headers are captured.	`minItems`: `1`	Configure headers to capture for inbound http requests.
`response_captured_headers`	`array` of `string`	If omitted, no response headers are captures.	`minItems`: `1`	Configure headers to capture for outbound http responses.

Constraints:

additionalProperties: false

ExperimentalInstrumentation

Property	Type	Default Behavior	Description
`cpp`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure C++ language-specific instrumentation libraries.
`dotnet`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure .NET language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`erlang`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure Erlang language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`general`	`ExperimentalGeneralInstrumentation`	If omitted, default values as described in ExperimentalGeneralInstrumentation are used.	Configure general SemConv options that may apply to multiple languages and instrumentations. Instrumenation may merge general config options with the language specific configuration at .instrumentation..
`go`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure Go language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`java`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure Java language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`js`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure JavaScript language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`php`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure PHP language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`python`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure Python language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`ruby`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure Ruby language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`rust`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure Rust language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.
`swift`	`ExperimentalLanguageSpecificInstrumentation`	If omitted, instrumentation defaults are used.	Configure Swift language-specific instrumentation libraries. Each entry’s key identifies a particular instrumentation library. The corresponding value configures it.

Constraints:

additionalProperties: false

ExperimentalJaegerRemoteSampler

Property	Type	Default Behavior	Constraints	Description
`endpoint`^*	`string`	Property is required and must be non-null.	None.	Configure the endpoint of the jaeger remote sampling service.
`initial_sampler`^*	`Sampler`	Property is required and must be non-null.	None.	Configure the initial sampler used before first configuration is fetched.
`interval`	one of: • `integer` • `null`	If omitted or null, 60000 is used.	`minimum`: `0`	Configure the polling interval (in milliseconds) to fetch from the remote sampling service.

Constraints:

• additionalProperties: false
• required: ["endpoint","initial_sampler"]

ExperimentalLanguageSpecificInstrumentation

No properties.

Constraints:

additionalProperties: {"type":"object"}

ExperimentalLoggerConfig

Property	Type	Default Behavior	Description
`disabled`	one of: • `boolean` • `null`	If omitted or null, false is used.	Configure if the logger is enabled or not.
`minimum_severity`	`SeverityNumber`	If omitted, severity filtering is not applied.	Configure severity filtering. Log records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed.
`trace_based`	one of: • `boolean` • `null`	If omitted or null, trace based filtering is not applied.	Configure trace based filtering. If true, log records associated with unsampled trace contexts traces are not processed. If false, or if a log record is not associated with a trace context, trace based filtering is not applied.

Constraints:

additionalProperties: false

ExperimentalLoggerConfigurator

Property	Type	Default Behavior	Constraints	Description
`default_config`	`ExperimentalLoggerConfig`	If omitted, unmatched .loggers use default values as described in ExperimentalLoggerConfig.	None.	Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers.
`loggers`	`array` of `ExperimentalLoggerMatcherAndConfig`	If omitted, all loggers use .default_config.	`minItems`: `1`	Configure loggers.

Constraints:

additionalProperties: false

ExperimentalLoggerMatcherAndConfig

Property	Type	Default Behavior	Description
`config`^*	`ExperimentalLoggerConfig`	Property is required and must be non-null.	The logger config.
`name`^*	`string`	Property is required and must be non-null.	Configure logger names to match, evaluated as follows: If the logger name exactly matches. If the logger name matches the wildcard pattern, where ‘?’ matches any single character and ‘*’ matches any number of characters including none.

Constraints:

• additionalProperties: false
• required: ["name","config"]

ExperimentalMeterConfig

Property	Type	Default Behavior	Description
`disabled`	`boolean`	If omitted, false is used.	Configure if the meter is enabled or not.

Constraints:

additionalProperties: false

ExperimentalMeterConfigurator

Property	Type	Default Behavior	Constraints	Description
`default_config`	`ExperimentalMeterConfig`	If omitted, unmatched .meters use default values as described in ExperimentalMeterConfig.	None.	Configure the default meter config used there is no matching entry in .meter_configurator/development.meters.
`meters`	`array` of `ExperimentalMeterMatcherAndConfig`	If omitted, all meters used .default_config.	`minItems`: `1`	Configure meters.

Constraints:

additionalProperties: false

ExperimentalMeterMatcherAndConfig

Property	Type	Default Behavior	Description
`config`^*	`ExperimentalMeterConfig`	Property is required and must be non-null.	The meter config.
`name`^*	`string`	Property is required and must be non-null.	Configure meter names to match, evaluated as follows: If the meter name exactly matches. If the meter name matches the wildcard pattern, where ‘?’ matches any single character and ‘*’ matches any number of characters including none.

Constraints:

• additionalProperties: false
• required: ["name","config"]

ExperimentalOtlpFileExporter

Property	Type	Default Behavior	Description
`output_stream`	one of: • `string` • `null`	If omitted or null, stdout is used.	Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.

Constraints:

additionalProperties: false

ExperimentalOtlpFileMetricExporter

Property	Type	Default Behavior	Description
`default_histogram_aggregation`	`ExporterDefaultHistogramAggregation`	If omitted, explicit_bucket_histogram is used.	Configure default histogram aggregation.
`output_stream`	one of: • `string` • `null`	If omitted or null, stdout is used.	Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.
`temporality_preference`	`ExporterTemporalityPreference`	If omitted, cumulative is used.	Configure temporality preference.

Constraints:

additionalProperties: false

ExperimentalPeerInstrumentation

Property	Type	Default Behavior	Constraints	Description
`service_mapping`	`array` of `ExperimentalPeerServiceMapping`	If omitted, no peer service mappings are used.	`minItems`: `1`	Configure the service mapping for instrumentations following peer.service semantic conventions. See peer.service semantic conventions: </docs/specs/semconv/general/attributes/#general-remote-service-attributes>

Constraints:

additionalProperties: false

ExperimentalPeerServiceMapping

Property	Type	Default Behavior	Description
`peer`^*	`string`	Property is required and must be non-null.	The IP address to map.
`service`^*	`string`	Property is required and must be non-null.	The logical name corresponding to the IP address of .peer.

Constraints:

• additionalProperties: false
• required: ["peer","service"]

ExperimentalProbabilitySampler

Property	Type	Default Behavior	Constraints	Description
`ratio`	one of: • `number` • `null`	If omitted or null, 1.0 is used.	• `minimum`: `0` • `maximum`: `1`	Configure ratio.

Constraints:

additionalProperties: false

ExperimentalProcessResourceDetector

No properties.

Constraints:

additionalProperties: false

ExperimentalPrometheusMetricExporter

Property	Type	Default Behavior	Description
`host`	one of: • `string` • `null`	If omitted or null, localhost is used.	Configure host.
`port`	one of: • `integer` • `null`	If omitted or null, 9464 is used.	Configure port.
`translation_strategy`	`ExperimentalPrometheusTranslationStrategy`	If omitted, underscore_escaping_with_suffixes is used.	Configure how metric names are translated to Prometheus metric names.
`with_resource_constant_labels`	`IncludeExclude`	If omitted, no resource attributes are added.	Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns.
`without_scope_info`	one of: • `boolean` • `null`	If omitted or null, false is used.	Configure Prometheus Exporter to produce metrics without a scope info metric.
`without_target_info`	one of: • `boolean` • `null`	If omitted or null, false is used.	Configure Prometheus Exporter to produce metrics without a target info metric for the resource.

Constraints:

additionalProperties: false

ExperimentalPrometheusTranslationStrategy

This is an enum type.

Value	Description
`no_translation`	Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered.
`no_utf8_escaping_with_suffixes`	Special character escaping is disabled. Type and unit suffixes are enabled.
`underscore_escaping_with_suffixes`	Special character escaping is enabled. Type and unit suffixes are enabled.
`underscore_escaping_without_suffixes`	Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility.

ExperimentalResourceDetection

Property	Type	Default Behavior	Constraints	Description
`attributes`	`IncludeExclude`	If omitted, all attributes from resource detectors are added.	None.	Configure attributes provided by resource detectors.
`detectors`	`array` of `ExperimentalResourceDetector`	If omitted, no resource detectors are enabled.	`minItems`: `1`	Configure resource detectors. Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language.

Constraints:

additionalProperties: false

ExperimentalResourceDetector

ExperimentalResourceDetector is an SDK extension plugin point.

Property	Type	Default Behavior	Description
`container`	`ExperimentalContainerResourceDetector`	If omitted, ignore.	Enable the container resource detector, which populates container.* attributes.
`host`	`ExperimentalHostResourceDetector`	If omitted, ignore.	Enable the host resource detector, which populates host.and os. attributes.
`process`	`ExperimentalProcessResourceDetector`	If omitted, ignore.	Enable the process resource detector, which populates process.* attributes.
`service`	`ExperimentalServiceResourceDetector`	If omitted, ignore.	Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.

Constraints:

• additionalProperties: {"type":["object","null"]}
• minProperties: 1
• maxProperties: 1

ExperimentalServiceResourceDetector

No properties.

Constraints:

additionalProperties: false

ExperimentalSpanParent

This is an enum type.

Value	Description
`local`	local, a local parent.
`none`	none, no parent, i.e., the trace root.
`remote`	remote, a remote parent.

ExperimentalTracerConfig

Property	Type	Default Behavior	Description
`disabled`	`boolean`	If omitted, false is used.	Configure if the tracer is enabled or not.

Constraints:

additionalProperties: false

ExperimentalTracerConfigurator

Property	Type	Default Behavior	Constraints	Description
`default_config`	`ExperimentalTracerConfig`	If omitted, unmatched .tracers use default values as described in ExperimentalTracerConfig.	None.	Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers.
`tracers`	`array` of `ExperimentalTracerMatcherAndConfig`	If omitted, all tracers use .default_config.	`minItems`: `1`	Configure tracers.

Constraints:

additionalProperties: false

ExperimentalTracerMatcherAndConfig

Property	Type	Default Behavior	Description
`config`^*	`ExperimentalTracerConfig`	Property is required and must be non-null.	The tracer config.
`name`^*	`string`	Property is required and must be non-null.	Configure tracer names to match, evaluated as follows: If the tracer name exactly matches. If the tracer name matches the wildcard pattern, where ‘?’ matches any single character and ‘*’ matches any number of characters including none.

Constraints:

• additionalProperties: false
• required: ["name","config"]

Language Status

Language implementation status for OpenTelemetry SDK declarative configuration types

Feedback

Was this page helpful?

Thank you. Your feedback is appreciated!

Please let us know how we can improve this page. Your feedback is appreciated!

Last modified April 6, 2026: change (ce9b988e)