OpenTelemetry Declarative Configuration

1.0.0

Schema URL

https://catalog.lintel.tools/schemas/schemastore/opentelemetry-declarative-configuration/versions/1.0.0.json
← Back to OpenTelemetry Declarative Configuration
Type: object

Properties

file_format string required

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 https://github.com/open-telemetry/opentelemetry-configuration/blob/main/VERSIONING.md for more details. The yaml format is documented at https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema Property is required and must be non-null.

disabled boolean | null

Configure if the SDK is disabled or not. If omitted or null, false is used.

log_level string | null
Values: "trace" "trace2" "trace3" "trace4" "debug" "debug2" "debug3" "debug4" "info" "info2" "info3" "info4" "warn" "warn2" "warn3" "warn4" "error" "error2" "error3" "error4" "fatal" "fatal2" "fatal3" "fatal4"
attribute_limits object
2 nested properties
attribute_value_length_limit integer | null

Configure max attribute value size. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Value must be non-negative. If omitted or null, 128 is used.

min=0
logger_provider object
3 nested properties
processors LogRecordProcessor[] required

Configure log record processors. Property is required and must be non-null.

minItems=1
limits object
2 nested properties
attribute_value_length_limit integer | null

Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used.

min=0
logger_configurator/development object
2 nested properties
default_config object
3 nested properties
enabled boolean | null

Configure if the logger is enabled or not. If omitted or null, true is used.

minimum_severity string | null
Values: "trace" "trace2" "trace3" "trace4" "debug" "debug2" "debug3" "debug4" "info" "info2" "info3" "info4" "warn" "warn2" "warn3" "warn4" "error" "error2" "error3" "error4" "fatal" "fatal2" "fatal3" "fatal4"
trace_based boolean | null

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. If omitted or null, trace based filtering is not applied.

loggers ExperimentalLoggerMatcherAndConfig[]

Configure loggers. If omitted, all loggers use .default_config.

minItems=1
meter_provider object
4 nested properties
readers MetricReader[] required

Configure metric readers. Property is required and must be non-null.

minItems=1
views View[]

Configure views. Each view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s). If omitted, no views are registered.

minItems=1
exemplar_filter string | null
Values: "always_on" "always_off" "trace_based"
meter_configurator/development object
2 nested properties
default_config object
1 nested properties
enabled boolean

Configure if the meter is enabled or not. If omitted, true is used.

meters ExperimentalMeterMatcherAndConfig[]

Configure meters. If omitted, all meters used .default_config.

minItems=1
propagator object
2 nested properties
composite TextMapPropagator[]

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. Known third party keys include: xray. If omitted, and .composite_list is omitted or null, a noop propagator is used.

minItems=1
composite_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details. Built-in propagator identifiers include: tracecontext, baggage, b3, b3multi. Known third party identifiers include: xray. If omitted or null, and .composite is omitted or null, a noop propagator is used.

tracer_provider object
4 nested properties
processors SpanProcessor[] required

Configure span processors. Property is required and must be non-null.

minItems=1
limits object
6 nested properties
attribute_value_length_limit integer | null

Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used.

min=0
event_count_limit integer | null

Configure max span event count. Value must be non-negative. If omitted or null, 128 is used.

min=0
link_count_limit integer | null

Configure max span link count. Value must be non-negative. If omitted or null, 128 is used.

min=0
event_attribute_count_limit integer | null

Configure max attributes per span event. Value must be non-negative. If omitted or null, 128 is used.

min=0
link_attribute_count_limit integer | null

Configure max attributes per span link. Value must be non-negative. If omitted or null, 128 is used.

min=0
sampler Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
tracer_configurator/development object
2 nested properties
default_config object
1 nested properties
enabled boolean

Configure if the tracer is enabled or not. If omitted, true is used.

tracers ExperimentalTracerMatcherAndConfig[]

Configure tracers. If omitted, all tracers use .default_config.

minItems=1
resource object
4 nested properties
attributes AttributeNameValue[]

Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list. If omitted, no resource attributes are added.

minItems=1
detection/development object
2 nested properties
attributes object
2 nested properties
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
detectors ExperimentalResourceDetector[]

Configure resource detectors. Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. If omitted, no resource detectors are enabled.

minItems=1
schema_url string | null

Configure resource schema URL. If omitted or null, no schema URL is used.

attributes_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details. If omitted or null, no resource attributes are added.

instrumentation/development object
12 nested properties
general object
8 nested properties
http object
3 nested properties
semconv object
client object
server object
code object
1 nested properties
semconv object
db object
1 nested properties
semconv object
gen_ai object
1 nested properties
semconv object
messaging object
1 nested properties
semconv object
rpc object
1 nested properties
semconv object
sanitization object
1 nested properties
url object
stability_opt_in_list string | null

Configure semantic convention stability opt-in as a comma-separated list. This property follows the format and semantics of the OTEL_SEMCONV_STABILITY_OPT_IN environment variable. Controls the emission of stable vs. experimental semantic conventions for instrumentation. This setting is only intended for migrating from experimental to stable semantic conventions.

Known values include:

  • http: Emit stable HTTP and networking conventions only
  • http/dup: Emit both old and stable HTTP and networking conventions (for phased migration)
  • database: Emit stable database conventions only
  • database/dup: Emit both old and stable database conventions (for phased migration)
  • rpc: Emit stable RPC conventions only
  • rpc/dup: Emit both experimental and stable RPC conventions (for phased migration)
  • messaging: Emit stable messaging conventions only
  • messaging/dup: Emit both old and stable messaging conventions (for phased migration)
  • code: Emit stable code conventions only
  • code/dup: Emit both old and stable code conventions (for phased migration)

Multiple values can be specified as a comma-separated list (e.g., "http,database/dup"). Additional signal types may be supported in future versions.

Domain-specific semconv properties (e.g., .instrumentation/development.general.db.semconv) take precedence over this general setting.

See:

cpp Record<string, object>
dotnet Record<string, object>
erlang Record<string, object>
go Record<string, object>
java Record<string, object>
js Record<string, object>
php Record<string, object>
python Record<string, object>
ruby Record<string, object>
rust Record<string, object>
swift Record<string, object>
distribution Record<string, object>

Definitions

Aggregation object
default object | null
drop object | null
explicit_bucket_histogram object | null
2 nested properties
boundaries number[]

Configure bucket boundaries. If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used.

minItems=0
record_min_max boolean | null

Configure record min and max. If omitted or null, true is used.

base2_exponential_bucket_histogram object | null
3 nested properties
max_scale integer | null

Configure the max scale factor. If omitted or null, 20 is used.

min=-10max=20
max_size integer | null

Configure the maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket. If omitted or null, 160 is used.

min=2
record_min_max boolean | null

Configure whether or not to record min and max. If omitted or null, true is used.

last_value object | null
sum object | null
AlwaysOffSampler object | null
AlwaysOnSampler object | null
AttributeLimits object
attribute_value_length_limit integer | null

Configure max attribute value size. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Value must be non-negative. If omitted or null, 128 is used.

min=0
AttributeNameValue object
name string required

The attribute name. Property is required and must be non-null.

value string | number | boolean | null | string[] | boolean[] | number[] required

The attribute value. The type of value must match .type. Property is required and must be non-null.

type string | null
Values: "string" "bool" "int" "double" "string_array" "bool_array" "int_array" "double_array"
AttributeType string | null
B3MultiPropagator object | null
B3Propagator object | null
BaggagePropagator object | null
Base2ExponentialBucketHistogramAggregation object | null
max_scale integer | null

Configure the max scale factor. If omitted or null, 20 is used.

min=-10max=20
max_size integer | null

Configure the maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket. If omitted or null, 160 is used.

min=2
record_min_max boolean | null

Configure whether or not to record min and max. If omitted or null, true is used.

BatchLogRecordProcessor object
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
7 nested properties
endpoint string | null

Configure endpoint, including the signal specific path. If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
otlp_grpc object | null
6 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
otlp_file/development object | null
1 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

console object | null
schedule_delay integer | null

Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. If omitted or null, 1000 is used.

min=0
export_timeout integer | null

Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 30000 is used.

min=0
max_queue_size integer | null

Configure maximum queue size. Value must be positive. If omitted or null, 2048 is used.

exclusiveMin=0
max_export_batch_size integer | null

Configure maximum batch size. Value must be positive. If omitted or null, 512 is used.

exclusiveMin=0
BatchSpanProcessor object
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
7 nested properties
endpoint string | null

Configure endpoint, including the signal specific path. If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
otlp_grpc object | null
6 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
otlp_file/development object | null
1 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

console object | null
schedule_delay integer | null

Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. If omitted or null, 5000 is used.

min=0
export_timeout integer | null

Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 30000 is used.

min=0
max_queue_size integer | null

Configure maximum queue size. Value must be positive. If omitted or null, 2048 is used.

exclusiveMin=0
max_export_batch_size integer | null

Configure maximum batch size. Value must be positive. If omitted or null, 512 is used.

exclusiveMin=0
CardinalityLimits object
default integer | null

Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority. If omitted or null, 2000 is used.

exclusiveMin=0
counter integer | null

Configure default cardinality limit for counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
gauge integer | null

Configure default cardinality limit for gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
histogram integer | null

Configure default cardinality limit for histogram instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_counter integer | null

Configure default cardinality limit for observable_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_gauge integer | null

Configure default cardinality limit for observable_gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_up_down_counter integer | null

Configure default cardinality limit for observable_up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
up_down_counter integer | null

Configure default cardinality limit for up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
ConsoleExporter object | null
ConsoleMetricExporter object | null
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
DefaultAggregation object | null
Distribution Record<string, object>
DropAggregation object | null
ExemplarFilter string | null
ExperimentalCodeInstrumentation object
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

ExperimentalComposableAlwaysOffSampler object | null
ExperimentalComposableAlwaysOnSampler object | null
ExperimentalComposableParentThresholdSampler object
root Record<string, object | null> required
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
1 nested properties
root Record<string, object | null> required
probability object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
rule_based object | null
1 nested properties
rules ExperimentalComposableRuleBasedSamplerRule[]

The rules for the sampler, matched in order. Each rule can have multiple match conditions. All conditions must match for the rule to match. If no conditions are specified, the rule matches all spans that reach it. If no rules match, the span is not sampled. If omitted, no span is sampled.

minItems=1
ExperimentalComposableProbabilitySampler object | null
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
ExperimentalComposableRuleBasedSampler object | null
rules ExperimentalComposableRuleBasedSamplerRule[]

The rules for the sampler, matched in order. Each rule can have multiple match conditions. All conditions must match for the rule to match. If no conditions are specified, the rule matches all spans that reach it. If no rules match, the span is not sampled. If omitted, no span is sampled.

minItems=1
ExperimentalComposableRuleBasedSamplerRule object

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.

sampler Record<string, object | null> required
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
1 nested properties
root Record<string, object | null> required
probability object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
rule_based object | null
1 nested properties
rules ExperimentalComposableRuleBasedSamplerRule[]

The rules for the sampler, matched in order. Each rule can have multiple match conditions. All conditions must match for the rule to match. If no conditions are specified, the rule matches all spans that reach it. If no rules match, the span is not sampled. If omitted, no span is sampled.

minItems=1
attribute_values object
2 nested properties
key string required

The attribute key to match against. Property is required and must be non-null.

values string[] required

The attribute values to match against. If the attribute's value matches any of these, it matches. Property is required and must be non-null.

minItems=1
attribute_patterns object
3 nested properties
key string required

The attribute key to match against. Property is required and must be non-null.

included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
span_kinds SpanKind[]

The span kinds to match. If the span's kind matches any of these, it matches. Values include:

  • 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. If omitted, ignore.
minItems=1
parent ExperimentalSpanParent[]

The parent span types to match. Values include:

  • local: local, a local parent.
  • none: none, no parent, i.e., the trace root.
  • remote: remote, a remote parent. If omitted, ignore.
minItems=1
ExperimentalComposableRuleBasedSamplerRuleAttributePatterns object
key string required

The attribute key to match against. Property is required and must be non-null.

included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
ExperimentalComposableRuleBasedSamplerRuleAttributeValues object
key string required

The attribute key to match against. Property is required and must be non-null.

values string[] required

The attribute values to match against. If the attribute's value matches any of these, it matches. Property is required and must be non-null.

minItems=1
ExperimentalComposableSampler Record<string, object | null>
always_off object | null
always_on object | null
parent_threshold object
1 nested properties
root Record<string, object | null> required
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
probability object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
rule_based object | null
1 nested properties
rules ExperimentalComposableRuleBasedSamplerRule[]

The rules for the sampler, matched in order. Each rule can have multiple match conditions. All conditions must match for the rule to match. If no conditions are specified, the rule matches all spans that reach it. If no rules match, the span is not sampled. If omitted, no span is sampled.

minItems=1
ExperimentalContainerResourceDetector object | null
ExperimentalDbInstrumentation object
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

ExperimentalGenAiInstrumentation object
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

ExperimentalGeneralInstrumentation object
http object
3 nested properties
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

client object
3 nested properties
request_captured_headers string[]

Configure headers to capture for outbound http requests. If omitted, no outbound request headers are captured.

minItems=1
response_captured_headers string[]

Configure headers to capture for inbound http responses. If omitted, no inbound response headers are captured.

minItems=1
known_methods string[]

Override the default list of known HTTP methods. Known methods are case-sensitive. This is a full override of the default known methods, not a list of known methods in addition to the defaults. If omitted, HTTP methods GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH are known.

minItems=0
server object
3 nested properties
request_captured_headers string[]

Configure headers to capture for inbound http requests. If omitted, no request headers are captured.

minItems=1
response_captured_headers string[]

Configure headers to capture for outbound http responses. If omitted, no response headers are captures.

minItems=1
known_methods string[]

Override the default list of known HTTP methods. Known methods are case-sensitive. This is a full override of the default known methods, not a list of known methods in addition to the defaults. If omitted, HTTP methods GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH are known.

minItems=0
code object
1 nested properties
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

db object
1 nested properties
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

gen_ai object
1 nested properties
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

messaging object
1 nested properties
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

rpc object
1 nested properties
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

sanitization object
1 nested properties
url object
1 nested properties
sensitive_query_parameters string[]

List of query parameter names whose values should be redacted from URLs. Query parameter names are case-sensitive. This is a full override of the default sensitive query parameter keys, it is not a list of keys in addition to the defaults. Set to an empty array to disable query parameter redaction. If omitted, the default sensitive query parameter list as defined by the url semantic conventions (https://github.com/open-telemetry/semantic-conventions/blob/main/docs/registry/attributes/url.md) is used.

minItems=0
stability_opt_in_list string | null

Configure semantic convention stability opt-in as a comma-separated list. This property follows the format and semantics of the OTEL_SEMCONV_STABILITY_OPT_IN environment variable. Controls the emission of stable vs. experimental semantic conventions for instrumentation. This setting is only intended for migrating from experimental to stable semantic conventions.

Known values include:

  • http: Emit stable HTTP and networking conventions only
  • http/dup: Emit both old and stable HTTP and networking conventions (for phased migration)
  • database: Emit stable database conventions only
  • database/dup: Emit both old and stable database conventions (for phased migration)
  • rpc: Emit stable RPC conventions only
  • rpc/dup: Emit both experimental and stable RPC conventions (for phased migration)
  • messaging: Emit stable messaging conventions only
  • messaging/dup: Emit both old and stable messaging conventions (for phased migration)
  • code: Emit stable code conventions only
  • code/dup: Emit both old and stable code conventions (for phased migration)

Multiple values can be specified as a comma-separated list (e.g., "http,database/dup"). Additional signal types may be supported in future versions.

Domain-specific semconv properties (e.g., .instrumentation/development.general.db.semconv) take precedence over this general setting.

See:

ExperimentalHostResourceDetector object | null
ExperimentalHttpClientInstrumentation object
request_captured_headers string[]

Configure headers to capture for outbound http requests. If omitted, no outbound request headers are captured.

minItems=1
response_captured_headers string[]

Configure headers to capture for inbound http responses. If omitted, no inbound response headers are captured.

minItems=1
known_methods string[]

Override the default list of known HTTP methods. Known methods are case-sensitive. This is a full override of the default known methods, not a list of known methods in addition to the defaults. If omitted, HTTP methods GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH are known.

minItems=0
ExperimentalHttpInstrumentation object
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

client object
3 nested properties
request_captured_headers string[]

Configure headers to capture for outbound http requests. If omitted, no outbound request headers are captured.

minItems=1
response_captured_headers string[]

Configure headers to capture for inbound http responses. If omitted, no inbound response headers are captured.

minItems=1
known_methods string[]

Override the default list of known HTTP methods. Known methods are case-sensitive. This is a full override of the default known methods, not a list of known methods in addition to the defaults. If omitted, HTTP methods GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH are known.

minItems=0
server object
3 nested properties
request_captured_headers string[]

Configure headers to capture for inbound http requests. If omitted, no request headers are captured.

minItems=1
response_captured_headers string[]

Configure headers to capture for outbound http responses. If omitted, no response headers are captures.

minItems=1
known_methods string[]

Override the default list of known HTTP methods. Known methods are case-sensitive. This is a full override of the default known methods, not a list of known methods in addition to the defaults. If omitted, HTTP methods GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH are known.

minItems=0
ExperimentalHttpServerInstrumentation object
request_captured_headers string[]

Configure headers to capture for inbound http requests. If omitted, no request headers are captured.

minItems=1
response_captured_headers string[]

Configure headers to capture for outbound http responses. If omitted, no response headers are captures.

minItems=1
known_methods string[]

Override the default list of known HTTP methods. Known methods are case-sensitive. This is a full override of the default known methods, not a list of known methods in addition to the defaults. If omitted, HTTP methods GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH are known.

minItems=0
ExperimentalInstrumentation object
general object
8 nested properties
http object
3 nested properties
semconv object
client object
server object
code object
1 nested properties
semconv object
db object
1 nested properties
semconv object
gen_ai object
1 nested properties
semconv object
messaging object
1 nested properties
semconv object
rpc object
1 nested properties
semconv object
sanitization object
1 nested properties
url object
stability_opt_in_list string | null

Configure semantic convention stability opt-in as a comma-separated list. This property follows the format and semantics of the OTEL_SEMCONV_STABILITY_OPT_IN environment variable. Controls the emission of stable vs. experimental semantic conventions for instrumentation. This setting is only intended for migrating from experimental to stable semantic conventions.

Known values include:

  • http: Emit stable HTTP and networking conventions only
  • http/dup: Emit both old and stable HTTP and networking conventions (for phased migration)
  • database: Emit stable database conventions only
  • database/dup: Emit both old and stable database conventions (for phased migration)
  • rpc: Emit stable RPC conventions only
  • rpc/dup: Emit both experimental and stable RPC conventions (for phased migration)
  • messaging: Emit stable messaging conventions only
  • messaging/dup: Emit both old and stable messaging conventions (for phased migration)
  • code: Emit stable code conventions only
  • code/dup: Emit both old and stable code conventions (for phased migration)

Multiple values can be specified as a comma-separated list (e.g., "http,database/dup"). Additional signal types may be supported in future versions.

Domain-specific semconv properties (e.g., .instrumentation/development.general.db.semconv) take precedence over this general setting.

See:

cpp Record<string, object>
dotnet Record<string, object>
erlang Record<string, object>
go Record<string, object>
java Record<string, object>
js Record<string, object>
php Record<string, object>
python Record<string, object>
ruby Record<string, object>
rust Record<string, object>
swift Record<string, object>
ExperimentalJaegerRemoteSampler object | null
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
ExperimentalLanguageSpecificInstrumentation Record<string, object>
ExperimentalLoggerConfig object
enabled boolean | null

Configure if the logger is enabled or not. If omitted or null, true is used.

minimum_severity string | null
Values: "trace" "trace2" "trace3" "trace4" "debug" "debug2" "debug3" "debug4" "info" "info2" "info3" "info4" "warn" "warn2" "warn3" "warn4" "error" "error2" "error3" "error4" "fatal" "fatal2" "fatal3" "fatal4"
trace_based boolean | null

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. If omitted or null, trace based filtering is not applied.

ExperimentalLoggerConfigurator object
default_config object
3 nested properties
enabled boolean | null

Configure if the logger is enabled or not. If omitted or null, true is used.

minimum_severity string | null
Values: "trace" "trace2" "trace3" "trace4" "debug" "debug2" "debug3" "debug4" "info" "info2" "info3" "info4" "warn" "warn2" "warn3" "warn4" "error" "error2" "error3" "error4" "fatal" "fatal2" "fatal3" "fatal4"
trace_based boolean | null

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. If omitted or null, trace based filtering is not applied.

loggers ExperimentalLoggerMatcherAndConfig[]

Configure loggers. If omitted, all loggers use .default_config.

minItems=1
ExperimentalLoggerMatcherAndConfig object
name string required

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. Property is required and must be non-null.
config object required
3 nested properties
enabled boolean | null

Configure if the logger is enabled or not. If omitted or null, true is used.

minimum_severity string | null
Values: "trace" "trace2" "trace3" "trace4" "debug" "debug2" "debug3" "debug4" "info" "info2" "info3" "info4" "warn" "warn2" "warn3" "warn4" "error" "error2" "error3" "error4" "fatal" "fatal2" "fatal3" "fatal4"
trace_based boolean | null

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. If omitted or null, trace based filtering is not applied.

ExperimentalMessagingInstrumentation object
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

ExperimentalMeterConfig object
enabled boolean

Configure if the meter is enabled or not. If omitted, true is used.

ExperimentalMeterConfigurator object
default_config object
1 nested properties
enabled boolean

Configure if the meter is enabled or not. If omitted, true is used.

meters ExperimentalMeterMatcherAndConfig[]

Configure meters. If omitted, all meters used .default_config.

minItems=1
ExperimentalMeterMatcherAndConfig object
name string required

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. Property is required and must be non-null.
config object required
1 nested properties
enabled boolean

Configure if the meter is enabled or not. If omitted, true is used.

ExperimentalOtlpFileExporter object | null
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

ExperimentalOtlpFileMetricExporter object | null
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
ExperimentalProbabilitySampler object | null
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
ExperimentalProcessResourceDetector object | null
ExperimentalPrometheusMetricExporter object | null
host string | null

Configure host. If omitted or null, localhost is used.

port integer | null

Configure port. If omitted or null, 9464 is used.

without_scope_info boolean | null

Configure Prometheus Exporter to produce metrics without scope labels. If omitted or null, false is used.

without_target_info/development boolean | null

Configure Prometheus Exporter to produce metrics without a target info metric for the resource. If omitted or null, false is used.

with_resource_constant_labels object
2 nested properties
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
translation_strategy string | null
Values: "underscore_escaping_with_suffixes" "underscore_escaping_without_suffixes/development" "no_utf8_escaping_with_suffixes/development" "no_translation/development"
ExperimentalPrometheusTranslationStrategy string | null
ExperimentalResourceDetection object
attributes object
2 nested properties
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
detectors ExperimentalResourceDetector[]

Configure resource detectors. Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. If omitted, no resource detectors are enabled.

minItems=1
ExperimentalResourceDetector Record<string, object | null>
container object | null
host object | null
process object | null
service object | null
ExperimentalRpcInstrumentation object
semconv object
3 nested properties
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

ExperimentalSanitization object
url object
1 nested properties
sensitive_query_parameters string[]

List of query parameter names whose values should be redacted from URLs. Query parameter names are case-sensitive. This is a full override of the default sensitive query parameter keys, it is not a list of keys in addition to the defaults. Set to an empty array to disable query parameter redaction. If omitted, the default sensitive query parameter list as defined by the url semantic conventions (https://github.com/open-telemetry/semantic-conventions/blob/main/docs/registry/attributes/url.md) is used.

minItems=0
ExperimentalSemconvConfig object
version integer | null

The target semantic convention version for this domain (e.g., 1). If omitted or null, the latest stable version is used, or if no stable version is available and .experimental is true then the latest experimental version is used.

min=0
experimental boolean | null

Use latest experimental semantic conventions (before stable is available or to enable experimental features on top of stable conventions). If omitted or null, false is used.

dual_emit boolean | null

When true, also emit the previous major version alongside the target version. For version=1, the previous version refers to the pre-stable conventions that the instrumentation emitted before the first stable semantic convention version was defined. For version=2 and above, the previous version is the prior stable major version (e.g., version=2, dual_emit=true emits both v2 and v1). Enables dual-emit for phased migration between versions. If omitted or null, false is used.

ExperimentalServiceResourceDetector object | null
ExperimentalSpanParent string | null
ExperimentalTracerConfig object
enabled boolean

Configure if the tracer is enabled or not. If omitted, true is used.

ExperimentalTracerConfigurator object
default_config object
1 nested properties
enabled boolean

Configure if the tracer is enabled or not. If omitted, true is used.

tracers ExperimentalTracerMatcherAndConfig[]

Configure tracers. If omitted, all tracers use .default_config.

minItems=1
ExperimentalTracerMatcherAndConfig object
name string required

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. Property is required and must be non-null.
config object required
1 nested properties
enabled boolean

Configure if the tracer is enabled or not. If omitted, true is used.

ExperimentalUrlSanitization object
sensitive_query_parameters string[]

List of query parameter names whose values should be redacted from URLs. Query parameter names are case-sensitive. This is a full override of the default sensitive query parameter keys, it is not a list of keys in addition to the defaults. Set to an empty array to disable query parameter redaction. If omitted, the default sensitive query parameter list as defined by the url semantic conventions (https://github.com/open-telemetry/semantic-conventions/blob/main/docs/registry/attributes/url.md) is used.

minItems=0
ExplicitBucketHistogramAggregation object | null
boundaries number[]

Configure bucket boundaries. If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used.

minItems=0
record_min_max boolean | null

Configure record min and max. If omitted or null, true is used.

ExporterDefaultHistogramAggregation string | null
ExporterTemporalityPreference string | null
GrpcTls object | null
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

insecure boolean | null

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. If omitted or null, false is used.

HttpTls object | null
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

IncludeExclude object
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
InstrumentType string | null
LastValueAggregation object | null
LoggerProvider object
processors LogRecordProcessor[] required

Configure log record processors. Property is required and must be non-null.

minItems=1
limits object
2 nested properties
attribute_value_length_limit integer | null

Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used.

min=0
logger_configurator/development object
2 nested properties
default_config object
3 nested properties
enabled boolean | null

Configure if the logger is enabled or not. If omitted or null, true is used.

minimum_severity string | null
Values: "trace" "trace2" "trace3" "trace4" "debug" "debug2" "debug3" "debug4" "info" "info2" "info3" "info4" "warn" "warn2" "warn3" "warn4" "error" "error2" "error3" "error4" "fatal" "fatal2" "fatal3" "fatal4"
trace_based boolean | null

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. If omitted or null, trace based filtering is not applied.

loggers ExperimentalLoggerMatcherAndConfig[]

Configure loggers. If omitted, all loggers use .default_config.

minItems=1
LogRecordExporter Record<string, object | null>
otlp_http object | null
7 nested properties
endpoint string | null

Configure endpoint, including the signal specific path. If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.

tls object | null
3 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
otlp_grpc object | null
6 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
4 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

insecure boolean | null

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. If omitted or null, false is used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
otlp_file/development object | null
1 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

console object | null
LogRecordLimits object
attribute_value_length_limit integer | null

Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used.

min=0
LogRecordProcessor Record<string, object | null>
batch object
5 nested properties
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
otlp_grpc object | null
otlp_file/development object | null
console object | null
schedule_delay integer | null

Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. If omitted or null, 1000 is used.

min=0
export_timeout integer | null

Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 30000 is used.

min=0
max_queue_size integer | null

Configure maximum queue size. Value must be positive. If omitted or null, 2048 is used.

exclusiveMin=0
max_export_batch_size integer | null

Configure maximum batch size. Value must be positive. If omitted or null, 512 is used.

exclusiveMin=0
simple object
1 nested properties
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
otlp_grpc object | null
otlp_file/development object | null
console object | null
MeterProvider object
readers MetricReader[] required

Configure metric readers. Property is required and must be non-null.

minItems=1
views View[]

Configure views. Each view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s). If omitted, no views are registered.

minItems=1
exemplar_filter string | null
Values: "always_on" "always_off" "trace_based"
meter_configurator/development object
2 nested properties
default_config object
1 nested properties
enabled boolean

Configure if the meter is enabled or not. If omitted, true is used.

meters ExperimentalMeterMatcherAndConfig[]

Configure meters. If omitted, all meters used .default_config.

minItems=1
MetricProducer Record<string, object | null>
opencensus object | null
MetricReader object
periodic object
5 nested properties
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
otlp_grpc object | null
otlp_file/development object | null
console object | null
interval integer | null

Configure delay interval (in milliseconds) between start of two consecutive exports. Value must be non-negative. If omitted or null, 60000 is used.

min=0
timeout integer | null

Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 30000 is used.

min=0
producers MetricProducer[]

Configure metric producers. If omitted, no metric producers are added.

minItems=1
cardinality_limits object
8 nested properties
default integer | null

Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority. If omitted or null, 2000 is used.

exclusiveMin=0
counter integer | null

Configure default cardinality limit for counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
gauge integer | null

Configure default cardinality limit for gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
histogram integer | null

Configure default cardinality limit for histogram instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_counter integer | null

Configure default cardinality limit for observable_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_gauge integer | null

Configure default cardinality limit for observable_gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_up_down_counter integer | null

Configure default cardinality limit for observable_up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
up_down_counter integer | null

Configure default cardinality limit for up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
pull object
3 nested properties
exporter Record<string, object | null> required
1 nested properties
prometheus/development object | null
producers MetricProducer[]

Configure metric producers. If omitted, no metric producers are added.

minItems=1
cardinality_limits object
8 nested properties
default integer | null

Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority. If omitted or null, 2000 is used.

exclusiveMin=0
counter integer | null

Configure default cardinality limit for counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
gauge integer | null

Configure default cardinality limit for gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
histogram integer | null

Configure default cardinality limit for histogram instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_counter integer | null

Configure default cardinality limit for observable_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_gauge integer | null

Configure default cardinality limit for observable_gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_up_down_counter integer | null

Configure default cardinality limit for observable_up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
up_down_counter integer | null

Configure default cardinality limit for up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
NameStringValuePair object
name string required

The name of the pair. Property is required and must be non-null.

value string | null required

The value of the pair. Property must be present, but if null the behavior is dependent on usage context.

OpenCensusMetricProducer object | null
OtlpGrpcExporter object | null
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
4 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

insecure boolean | null

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. If omitted or null, false is used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
OtlpGrpcMetricExporter object | null
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
4 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

insecure boolean | null

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. If omitted or null, false is used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
OtlpHttpEncoding string | null
OtlpHttpExporter object | null
endpoint string | null

Configure endpoint, including the signal specific path. If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.

tls object | null
3 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
OtlpHttpMetricExporter object | null
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4318/v1/metrics is used.

tls object | null
3 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
ParentBasedSampler object | null
root Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
remote_parent_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
remote_parent_not_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
local_parent_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
local_parent_not_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
PeriodicMetricReader object
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
9 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4318/v1/metrics is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
otlp_grpc object | null
8 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
otlp_file/development object | null
3 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
console object | null
2 nested properties
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
interval integer | null

Configure delay interval (in milliseconds) between start of two consecutive exports. Value must be non-negative. If omitted or null, 60000 is used.

min=0
timeout integer | null

Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 30000 is used.

min=0
producers MetricProducer[]

Configure metric producers. If omitted, no metric producers are added.

minItems=1
cardinality_limits object
8 nested properties
default integer | null

Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority. If omitted or null, 2000 is used.

exclusiveMin=0
counter integer | null

Configure default cardinality limit for counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
gauge integer | null

Configure default cardinality limit for gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
histogram integer | null

Configure default cardinality limit for histogram instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_counter integer | null

Configure default cardinality limit for observable_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_gauge integer | null

Configure default cardinality limit for observable_gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_up_down_counter integer | null

Configure default cardinality limit for observable_up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
up_down_counter integer | null

Configure default cardinality limit for up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
Propagator object
composite TextMapPropagator[]

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. Known third party keys include: xray. If omitted, and .composite_list is omitted or null, a noop propagator is used.

minItems=1
composite_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details. Built-in propagator identifiers include: tracecontext, baggage, b3, b3multi. Known third party identifiers include: xray. If omitted or null, and .composite is omitted or null, a noop propagator is used.

PullMetricExporter Record<string, object | null>
prometheus/development object | null
6 nested properties
host string | null

Configure host. If omitted or null, localhost is used.

port integer | null

Configure port. If omitted or null, 9464 is used.

without_scope_info boolean | null

Configure Prometheus Exporter to produce metrics without scope labels. If omitted or null, false is used.

without_target_info/development boolean | null

Configure Prometheus Exporter to produce metrics without a target info metric for the resource. If omitted or null, false is used.

with_resource_constant_labels object
2 nested properties
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
translation_strategy string | null
Values: "underscore_escaping_with_suffixes" "underscore_escaping_without_suffixes/development" "no_utf8_escaping_with_suffixes/development" "no_translation/development"
PullMetricReader object
exporter Record<string, object | null> required
1 nested properties
prometheus/development object | null
6 nested properties
host string | null

Configure host. If omitted or null, localhost is used.

port integer | null

Configure port. If omitted or null, 9464 is used.

without_scope_info boolean | null

Configure Prometheus Exporter to produce metrics without scope labels. If omitted or null, false is used.

without_target_info/development boolean | null

Configure Prometheus Exporter to produce metrics without a target info metric for the resource. If omitted or null, false is used.

with_resource_constant_labels object
translation_strategy string | null
Values: "underscore_escaping_with_suffixes" "underscore_escaping_without_suffixes/development" "no_utf8_escaping_with_suffixes/development" "no_translation/development"
producers MetricProducer[]

Configure metric producers. If omitted, no metric producers are added.

minItems=1
cardinality_limits object
8 nested properties
default integer | null

Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority. If omitted or null, 2000 is used.

exclusiveMin=0
counter integer | null

Configure default cardinality limit for counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
gauge integer | null

Configure default cardinality limit for gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
histogram integer | null

Configure default cardinality limit for histogram instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_counter integer | null

Configure default cardinality limit for observable_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_gauge integer | null

Configure default cardinality limit for observable_gauge instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
observable_up_down_counter integer | null

Configure default cardinality limit for observable_up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
up_down_counter integer | null

Configure default cardinality limit for up_down_counter instruments. If omitted or null, the value from .default is used.

exclusiveMin=0
PushMetricExporter Record<string, object | null>
otlp_http object | null
9 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4318/v1/metrics is used.

tls object | null
3 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
otlp_grpc object | null
8 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
4 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

insecure boolean | null

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. If omitted or null, false is used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
otlp_file/development object | null
3 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
console object | null
2 nested properties
temporality_preference string | null
Values: "cumulative" "delta" "low_memory"
default_histogram_aggregation string | null
Values: "explicit_bucket_histogram" "base2_exponential_bucket_histogram"
Resource object
attributes AttributeNameValue[]

Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list. If omitted, no resource attributes are added.

minItems=1
detection/development object
2 nested properties
attributes object
2 nested properties
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
detectors ExperimentalResourceDetector[]

Configure resource detectors. Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. If omitted, no resource detectors are enabled.

minItems=1
schema_url string | null

Configure resource schema URL. If omitted or null, no schema URL is used.

attributes_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details. If omitted or null, no resource attributes are added.

Sampler Record<string, object | null>
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
1 nested properties
root Record<string, object | null> required
probability object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
rule_based object | null
1 nested properties
rules ExperimentalComposableRuleBasedSamplerRule[]

The rules for the sampler, matched in order. Each rule can have multiple match conditions. All conditions must match for the rule to match. If no conditions are specified, the rule matches all spans that reach it. If no rules match, the span is not sampled. If omitted, no span is sampled.

minItems=1
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
jaeger_remote/development object | null
parent_based object | null
probability/development object | null
trace_id_ratio_based object | null
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
jaeger_remote/development object | null
parent_based object | null
probability/development object | null
trace_id_ratio_based object | null
remote_parent_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
jaeger_remote/development object | null
parent_based object | null
probability/development object | null
trace_id_ratio_based object | null
remote_parent_not_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
jaeger_remote/development object | null
parent_based object | null
probability/development object | null
trace_id_ratio_based object | null
local_parent_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
jaeger_remote/development object | null
parent_based object | null
probability/development object | null
trace_id_ratio_based object | null
local_parent_not_sampled Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
jaeger_remote/development object | null
parent_based object | null
probability/development object | null
trace_id_ratio_based object | null
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
SeverityNumber string | null
SimpleLogRecordProcessor object
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
7 nested properties
endpoint string | null

Configure endpoint, including the signal specific path. If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
otlp_grpc object | null
6 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
otlp_file/development object | null
1 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

console object | null
SimpleSpanProcessor object
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
7 nested properties
endpoint string | null

Configure endpoint, including the signal specific path. If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
otlp_grpc object | null
6 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
otlp_file/development object | null
1 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

console object | null
SpanExporter Record<string, object | null>
otlp_http object | null
7 nested properties
endpoint string | null

Configure endpoint, including the signal specific path. If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.

tls object | null
3 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
encoding string | null
Values: "protobuf" "json"
otlp_grpc object | null
6 nested properties
endpoint string | null

Configure endpoint. If omitted or null, http://localhost:4317 is used.

tls object | null
4 nested properties
ca_file string | null

Configure certificate used to verify a server's TLS credentials. Absolute path to certificate file in PEM format. If omitted or null, system default certificate verification is used for secure connections.

key_file string | null

Configure mTLS private client key. Absolute path to client key file in PEM format. If set, .client_certificate must also be set. If omitted or null, mTLS is not used.

cert_file string | null

Configure mTLS client certificate. Absolute path to client certificate file in PEM format. If set, .client_key must also be set. If omitted or null, mTLS is not used.

insecure boolean | null

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. If omitted or null, false is used.

headers NameStringValuePair[]

Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. If omitted, no headers are added.

minItems=1
headers_list string | null

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 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details. If omitted or null, no headers are added.

compression string | null

Configure compression. Known values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used.

timeout integer | null

Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 10000 is used.

min=0
otlp_file/development object | null
1 nested properties
output_stream string | null

Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used.

console object | null
SpanKind string | null
SpanLimits object
attribute_value_length_limit integer | null

Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used.

min=0
event_count_limit integer | null

Configure max span event count. Value must be non-negative. If omitted or null, 128 is used.

min=0
link_count_limit integer | null

Configure max span link count. Value must be non-negative. If omitted or null, 128 is used.

min=0
event_attribute_count_limit integer | null

Configure max attributes per span event. Value must be non-negative. If omitted or null, 128 is used.

min=0
link_attribute_count_limit integer | null

Configure max attributes per span link. Value must be non-negative. If omitted or null, 128 is used.

min=0
SpanProcessor Record<string, object | null>
batch object
5 nested properties
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
otlp_grpc object | null
otlp_file/development object | null
console object | null
schedule_delay integer | null

Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. If omitted or null, 5000 is used.

min=0
export_timeout integer | null

Configure maximum allowed time (in milliseconds) to export data. Value must be non-negative. A value of 0 indicates no limit (infinity). If omitted or null, 30000 is used.

min=0
max_queue_size integer | null

Configure maximum queue size. Value must be positive. If omitted or null, 2048 is used.

exclusiveMin=0
max_export_batch_size integer | null

Configure maximum batch size. Value must be positive. If omitted or null, 512 is used.

exclusiveMin=0
simple object
1 nested properties
exporter Record<string, object | null> required
4 nested properties
otlp_http object | null
otlp_grpc object | null
otlp_file/development object | null
console object | null
SumAggregation object | null
TextMapPropagator Record<string, object | null>
tracecontext object | null
baggage object | null
b3 object | null
b3multi object | null
TraceContextPropagator object | null
TraceIdRatioBasedSampler object | null
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
TracerProvider object
processors SpanProcessor[] required

Configure span processors. Property is required and must be non-null.

minItems=1
limits object
6 nested properties
attribute_value_length_limit integer | null

Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. Value must be non-negative. If omitted or null, there is no limit.

min=0
attribute_count_limit integer | null

Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used.

min=0
event_count_limit integer | null

Configure max span event count. Value must be non-negative. If omitted or null, 128 is used.

min=0
link_count_limit integer | null

Configure max span link count. Value must be non-negative. If omitted or null, 128 is used.

min=0
event_attribute_count_limit integer | null

Configure max attributes per span event. Value must be non-negative. If omitted or null, 128 is used.

min=0
link_attribute_count_limit integer | null

Configure max attributes per span link. Value must be non-negative. If omitted or null, 128 is used.

min=0
sampler Record<string, object | null>
7 nested properties
always_off object | null
always_on object | null
composite/development Record<string, object | null>
5 nested properties
always_off object | null
always_on object | null
parent_threshold object
probability object | null
rule_based object | null
jaeger_remote/development object | null
3 nested properties
endpoint string required

Configure the endpoint of the jaeger remote sampling service. Property is required and must be non-null.

initial_sampler Record<string, object | null> required
interval integer | null

Configure the polling interval (in milliseconds) to fetch from the remote sampling service. If omitted or null, 60000 is used.

min=0
parent_based object | null
5 nested properties
root Record<string, object | null>
remote_parent_sampled Record<string, object | null>
remote_parent_not_sampled Record<string, object | null>
local_parent_sampled Record<string, object | null>
local_parent_not_sampled Record<string, object | null>
probability/development object | null
1 nested properties
ratio number | null

Configure ratio. If omitted or null, 1.0 is used.

min=0max=1
trace_id_ratio_based object | null
1 nested properties
ratio number | null

Configure trace_id_ratio. If omitted or null, 1.0 is used.

min=0max=1
tracer_configurator/development object
2 nested properties
default_config object
1 nested properties
enabled boolean

Configure if the tracer is enabled or not. If omitted, true is used.

tracers ExperimentalTracerMatcherAndConfig[]

Configure tracers. If omitted, all tracers use .default_config.

minItems=1
View object
selector object required
6 nested properties
instrument_name string | null

Configure instrument name selection criteria. If omitted or null, all instrument names match.

instrument_type string | null
Values: "counter" "gauge" "histogram" "observable_counter" "observable_gauge" "observable_up_down_counter" "up_down_counter"
unit string | null

Configure the instrument unit selection criteria. If omitted or null, all instrument units match.

meter_name string | null

Configure meter name selection criteria. If omitted or null, all meter names match.

meter_version string | null

Configure meter version selection criteria. If omitted or null, all meter versions match.

meter_schema_url string | null

Configure meter schema url selection criteria. If omitted or null, all meter schema URLs match.

stream object required
5 nested properties
name string | null

Configure metric name of the resulting stream(s). If omitted or null, the instrument's original name is used.

description string | null

Configure metric description of the resulting stream(s). If omitted or null, the instrument's origin description is used.

aggregation object
6 nested properties
default object | null
drop object | null
explicit_bucket_histogram object | null
base2_exponential_bucket_histogram object | null
last_value object | null
sum object | null
aggregation_cardinality_limit integer | null

Configure the aggregation cardinality limit. If omitted or null, the metric reader's default cardinality limit is used.

exclusiveMin=0
attribute_keys object
2 nested properties
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1
ViewSelector object
instrument_name string | null

Configure instrument name selection criteria. If omitted or null, all instrument names match.

instrument_type string | null
Values: "counter" "gauge" "histogram" "observable_counter" "observable_gauge" "observable_up_down_counter" "up_down_counter"
unit string | null

Configure the instrument unit selection criteria. If omitted or null, all instrument units match.

meter_name string | null

Configure meter name selection criteria. If omitted or null, all meter names match.

meter_version string | null

Configure meter version selection criteria. If omitted or null, all meter versions match.

meter_schema_url string | null

Configure meter schema url selection criteria. If omitted or null, all meter schema URLs match.

ViewStream object
name string | null

Configure metric name of the resulting stream(s). If omitted or null, the instrument's original name is used.

description string | null

Configure metric description of the resulting stream(s). If omitted or null, the instrument's origin description is used.

aggregation object
6 nested properties
default object | null
drop object | null
explicit_bucket_histogram object | null
2 nested properties
boundaries number[]

Configure bucket boundaries. If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used.

minItems=0
record_min_max boolean | null

Configure record min and max. If omitted or null, true is used.

base2_exponential_bucket_histogram object | null
3 nested properties
max_scale integer | null

Configure the max scale factor. If omitted or null, 20 is used.

min=-10max=20
max_size integer | null

Configure the maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket. If omitted or null, 160 is used.

min=2
record_min_max boolean | null

Configure whether or not to record min and max. If omitted or null, true is used.

last_value object | null
sum object | null
aggregation_cardinality_limit integer | null

Configure the aggregation cardinality limit. If omitted or null, the metric reader's default cardinality limit is used.

exclusiveMin=0
attribute_keys object
2 nested properties
included string[]

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. If omitted, all values are included.
minItems=1
excluded string[]

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. If omitted, .included attributes are included.
minItems=1