diff --git a/opentelemetry_configuration.json b/opentelemetry_configuration.json index bec64252..8e85fb13 100644 --- a/opentelemetry_configuration.json +++ b/opentelemetry_configuration.json @@ -25,7 +25,7 @@ }, "attribute_limits": { "$ref": "#/$defs/AttributeLimits", - "description": "Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.\nIf omitted, TODO.\n" + "description": "Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.\nIf omitted, default values as described in AttributeLimits are used.\n" }, "logger_provider": { "$ref": "#/$defs/LoggerProvider", @@ -64,27 +64,27 @@ "properties": { "default": { "$ref": "#/$defs/DefaultAggregation", - "description": "Configures the stream to use the instrument kind to select an aggregation and advisory parameters to influence aggregation configuration parameters. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#default-aggregation for details.\nIf omitted, TODO.\n" + "description": "Configures the stream to use the instrument kind to select an aggregation and advisory parameters to influence aggregation configuration parameters. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#default-aggregation for details.\nIf omitted, ignore.\n" }, "drop": { "$ref": "#/$defs/DropAggregation", - "description": "Configures the stream to ignore/drop all instrument measurements. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation for details.\nIf omitted, TODO.\n" + "description": "Configures the stream to ignore/drop all instrument measurements. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation for details.\nIf omitted, ignore.\n" }, "explicit_bucket_histogram": { "$ref": "#/$defs/ExplicitBucketHistogramAggregation", - "description": "Configures the stream to collect data for the histogram metric point using a set of explicit boundary values for histogram bucketing. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation for details\nIf omitted, TODO.\n" + "description": "Configures the stream to collect data for the histogram metric point using a set of explicit boundary values for histogram bucketing. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation for details\nIf omitted, ignore.\n" }, "base2_exponential_bucket_histogram": { "$ref": "#/$defs/Base2ExponentialBucketHistogramAggregation", - "description": "Configures the stream to collect data for the exponential histogram metric point, which uses a base-2 exponential formula to determine bucket boundaries and an integer scale parameter to control resolution. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation for details.\nIf omitted, TODO.\n" + "description": "Configures the stream to collect data for the exponential histogram metric point, which uses a base-2 exponential formula to determine bucket boundaries and an integer scale parameter to control resolution. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation for details.\nIf omitted, ignore.\n" }, "last_value": { "$ref": "#/$defs/LastValueAggregation", - "description": "Configures the stream to collect data using the last measurement. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#last-value-aggregation for details.\nIf omitted, TODO.\n" + "description": "Configures the stream to collect data using the last measurement. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#last-value-aggregation for details.\nIf omitted, ignore.\n" }, "sum": { "$ref": "#/$defs/SumAggregation", - "description": "Configures the stream to collect the arithmetic sum of measurement values. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details.\nIf omitted, TODO.\n" + "description": "Configures the stream to collect the arithmetic sum of measurement values. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details.\nIf omitted, ignore.\n" } } }, @@ -1323,7 +1323,7 @@ }, "limits": { "$ref": "#/$defs/LogRecordLimits", - "description": "Configure log record limits. See also attribute_limits.\nIf omitted, TODO.\n" + "description": "Configure log record limits. See also attribute_limits.\nIf omitted, default values as described in LogRecordLimits are used.\n" }, "logger_configurator/development": { "$ref": "#/$defs/ExperimentalLoggerConfigurator", @@ -1347,11 +1347,11 @@ "properties": { "otlp_http": { "$ref": "#/$defs/OtlpHttpExporter", - "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, ignore.\n" }, "otlp_grpc": { "$ref": "#/$defs/OtlpGrpcExporter", - "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, ignore.\n" }, "otlp_file/development": { "$ref": "#/$defs/ExperimentalOtlpFileExporter", @@ -1359,7 +1359,7 @@ }, "console": { "$ref": "#/$defs/ConsoleExporter", - "description": "Configure exporter to be console.\nIf omitted, TODO.\n" + "description": "Configure exporter to be console.\nIf omitted, ignore.\n" } } }, @@ -1398,11 +1398,11 @@ "properties": { "batch": { "$ref": "#/$defs/BatchLogRecordProcessor", - "description": "Configure a batch log record processor.\nIf omitted, TODO.\n" + "description": "Configure a batch log record processor.\nIf omitted, ignore.\n" }, "simple": { "$ref": "#/$defs/SimpleLogRecordProcessor", - "description": "Configure a simple log record processor.\nIf omitted, TODO.\n" + "description": "Configure a simple log record processor.\nIf omitted, ignore.\n" } } }, @@ -1424,7 +1424,7 @@ "items": { "$ref": "#/$defs/View" }, - "description": "Configure views. \nEach view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s).\nIf omitted, TODO.\n" + "description": "Configure views. \nEach view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s).\nIf omitted, no views are registered.\n" }, "exemplar_filter": { "$ref": "#/$defs/ExemplarFilter", @@ -1452,7 +1452,7 @@ "properties": { "opencensus": { "$ref": "#/$defs/OpenCensusMetricProducer", - "description": "Configure metric producer to be opencensus.\nIf omitted, TODO.\n" + "description": "Configure metric producer to be opencensus.\nIf omitted, ignore.\n" } } }, @@ -1464,11 +1464,11 @@ "properties": { "periodic": { "$ref": "#/$defs/PeriodicMetricReader", - "description": "Configure a periodic metric reader.\nIf omitted, TODO.\n" + "description": "Configure a periodic metric reader.\nIf omitted, ignore.\n" }, "pull": { "$ref": "#/$defs/PullMetricReader", - "description": "Configure a pull based metric reader.\nIf omitted, TODO.\n" + "description": "Configure a pull based metric reader.\nIf omitted, ignore.\n" } } }, @@ -1573,7 +1573,7 @@ }, "tls": { "$ref": "#/$defs/GrpcTls", - "description": "Configure TLS settings for the exporter.\nIf omitted, TODO.\n" + "description": "Configure TLS settings for the exporter.\nIf omitted, system default TLS settings are used.\n" }, "headers": { "type": "array", @@ -1581,7 +1581,7 @@ "items": { "$ref": "#/$defs/NameStringValuePair" }, - "description": "Configure headers. Entries have higher priority than entries from .headers_list.\nIf an entry's .value is null, the entry is ignored.\nIf omitted, TODO.\n" + "description": "Configure headers. Entries have higher priority than entries from .headers_list.\nIf an entry's .value is null, the entry is ignored.\nIf omitted, no headers are added.\n" }, "headers_list": { "type": [ @@ -1695,7 +1695,7 @@ }, "tls": { "$ref": "#/$defs/HttpTls", - "description": "Configure TLS settings for the exporter.\nIf omitted, TODO.\n" + "description": "Configure TLS settings for the exporter.\nIf omitted, system default TLS settings are used.\n" }, "headers": { "type": "array", @@ -1703,7 +1703,7 @@ "items": { "$ref": "#/$defs/NameStringValuePair" }, - "description": "Configure headers. Entries have higher priority than entries from .headers_list.\nIf an entry's .value is null, the entry is ignored.\nIf omitted, TODO.\n" + "description": "Configure headers. Entries have higher priority than entries from .headers_list.\nIf an entry's .value is null, the entry is ignored.\nIf omitted, no headers are added.\n" }, "headers_list": { "type": [ @@ -1800,11 +1800,11 @@ "items": { "$ref": "#/$defs/MetricProducer" }, - "description": "Configure metric producers.\nIf omitted, TODO.\n" + "description": "Configure metric producers.\nIf omitted, no metric producers are added.\n" }, "cardinality_limits": { "$ref": "#/$defs/CardinalityLimits", - "description": "Configure cardinality limits.\nIf omitted, TODO.\n" + "description": "Configure cardinality limits.\nIf omitted, default values as described in CardinalityLimits are used.\n" } }, "required": [ @@ -1821,14 +1821,14 @@ "items": { "$ref": "#/$defs/TextMapPropagator" }, - "description": "Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.\nBuilt-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray. \nIf the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.\nIf omitted, TODO.\n" + "description": "Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.\nBuilt-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray. \nIf omitted, and .composite_list is omitted or null, a noop propagator is used.\n" }, "composite_list": { "type": [ "string", "null" ], - "description": "Configure the propagators in the composite text map propagator. Entries are appended to .composite with duplicates filtered out.\nThe 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.\nBuilt-in propagator identifiers include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party identifiers include: xray. \nIf the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.\nIf omitted or null, TODO.\n" + "description": "Configure the propagators in the composite text map propagator. Entries are appended to .composite with duplicates filtered out.\nThe 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.\nBuilt-in propagator identifiers include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party identifiers include: xray. \nIf omitted or null, and .composite is omitted or null, a noop propagator is used.\n" } } }, @@ -1863,11 +1863,11 @@ "items": { "$ref": "#/$defs/MetricProducer" }, - "description": "Configure metric producers.\nIf omitted, TODO.\n" + "description": "Configure metric producers.\nIf omitted, no metric producers are added.\n" }, "cardinality_limits": { "$ref": "#/$defs/CardinalityLimits", - "description": "Configure cardinality limits.\nIf omitted, TODO.\n" + "description": "Configure cardinality limits.\nIf omitted, default values as described in CardinalityLimits are used.\n" } }, "required": [ @@ -1887,11 +1887,11 @@ "properties": { "otlp_http": { "$ref": "#/$defs/OtlpHttpMetricExporter", - "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, ignore.\n" }, "otlp_grpc": { "$ref": "#/$defs/OtlpGrpcMetricExporter", - "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, ignore.\n" }, "otlp_file/development": { "$ref": "#/$defs/ExperimentalOtlpFileMetricExporter", @@ -1899,7 +1899,7 @@ }, "console": { "$ref": "#/$defs/ConsoleMetricExporter", - "description": "Configure exporter to be console.\nIf omitted, TODO.\n" + "description": "Configure exporter to be console.\nIf omitted, ignore.\n" } } }, @@ -1913,7 +1913,7 @@ "items": { "$ref": "#/$defs/AttributeNameValue" }, - "description": "Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.\nIf omitted, TODO.\n" + "description": "Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.\nIf omitted, no resource attributes are added.\n" }, "detection/development": { "$ref": "#/$defs/ExperimentalResourceDetection", @@ -1948,11 +1948,11 @@ "properties": { "always_off": { "$ref": "#/$defs/AlwaysOffSampler", - "description": "Configure sampler to be always_off.\nIf omitted, TODO.\n" + "description": "Configure sampler to be always_off.\nIf omitted, ignore.\n" }, "always_on": { "$ref": "#/$defs/AlwaysOnSampler", - "description": "Configure sampler to be always_on.\nIf omitted, TODO.\n" + "description": "Configure sampler to be always_on.\nIf omitted, ignore.\n" }, "composite/development": { "$ref": "#/$defs/ExperimentalComposableSampler", @@ -1964,7 +1964,7 @@ }, "parent_based": { "$ref": "#/$defs/ParentBasedSampler", - "description": "Configure sampler to be parent_based.\nIf omitted, TODO.\n" + "description": "Configure sampler to be parent_based.\nIf omitted, ignore.\n" }, "probability/development": { "$ref": "#/$defs/ExperimentalProbabilitySampler", @@ -1972,7 +1972,7 @@ }, "trace_id_ratio_based": { "$ref": "#/$defs/TraceIdRatioBasedSampler", - "description": "Configure sampler to be trace_id_ratio_based.\nIf omitted, TODO.\n" + "description": "Configure sampler to be trace_id_ratio_based.\nIf omitted, ignore.\n" } } }, @@ -2015,11 +2015,11 @@ "properties": { "otlp_http": { "$ref": "#/$defs/OtlpHttpExporter", - "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, ignore.\n" }, "otlp_grpc": { "$ref": "#/$defs/OtlpGrpcExporter", - "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, ignore.\n" }, "otlp_file/development": { "$ref": "#/$defs/ExperimentalOtlpFileExporter", @@ -2027,11 +2027,11 @@ }, "console": { "$ref": "#/$defs/ConsoleExporter", - "description": "Configure exporter to be console.\nIf omitted, TODO.\n" + "description": "Configure exporter to be console.\nIf omitted, ignore.\n" }, "zipkin": { "$ref": "#/$defs/ZipkinSpanExporter", - "description": "Configure exporter to be zipkin.\nIf omitted, TODO.\n" + "description": "Configure exporter to be zipkin.\nIf omitted, ignore.\n" } } }, @@ -2102,11 +2102,11 @@ "properties": { "batch": { "$ref": "#/$defs/BatchSpanProcessor", - "description": "Configure a batch span processor.\nIf omitted, TODO.\n" + "description": "Configure a batch span processor.\nIf omitted, ignore.\n" }, "simple": { "$ref": "#/$defs/SimpleSpanProcessor", - "description": "Configure a simple span processor.\nIf omitted, TODO.\n" + "description": "Configure a simple span processor.\nIf omitted, ignore.\n" } } }, @@ -2130,27 +2130,27 @@ "properties": { "tracecontext": { "$ref": "#/$defs/TraceContextPropagator", - "description": "Include the w3c trace context propagator.\nIf omitted, TODO.\n" + "description": "Include the w3c trace context propagator.\nIf omitted, ignore.\n" }, "baggage": { "$ref": "#/$defs/BaggagePropagator", - "description": "Include the w3c baggage propagator.\nIf omitted, TODO.\n" + "description": "Include the w3c baggage propagator.\nIf omitted, ignore.\n" }, "b3": { "$ref": "#/$defs/B3Propagator", - "description": "Include the zipkin b3 propagator.\nIf omitted, TODO.\n" + "description": "Include the zipkin b3 propagator.\nIf omitted, ignore.\n" }, "b3multi": { "$ref": "#/$defs/B3MultiPropagator", - "description": "Include the zipkin b3 multi propagator.\nIf omitted, TODO.\n" + "description": "Include the zipkin b3 multi propagator.\nIf omitted, ignore.\n" }, "jaeger": { "$ref": "#/$defs/JaegerPropagator", - "description": "Include the jaeger propagator.\nIf omitted, TODO.\n" + "description": "Include the jaeger propagator.\nIf omitted, ignore.\n" }, "ottrace": { "$ref": "#/$defs/OpenTracingPropagator", - "description": "Include the opentracing propagator.\nIf omitted, TODO.\n" + "description": "Include the opentracing propagator.\nIf omitted, ignore.\n" } } }, @@ -2193,7 +2193,7 @@ }, "limits": { "$ref": "#/$defs/SpanLimits", - "description": "Configure span limits. See also attribute_limits.\nIf omitted, TODO.\n" + "description": "Configure span limits. See also attribute_limits.\nIf omitted, default values as described in SpanLimits are used.\n" }, "sampler": { "$ref": "#/$defs/Sampler", @@ -2303,7 +2303,7 @@ }, "attribute_keys": { "$ref": "#/$defs/IncludeExclude", - "description": "Configure attribute keys retained in the resulting stream(s).\nIf omitted, TODO.\n" + "description": "Configure attribute keys retained in the resulting stream(s).\nIf omitted, all attribute keys are retained.\n" } } }, diff --git a/schema-docs.md b/schema-docs.md index ac4da1d9..0022c300 100644 --- a/schema-docs.md +++ b/schema-docs.md @@ -16,12 +16,12 @@ This document is an auto-generated view of the declarative configuration JSON sc | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `base2_exponential_bucket_histogram` | [`Base2ExponentialBucketHistogramAggregation`](#base2exponentialbuckethistogramaggregation) | `false` | If omitted, TODO. | No constraints. | Configures the stream to collect data for the exponential histogram metric point, which uses a base-2 exponential formula to determine bucket boundaries and an integer scale parameter to control resolution. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation for details. | -| `default` | [`DefaultAggregation`](#defaultaggregation) | `false` | If omitted, TODO. | No constraints. | Configures the stream to use the instrument kind to select an aggregation and advisory parameters to influence aggregation configuration parameters. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#default-aggregation for details. | -| `drop` | [`DropAggregation`](#dropaggregation) | `false` | If omitted, TODO. | No constraints. | Configures the stream to ignore/drop all instrument measurements. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation for details. | -| `explicit_bucket_histogram` | [`ExplicitBucketHistogramAggregation`](#explicitbuckethistogramaggregation) | `false` | If omitted, TODO. | No constraints. | Configures the stream to collect data for the histogram metric point using a set of explicit boundary values for histogram bucketing. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation for details | -| `last_value` | [`LastValueAggregation`](#lastvalueaggregation) | `false` | If omitted, TODO. | No constraints. | Configures the stream to collect data using the last measurement. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#last-value-aggregation for details. | -| `sum` | [`SumAggregation`](#sumaggregation) | `false` | If omitted, TODO. | No constraints. | Configures the stream to collect the arithmetic sum of measurement values. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details. | +| `base2_exponential_bucket_histogram` | [`Base2ExponentialBucketHistogramAggregation`](#base2exponentialbuckethistogramaggregation) | `false` | If omitted, ignore. | No constraints. | Configures the stream to collect data for the exponential histogram metric point, which uses a base-2 exponential formula to determine bucket boundaries and an integer scale parameter to control resolution. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation for details. | +| `default` | [`DefaultAggregation`](#defaultaggregation) | `false` | If omitted, ignore. | No constraints. | Configures the stream to use the instrument kind to select an aggregation and advisory parameters to influence aggregation configuration parameters. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#default-aggregation for details. | +| `drop` | [`DropAggregation`](#dropaggregation) | `false` | If omitted, ignore. | No constraints. | Configures the stream to ignore/drop all instrument measurements. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation for details. | +| `explicit_bucket_histogram` | [`ExplicitBucketHistogramAggregation`](#explicitbuckethistogramaggregation) | `false` | If omitted, ignore. | No constraints. | Configures the stream to collect data for the histogram metric point using a set of explicit boundary values for histogram bucketing. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation for details | +| `last_value` | [`LastValueAggregation`](#lastvalueaggregation) | `false` | If omitted, ignore. | No constraints. | Configures the stream to collect data using the last measurement. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#last-value-aggregation for details. | +| `sum` | [`SumAggregation`](#sumaggregation) | `false` | If omitted, ignore. | No constraints. | Configures the stream to collect the arithmetic sum of measurement values. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details. |
Language support status @@ -1312,7 +1312,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `limits` | [`LogRecordLimits`](#logrecordlimits) | `false` | If omitted, TODO. | No constraints. | Configure log record limits. See also attribute_limits. | +| `limits` | [`LogRecordLimits`](#logrecordlimits) | `false` | If omitted, default values as described in LogRecordLimits are used. | No constraints. | Configure log record limits. See also attribute_limits. | | `processors` | `array` of [`LogRecordProcessor`](#logrecordprocessor) | `true` | Property is required and must be non-null. | * `minItems`: `1`
| Configure log record processors. | | `logger_configurator/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalLoggerConfigurator`](#experimentalloggerconfigurator) | `false` | If omitted, all loggers use default values as described in ExperimentalLoggerConfig. | No constraints. | Configure loggers.
| @@ -1369,9 +1369,9 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `console` | [`ConsoleExporter`](#consoleexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be console. | -| `otlp_grpc` | [`OtlpGrpcExporter`](#otlpgrpcexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with gRPC transport. | -| `otlp_http` | [`OtlpHttpExporter`](#otlphttpexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with HTTP transport. | +| `console` | [`ConsoleExporter`](#consoleexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be console. | +| `otlp_grpc` | [`OtlpGrpcExporter`](#otlpgrpcexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with gRPC transport. | +| `otlp_http` | [`OtlpHttpExporter`](#otlphttpexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with HTTP transport. | | `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileExporter`](#experimentalotlpfileexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with file transport.
|
@@ -1483,8 +1483,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `batch` | [`BatchLogRecordProcessor`](#batchlogrecordprocessor) | `false` | If omitted, TODO. | No constraints. | Configure a batch log record processor. | -| `simple` | [`SimpleLogRecordProcessor`](#simplelogrecordprocessor) | `false` | If omitted, TODO. | No constraints. | Configure a simple log record processor. | +| `batch` | [`BatchLogRecordProcessor`](#batchlogrecordprocessor) | `false` | If omitted, ignore. | No constraints. | Configure a batch log record processor. | +| `simple` | [`SimpleLogRecordProcessor`](#simplelogrecordprocessor) | `false` | If omitted, ignore. | No constraints. | Configure a simple log record processor. |
Language support status @@ -1536,7 +1536,7 @@ Usages: |---|---|---|---|---|---| | `exemplar_filter` | [`ExemplarFilter`](#exemplarfilter) | `false` | If omitted, trace_based is used. | No constraints. | Configure the exemplar filter.
Values include: trace_based, always_on, always_off. For behavior of values see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#metrics-sdk-configuration.
| | `readers` | `array` of [`MetricReader`](#metricreader) | `true` | Property is required and must be non-null. | * `minItems`: `1`
| Configure metric readers. | -| `views` | `array` of [`View`](#view) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure views.
Each view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s).
| +| `views` | `array` of [`View`](#view) | `false` | If omitted, no views are registered. | * `minItems`: `1`
| Configure views.
Each view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s).
| | `meter_configurator/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalMeterConfigurator`](#experimentalmeterconfigurator) | `false` | If omitted, all meters use default values as described in ExperimentalMeterConfig. | No constraints. | Configure meters.
|
@@ -1600,7 +1600,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `opencensus` | [`OpenCensusMetricProducer`](#opencensusmetricproducer) | `false` | If omitted, TODO. | No constraints. | Configure metric producer to be opencensus. | +| `opencensus` | [`OpenCensusMetricProducer`](#opencensusmetricproducer) | `false` | If omitted, ignore. | No constraints. | Configure metric producer to be opencensus. |
Language support status @@ -1647,8 +1647,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `periodic` | [`PeriodicMetricReader`](#periodicmetricreader) | `false` | If omitted, TODO. | No constraints. | Configure a periodic metric reader. | -| `pull` | [`PullMetricReader`](#pullmetricreader) | `false` | If omitted, TODO. | No constraints. | Configure a pull based metric reader. | +| `periodic` | [`PeriodicMetricReader`](#periodicmetricreader) | `false` | If omitted, ignore. | No constraints. | Configure a periodic metric reader. | +| `pull` | [`PullMetricReader`](#pullmetricreader) | `false` | If omitted, ignore. | No constraints. | Configure a pull based metric reader. |
Language support status @@ -1771,7 +1771,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `attribute_limits` | [`AttributeLimits`](#attributelimits) | `false` | If omitted, TODO. | No constraints. | Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.
| +| `attribute_limits` | [`AttributeLimits`](#attributelimits) | `false` | If omitted, default values as described in AttributeLimits are used. | No constraints. | Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.
| | `disabled` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, false is used. | No constraints. | Configure if the SDK is disabled or not.
| | `file_format` | `string` | `true` | Property is required and must be non-null. | No constraints. | The file format version.
The yaml format is documented at
https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
| | `log_level` | one of:
* `string`
* `null`
| `false` | If omitted or null, info is used. | No constraints. | Configure the log level of the internal logger used by the SDK.
| @@ -1975,11 +1975,11 @@ Usages: | `compression` | one of:
* `string`
* `null`
| `false` | If omitted or null, none is used. | No constraints. | Configure compression.
Values include: gzip, none. Implementations may support other compression algorithms.
| | `default_histogram_aggregation` | [`ExporterDefaultHistogramAggregation`](#exporterdefaulthistogramaggregation) | `false` | If omitted, explicit_bucket_histogram is used. | No constraints. | Configure default histogram aggregation.
Values include: explicit_bucket_histogram, base2_exponential_bucket_histogram. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
| | `endpoint` | one of:
* `string`
* `null`
| `false` | If omitted or null, http://localhost:4317 is used. | No constraints. | Configure endpoint.
| -| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers. Entries have higher priority than entries from .headers_list.
If an entry's .value is null, the entry is ignored.
| +| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | If omitted, no headers are added. | * `minItems`: `1`
| Configure headers. Entries have higher priority than entries from .headers_list.
If an entry's .value is null, the entry is ignored.
| | `headers_list` | one of:
* `string`
* `null`
| `false` | If omitted or null, no headers are added. | No constraints. | 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.
| | `temporality_preference` | [`ExporterTemporalityPreference`](#exportertemporalitypreference) | `false` | If omitted, cumulative is used. | No constraints. | Configure temporality preference.
Values include: cumulative, delta, low_memory. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
| | `timeout` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 10000 is used. | * `minimum`: `0`
| Configure max time (in milliseconds) to wait for each export.
Value must be non-negative. A value of 0 indicates no limit (infinity).
| -| `tls` | [`GrpcTls`](#grpctls) | `false` | If omitted, TODO. | No constraints. | Configure TLS settings for the exporter. | +| `tls` | [`GrpcTls`](#grpctls) | `false` | If omitted, system default TLS settings are used. | No constraints. | Configure TLS settings for the exporter. |
Language support status @@ -2197,11 +2197,11 @@ Usages: | `default_histogram_aggregation` | [`ExporterDefaultHistogramAggregation`](#exporterdefaulthistogramaggregation) | `false` | If omitted, explicit_bucket_histogram is used. | No constraints. | Configure default histogram aggregation.
Values include: explicit_bucket_histogram, base2_exponential_bucket_histogram. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
| | `encoding` | [`OtlpHttpEncoding`](#otlphttpencoding) | `false` | If omitted, protobuf is used. | No constraints. | Configure the encoding used for messages.
Values include: protobuf, json. Implementations may not support json.
| | `endpoint` | one of:
* `string`
* `null`
| `false` | If omitted or null, http://localhost:4318/v1/metrics is used. | No constraints. | Configure endpoint.
| -| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers. Entries have higher priority than entries from .headers_list.
If an entry's .value is null, the entry is ignored.
| +| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | If omitted, no headers are added. | * `minItems`: `1`
| Configure headers. Entries have higher priority than entries from .headers_list.
If an entry's .value is null, the entry is ignored.
| | `headers_list` | one of:
* `string`
* `null`
| `false` | If omitted or null, no headers are added. | No constraints. | 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.
| | `temporality_preference` | [`ExporterTemporalityPreference`](#exportertemporalitypreference) | `false` | If omitted, cumulative is used. | No constraints. | Configure temporality preference.
Values include: cumulative, delta, low_memory. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
| | `timeout` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 10000 is used. | * `minimum`: `0`
| Configure max time (in milliseconds) to wait for each export.
Value must be non-negative. A value of 0 indicates no limit (infinity).
| -| `tls` | [`HttpTls`](#httptls) | `false` | If omitted, TODO. | No constraints. | Configure TLS settings for the exporter. | +| `tls` | [`HttpTls`](#httptls) | `false` | If omitted, system default TLS settings are used. | No constraints. | Configure TLS settings for the exporter. |
Language support status @@ -2350,10 +2350,10 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | If omitted, TODO. | No constraints. | Configure cardinality limits. | +| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | If omitted, default values as described in CardinalityLimits are used. | No constraints. | Configure cardinality limits. | | `exporter` | [`PushMetricExporter`](#pushmetricexporter) | `true` | Property is required and must be non-null. | No constraints. | Configure exporter. | | `interval` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 60000 is used. | * `minimum`: `0`
| Configure delay interval (in milliseconds) between start of two consecutive exports.
Value must be non-negative.
| -| `producers` | `array` of [`MetricProducer`](#metricproducer) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure metric producers. | +| `producers` | `array` of [`MetricProducer`](#metricproducer) | `false` | If omitted, no metric producers are added. | * `minItems`: `1`
| Configure metric producers. | | `timeout` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 30000 is used. | * `minimum`: `0`
| Configure maximum allowed time (in milliseconds) to export data.
Value must be non-negative. A value of 0 indicates no limit (infinity).
|
@@ -2423,8 +2423,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `composite` | `array` of [`TextMapPropagator`](#textmappropagator) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.
Built-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray.
If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.
| -| `composite_list` | one of:
* `string`
* `null`
| `false` | If omitted or null, TODO. | No constraints. | 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, jaeger, ottrace. Known third party identifiers include: xray.
If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.
| +| `composite` | `array` of [`TextMapPropagator`](#textmappropagator) | `false` | If omitted, and .composite_list is omitted or null, a noop propagator is used. | * `minItems`: `1`
| Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.
Built-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray.
| +| `composite_list` | one of:
* `string`
* `null`
| `false` | If omitted or null, and .composite is omitted or null, a noop propagator is used. | No constraints. | 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, jaeger, ottrace. Known third party identifiers include: xray.
|
Language support status @@ -2520,9 +2520,9 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | If omitted, TODO. | No constraints. | Configure cardinality limits. | +| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | If omitted, default values as described in CardinalityLimits are used. | No constraints. | Configure cardinality limits. | | `exporter` | [`PullMetricExporter`](#pullmetricexporter) | `true` | Property is required and must be non-null. | No constraints. | Configure exporter. | -| `producers` | `array` of [`MetricProducer`](#metricproducer) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure metric producers. | +| `producers` | `array` of [`MetricProducer`](#metricproducer) | `false` | If omitted, no metric producers are added. | * `minItems`: `1`
| Configure metric producers. |
Language support status @@ -2577,9 +2577,9 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `console` | [`ConsoleMetricExporter`](#consolemetricexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be console.
| -| `otlp_grpc` | [`OtlpGrpcMetricExporter`](#otlpgrpcmetricexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with gRPC transport.
| -| `otlp_http` | [`OtlpHttpMetricExporter`](#otlphttpmetricexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with HTTP transport.
| +| `console` | [`ConsoleMetricExporter`](#consolemetricexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be console.
| +| `otlp_grpc` | [`OtlpGrpcMetricExporter`](#otlpgrpcmetricexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with gRPC transport.
| +| `otlp_http` | [`OtlpHttpMetricExporter`](#otlphttpmetricexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with HTTP transport.
| | `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileMetricExporter`](#experimentalotlpfilemetricexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with file transport.
|
@@ -2638,7 +2638,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `attributes` | `array` of [`AttributeNameValue`](#attributenamevalue) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.
| +| `attributes` | `array` of [`AttributeNameValue`](#attributenamevalue) | `false` | If omitted, no resource attributes are added. | * `minItems`: `1`
| Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.
| | `attributes_list` | one of:
* `string`
* `null`
| `false` | If omitted or null, no resource attributes are added. | No constraints. | 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.
| | `schema_url` | one of:
* `string`
* `null`
| `false` | If omitted or null, no schema URL is used. | No constraints. | Configure resource schema URL.
| | `detection/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalResourceDetection`](#experimentalresourcedetection) | `false` | If omitted, resource detection is disabled. | No constraints. | Configure resource detection.
| @@ -2702,10 +2702,10 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `always_off` | [`AlwaysOffSampler`](#alwaysoffsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be always_off. | -| `always_on` | [`AlwaysOnSampler`](#alwaysonsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be always_on. | -| `parent_based` | [`ParentBasedSampler`](#parentbasedsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be parent_based. | -| `trace_id_ratio_based` | [`TraceIdRatioBasedSampler`](#traceidratiobasedsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be trace_id_ratio_based. | +| `always_off` | [`AlwaysOffSampler`](#alwaysoffsampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be always_off. | +| `always_on` | [`AlwaysOnSampler`](#alwaysonsampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be always_on. | +| `parent_based` | [`ParentBasedSampler`](#parentbasedsampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be parent_based. | +| `trace_id_ratio_based` | [`TraceIdRatioBasedSampler`](#traceidratiobasedsampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be trace_id_ratio_based. | | `composite/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be composite. | | `jaeger_remote/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalJaegerRemoteSampler`](#experimentaljaegerremotesampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be jaeger_remote. | | `probability/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be probability. | @@ -2868,10 +2868,10 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `console` | [`ConsoleExporter`](#consoleexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be console. | -| `otlp_grpc` | [`OtlpGrpcExporter`](#otlpgrpcexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with gRPC transport. | -| `otlp_http` | [`OtlpHttpExporter`](#otlphttpexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with HTTP transport. | -| `zipkin` | [`ZipkinSpanExporter`](#zipkinspanexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be zipkin. | +| `console` | [`ConsoleExporter`](#consoleexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be console. | +| `otlp_grpc` | [`OtlpGrpcExporter`](#otlpgrpcexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with gRPC transport. | +| `otlp_http` | [`OtlpHttpExporter`](#otlphttpexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with HTTP transport. | +| `zipkin` | [`ZipkinSpanExporter`](#zipkinspanexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be zipkin. | | `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileExporter`](#experimentalotlpfileexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be OTLP with file transport.
|
@@ -3023,8 +3023,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `batch` | [`BatchSpanProcessor`](#batchspanprocessor) | `false` | If omitted, TODO. | No constraints. | Configure a batch span processor. | -| `simple` | [`SimpleSpanProcessor`](#simplespanprocessor) | `false` | If omitted, TODO. | No constraints. | Configure a simple span processor. | +| `batch` | [`BatchSpanProcessor`](#batchspanprocessor) | `false` | If omitted, ignore. | No constraints. | Configure a batch span processor. | +| `simple` | [`SimpleSpanProcessor`](#simplespanprocessor) | `false` | If omitted, ignore. | No constraints. | Configure a simple span processor. |
Language support status @@ -3101,12 +3101,12 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `b3` | [`B3Propagator`](#b3propagator) | `false` | If omitted, TODO. | No constraints. | Include the zipkin b3 propagator. | -| `b3multi` | [`B3MultiPropagator`](#b3multipropagator) | `false` | If omitted, TODO. | No constraints. | Include the zipkin b3 multi propagator. | -| `baggage` | [`BaggagePropagator`](#baggagepropagator) | `false` | If omitted, TODO. | No constraints. | Include the w3c baggage propagator. | -| `jaeger` | [`JaegerPropagator`](#jaegerpropagator) | `false` | If omitted, TODO. | No constraints. | Include the jaeger propagator. | -| `ottrace` | [`OpenTracingPropagator`](#opentracingpropagator) | `false` | If omitted, TODO. | No constraints. | Include the opentracing propagator. | -| `tracecontext` | [`TraceContextPropagator`](#tracecontextpropagator) | `false` | If omitted, TODO. | No constraints. | Include the w3c trace context propagator. | +| `b3` | [`B3Propagator`](#b3propagator) | `false` | If omitted, ignore. | No constraints. | Include the zipkin b3 propagator. | +| `b3multi` | [`B3MultiPropagator`](#b3multipropagator) | `false` | If omitted, ignore. | No constraints. | Include the zipkin b3 multi propagator. | +| `baggage` | [`BaggagePropagator`](#baggagepropagator) | `false` | If omitted, ignore. | No constraints. | Include the w3c baggage propagator. | +| `jaeger` | [`JaegerPropagator`](#jaegerpropagator) | `false` | If omitted, ignore. | No constraints. | Include the jaeger propagator. | +| `ottrace` | [`OpenTracingPropagator`](#opentracingpropagator) | `false` | If omitted, ignore. | No constraints. | Include the opentracing propagator. | +| `tracecontext` | [`TraceContextPropagator`](#tracecontextpropagator) | `false` | If omitted, ignore. | No constraints. | Include the w3c trace context propagator. |
Language support status @@ -3242,7 +3242,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `limits` | [`SpanLimits`](#spanlimits) | `false` | If omitted, TODO. | No constraints. | Configure span limits. See also attribute_limits. | +| `limits` | [`SpanLimits`](#spanlimits) | `false` | If omitted, default values as described in SpanLimits are used. | No constraints. | Configure span limits. See also attribute_limits. | | `processors` | `array` of [`SpanProcessor`](#spanprocessor) | `true` | Property is required and must be non-null. | * `minItems`: `1`
| Configure span processors. | | `sampler` | [`Sampler`](#sampler) | `false` | If omitted, parent based sampler with a root of always_on is used. | No constraints. | Configure the sampler.
| | `tracer_configurator/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalTracerConfigurator`](#experimentaltracerconfigurator) | `false` | If omitted, all tracers use default values as described in ExperimentalTracerConfig. | No constraints. | Configure tracers.
| @@ -3428,7 +3428,7 @@ Usages: |---|---|---|---|---|---| | `aggregation` | [`Aggregation`](#aggregation) | `false` | If omitted, default is used. | No constraints. | Configure aggregation of the resulting stream(s).
Values include: default, drop, explicit_bucket_histogram, base2_exponential_bucket_histogram, last_value, sum. For behavior of values see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#aggregation.
| | `aggregation_cardinality_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the metric reader's default cardinality limit is used. | * `exclusiveMinimum`: `0`
| Configure the aggregation cardinality limit.
| -| `attribute_keys` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, TODO. | No constraints. | Configure attribute keys retained in the resulting stream(s).
| +| `attribute_keys` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, all attribute keys are retained. | No constraints. | Configure attribute keys retained in the resulting stream(s).
| | `description` | one of:
* `string`
* `null`
| `false` | If omitted or null, the instrument's origin description is used. | No constraints. | Configure metric description of the resulting stream(s).
| | `name` | one of:
* `string`
* `null`
| `false` | If omitted or null, the instrument's original name is used. | No constraints. | Configure metric name of the resulting stream(s).
| diff --git a/schema/logger_provider.yaml b/schema/logger_provider.yaml index f17b02d6..4f375a5f 100644 --- a/schema/logger_provider.yaml +++ b/schema/logger_provider.yaml @@ -10,7 +10,7 @@ properties: limits: $ref: "#/$defs/LogRecordLimits" description: Configure log record limits. See also attribute_limits. - defaultBehavior: TODO + defaultBehavior: default values as described in LogRecordLimits are used logger_configurator/development: $ref: "#/$defs/ExperimentalLoggerConfigurator" description: | @@ -83,11 +83,11 @@ $defs: otlp_http: $ref: common.yaml#/$defs/OtlpHttpExporter description: Configure exporter to be OTLP with HTTP transport. - defaultBehavior: TODO + defaultBehavior: ignore otlp_grpc: $ref: common.yaml#/$defs/OtlpGrpcExporter description: Configure exporter to be OTLP with gRPC transport. - defaultBehavior: TODO + defaultBehavior: ignore otlp_file/development: $ref: common.yaml#/$defs/ExperimentalOtlpFileExporter description: | @@ -96,7 +96,7 @@ $defs: console: $ref: common.yaml#/$defs/ConsoleExporter description: Configure exporter to be console. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true LogRecordLimits: type: object @@ -132,11 +132,11 @@ $defs: batch: $ref: "#/$defs/BatchLogRecordProcessor" description: Configure a batch log record processor. - defaultBehavior: TODO + defaultBehavior: ignore simple: $ref: "#/$defs/SimpleLogRecordProcessor" description: Configure a simple log record processor. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true ExperimentalLoggerConfigurator: type: diff --git a/schema/meter_provider.yaml b/schema/meter_provider.yaml index 2c4b631d..432d6276 100644 --- a/schema/meter_provider.yaml +++ b/schema/meter_provider.yaml @@ -15,7 +15,7 @@ properties: description: | Configure views. Each view has a selector which determines the instrument(s) it applies to, and a configuration for the resulting stream(s). - defaultBehavior: TODO + defaultBehavior: no views are registered exemplar_filter: $ref: "#/$defs/ExemplarFilter" description: | @@ -73,11 +73,11 @@ $defs: items: $ref: "#/$defs/MetricProducer" description: Configure metric producers. - defaultBehavior: TODO + defaultBehavior: no metric producers are added cardinality_limits: $ref: "#/$defs/CardinalityLimits" description: Configure cardinality limits. - defaultBehavior: TODO + defaultBehavior: default values as described in CardinalityLimits are used required: - exporter PullMetricReader: @@ -93,11 +93,11 @@ $defs: items: $ref: "#/$defs/MetricProducer" description: Configure metric producers. - defaultBehavior: TODO + defaultBehavior: no metric producers are added cardinality_limits: $ref: "#/$defs/CardinalityLimits" description: Configure cardinality limits. - defaultBehavior: TODO + defaultBehavior: default values as described in CardinalityLimits are used required: - exporter CardinalityLimits: @@ -182,12 +182,12 @@ $defs: $ref: "#/$defs/OtlpHttpMetricExporter" description: | Configure exporter to be OTLP with HTTP transport. - defaultBehavior: TODO + defaultBehavior: ignore otlp_grpc: $ref: "#/$defs/OtlpGrpcMetricExporter" description: | Configure exporter to be OTLP with gRPC transport. - defaultBehavior: TODO + defaultBehavior: ignore otlp_file/development: $ref: "#/$defs/ExperimentalOtlpFileMetricExporter" description: | @@ -197,7 +197,7 @@ $defs: $ref: "#/$defs/ConsoleMetricExporter" description: | Configure exporter to be console. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true PullMetricExporter: type: object @@ -226,7 +226,7 @@ $defs: opencensus: $ref: "#/$defs/OpenCensusMetricProducer" description: Configure metric producer to be opencensus. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true OpenCensusMetricProducer: type: @@ -305,11 +305,11 @@ $defs: periodic: $ref: "#/$defs/PeriodicMetricReader" description: Configure a periodic metric reader. - defaultBehavior: TODO + defaultBehavior: ignore pull: $ref: "#/$defs/PullMetricReader" description: Configure a pull based metric reader. - defaultBehavior: TODO + defaultBehavior: ignore ExporterTemporalityPreference: type: - string @@ -348,7 +348,7 @@ $defs: tls: $ref: common.yaml#/$defs/HttpTls description: Configure TLS settings for the exporter. - defaultBehavior: TODO + defaultBehavior: system default TLS settings are used headers: type: array minItems: 1 @@ -357,7 +357,7 @@ $defs: description: | Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. - defaultBehavior: TODO + defaultBehavior: no headers are added headers_list: type: - string @@ -417,7 +417,7 @@ $defs: tls: $ref: common.yaml#/$defs/GrpcTls description: Configure TLS settings for the exporter. - defaultBehavior: TODO + defaultBehavior: system default TLS settings are used headers: type: array minItems: 1 @@ -426,7 +426,7 @@ $defs: description: | Configure headers. Entries have higher priority than entries from .headers_list. If an entry's .value is null, the entry is ignored. - defaultBehavior: TODO + defaultBehavior: no headers are added headers_list: type: - string @@ -624,7 +624,7 @@ $defs: $ref: common.yaml#/$defs/IncludeExclude description: | Configure attribute keys retained in the resulting stream(s). - defaultBehavior: TODO + defaultBehavior: all attribute keys are retained Aggregation: type: object additionalProperties: false @@ -634,27 +634,27 @@ $defs: default: $ref: "#/$defs/DefaultAggregation" description: Configures the stream to use the instrument kind to select an aggregation and advisory parameters to influence aggregation configuration parameters. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#default-aggregation for details. - defaultBehavior: TODO + defaultBehavior: ignore drop: $ref: "#/$defs/DropAggregation" description: Configures the stream to ignore/drop all instrument measurements. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation for details. - defaultBehavior: TODO + defaultBehavior: ignore explicit_bucket_histogram: $ref: "#/$defs/ExplicitBucketHistogramAggregation" description: Configures the stream to collect data for the histogram metric point using a set of explicit boundary values for histogram bucketing. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation for details - defaultBehavior: TODO + defaultBehavior: ignore base2_exponential_bucket_histogram: $ref: "#/$defs/Base2ExponentialBucketHistogramAggregation" description: Configures the stream to collect data for the exponential histogram metric point, which uses a base-2 exponential formula to determine bucket boundaries and an integer scale parameter to control resolution. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation for details. - defaultBehavior: TODO + defaultBehavior: ignore last_value: $ref: "#/$defs/LastValueAggregation" description: Configures the stream to collect data using the last measurement. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#last-value-aggregation for details. - defaultBehavior: TODO + defaultBehavior: ignore sum: $ref: "#/$defs/SumAggregation" description: Configures the stream to collect the arithmetic sum of measurement values. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details. - defaultBehavior: TODO + defaultBehavior: ignore DefaultAggregation: type: - object diff --git a/schema/opentelemetry_configuration.yaml b/schema/opentelemetry_configuration.yaml index 6e88347b..728687d2 100644 --- a/schema/opentelemetry_configuration.yaml +++ b/schema/opentelemetry_configuration.yaml @@ -25,7 +25,7 @@ properties: $ref: "#/$defs/AttributeLimits" description: | Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits. - defaultBehavior: TODO + defaultBehavior: default values as described in AttributeLimits are used logger_provider: $ref: "#/$defs/LoggerProvider" description: | diff --git a/schema/propagator.yaml b/schema/propagator.yaml index 3e9447f3..2d553f8f 100644 --- a/schema/propagator.yaml +++ b/schema/propagator.yaml @@ -9,8 +9,7 @@ properties: description: | Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out. Built-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray. - If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used. - defaultBehavior: TODO + defaultBehavior: and .composite_list is omitted or null, a noop propagator is used composite_list: type: - string @@ -19,8 +18,7 @@ properties: 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, jaeger, ottrace. Known third party identifiers include: xray. - If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used. - defaultBehavior: TODO + defaultBehavior: and .composite is omitted or null, a noop propagator is used $defs: TextMapPropagator: type: object @@ -34,27 +32,27 @@ $defs: tracecontext: $ref: "#/$defs/TraceContextPropagator" description: Include the w3c trace context propagator. - defaultBehavior: TODO + defaultBehavior: ignore baggage: $ref: "#/$defs/BaggagePropagator" description: Include the w3c baggage propagator. - defaultBehavior: TODO + defaultBehavior: ignore b3: $ref: "#/$defs/B3Propagator" description: Include the zipkin b3 propagator. - defaultBehavior: TODO + defaultBehavior: ignore b3multi: $ref: "#/$defs/B3MultiPropagator" description: Include the zipkin b3 multi propagator. - defaultBehavior: TODO + defaultBehavior: ignore jaeger: $ref: "#/$defs/JaegerPropagator" description: Include the jaeger propagator. - defaultBehavior: TODO + defaultBehavior: ignore ottrace: $ref: "#/$defs/OpenTracingPropagator" description: Include the opentracing propagator. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true TraceContextPropagator: type: diff --git a/schema/resource.yaml b/schema/resource.yaml index 544d8338..e4796512 100644 --- a/schema/resource.yaml +++ b/schema/resource.yaml @@ -8,7 +8,7 @@ properties: $ref: "#/$defs/AttributeNameValue" description: | Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list. - defaultBehavior: TODO + defaultBehavior: no resource attributes are added detection/development: $ref: "#/$defs/ExperimentalResourceDetection" description: | diff --git a/schema/tracer_provider.yaml b/schema/tracer_provider.yaml index 29c3265a..be6f9d40 100644 --- a/schema/tracer_provider.yaml +++ b/schema/tracer_provider.yaml @@ -10,7 +10,7 @@ properties: limits: $ref: "#/$defs/SpanLimits" description: Configure span limits. See also attribute_limits. - defaultBehavior: TODO + defaultBehavior: default values as described in SpanLimits are used sampler: $ref: "#/$defs/Sampler" description: | @@ -79,11 +79,11 @@ $defs: always_off: $ref: "#/$defs/AlwaysOffSampler" description: Configure sampler to be always_off. - defaultBehavior: TODO + defaultBehavior: ignore always_on: $ref: "#/$defs/AlwaysOnSampler" description: Configure sampler to be always_on. - defaultBehavior: TODO + defaultBehavior: ignore composite/development: $ref: "#/$defs/ExperimentalComposableSampler" description: Configure sampler to be composite. @@ -95,7 +95,7 @@ $defs: parent_based: $ref: "#/$defs/ParentBasedSampler" description: Configure sampler to be parent_based. - defaultBehavior: TODO + defaultBehavior: ignore probability/development: $ref: "#/$defs/ExperimentalProbabilitySampler" description: Configure sampler to be probability. @@ -103,7 +103,7 @@ $defs: trace_id_ratio_based: $ref: "#/$defs/TraceIdRatioBasedSampler" description: Configure sampler to be trace_id_ratio_based. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true AlwaysOffSampler: type: @@ -296,11 +296,11 @@ $defs: otlp_http: $ref: common.yaml#/$defs/OtlpHttpExporter description: Configure exporter to be OTLP with HTTP transport. - defaultBehavior: TODO + defaultBehavior: ignore otlp_grpc: $ref: common.yaml#/$defs/OtlpGrpcExporter description: Configure exporter to be OTLP with gRPC transport. - defaultBehavior: TODO + defaultBehavior: ignore otlp_file/development: $ref: common.yaml#/$defs/ExperimentalOtlpFileExporter description: | @@ -309,11 +309,11 @@ $defs: console: $ref: common.yaml#/$defs/ConsoleExporter description: Configure exporter to be console. - defaultBehavior: TODO + defaultBehavior: ignore zipkin: $ref: "#/$defs/ZipkinSpanExporter" description: Configure exporter to be zipkin. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true SpanLimits: type: object @@ -385,11 +385,11 @@ $defs: batch: $ref: "#/$defs/BatchSpanProcessor" description: Configure a batch span processor. - defaultBehavior: TODO + defaultBehavior: ignore simple: $ref: "#/$defs/SimpleSpanProcessor" description: Configure a simple span processor. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true ZipkinSpanExporter: type: