From 14ab268e2e07f5f1229a3e76cb22d994ba35b434 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Thu, 20 Nov 2025 15:42:04 -0600 Subject: [PATCH 1/5] write script to add defaultBehavior --- package.json | 3 ++- scripts/compile-schema.js | 18 ++++++++++++++++++ scripts/migrate-schema.js | 27 +++++++++++++++++++++++++++ 3 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 scripts/migrate-schema.js diff --git a/package.json b/package.json index a6e56e8c..cc9e6a2b 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,8 @@ "scripts": { "compile-schema": "node scripts/compile-schema.js", "generate-markdown": "node scripts/generate-markdown.js", - "fix-language-implementations": "node scripts/fix-language-implementations.js" + "fix-language-implementations": "node scripts/fix-language-implementations.js", + "migrate-schema": "node scripts/migrate-schema.js" }, "devDependencies": { "ajv-cli": "5.0.0" diff --git a/scripts/compile-schema.js b/scripts/compile-schema.js index 0c732cfd..3318cef6 100644 --- a/scripts/compile-schema.js +++ b/scripts/compile-schema.js @@ -12,6 +12,7 @@ sourceTypes.forEach(sourceSchemaType => { allEnumValuesShouldHaveDescriptions(sourceSchemaType, messages); sdkExtensionPluginSchema(sourceSchemaType, messages); noSubschemas(sourceSchemaType, messages); + optionalPropertiesHaveDefaultBehavior(sourceSchemaType, messages); }); if (messages.length > 0) { messages.forEach(message => console.log(message)); @@ -145,3 +146,20 @@ function noSubschemas(sourceSchemaType, messages) { }); }); } + +function optionalPropertiesHaveDefaultBehavior(sourceSchemaType, messages) { + if (sourceSchemaType.isEnumType()) { + return; + } + const required = sourceSchemaType.schema.required || []; + sourceSchemaType.properties + .filter(property => !required.includes(property.property) && !property.schema.defaultBehavior) + .forEach(property => { + messages.push(`Please add 'defaultBehavior' to optional property ${sourceSchemaType.type}.${property.property}.`); + }); + sourceSchemaType.properties + .filter(property => required.includes(property.property) && property.schema.defaultBehavior) + .forEach(property => { + messages.push(`Please remove 'defaultBehavior' from required property ${sourceSchemaType.type}.${property.property}.`); + }); +} diff --git a/scripts/migrate-schema.js b/scripts/migrate-schema.js new file mode 100644 index 00000000..c4dea833 --- /dev/null +++ b/scripts/migrate-schema.js @@ -0,0 +1,27 @@ +import fs from 'fs'; +import {rootTypeName, schemaPath, schemaSourceDirPath} from "./util.js"; +import {readSourceTypesByType} from "./source-schema.js"; +import yaml from "yaml"; + +fs.readdirSync(schemaSourceDirPath) + .forEach(file => { + const sourceContent = yaml.parse(fs.readFileSync(schemaSourceDirPath + file, 'utf-8')); + addDefaultToOptionalProperties(sourceContent); + fs.writeFileSync(schemaSourceDirPath + file, yaml.stringify(sourceContent, {lineWidth: 0})); + }); + +function addDefaultToOptionalProperties(type) { + const properties = type.properties; + if (properties) { + const required = type.required || []; + Object.entries(properties).forEach(([key, property]) => { + if (!required.includes(key)) { + property.defaultBehavior = "TODO"; + } + }); + } + const defs = type['$defs']; + if (defs) { + Object.values(defs).forEach(addDefaultToOptionalProperties); + } +} From 5fb1c661891f944bb3dcd24fa756f9e500fa2a21 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Thu, 20 Nov 2025 15:56:23 -0600 Subject: [PATCH 2/5] Run migration script and delete --- package.json | 3 +- schema/common.yaml | 23 ++++++++ schema/instrumentation.yaml | 21 +++++++ schema/logger_provider.yaml | 19 ++++++ schema/meter_provider.yaml | 78 +++++++++++++++++++++++++ schema/opentelemetry_configuration.yaml | 11 ++++ schema/propagator.yaml | 8 +++ schema/resource.yaml | 11 ++++ schema/tracer_provider.yaml | 52 +++++++++++++++++ scripts/compile-schema.js | 76 ++++++++++++++---------- scripts/migrate-schema.js | 27 --------- 11 files changed, 268 insertions(+), 61 deletions(-) delete mode 100644 scripts/migrate-schema.js diff --git a/package.json b/package.json index cc9e6a2b..a6e56e8c 100644 --- a/package.json +++ b/package.json @@ -3,8 +3,7 @@ "scripts": { "compile-schema": "node scripts/compile-schema.js", "generate-markdown": "node scripts/generate-markdown.js", - "fix-language-implementations": "node scripts/fix-language-implementations.js", - "migrate-schema": "node scripts/migrate-schema.js" + "fix-language-implementations": "node scripts/fix-language-implementations.js" }, "devDependencies": { "ajv-cli": "5.0.0" diff --git a/schema/common.yaml b/schema/common.yaml index e7398913..d219a694 100644 --- a/schema/common.yaml +++ b/schema/common.yaml @@ -14,6 +14,7 @@ $defs: * 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. + defaultBehavior: TODO excluded: type: array minItems: 1 @@ -25,6 +26,7 @@ $defs: * 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. + defaultBehavior: TODO NameStringValuePair: type: object additionalProperties: false @@ -53,9 +55,11 @@ $defs: description: | 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. + defaultBehavior: TODO tls: $ref: "#/$defs/HttpTls" description: Configure TLS settings for the exporter. + defaultBehavior: TODO headers: type: array minItems: 1 @@ -64,6 +68,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 headers_list: type: - string @@ -72,6 +77,7 @@ $defs: 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. + defaultBehavior: TODO compression: type: - string @@ -80,6 +86,7 @@ $defs: Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used. + defaultBehavior: TODO timeout: type: - integer @@ -89,12 +96,14 @@ $defs: 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. + defaultBehavior: TODO encoding: $ref: "#/$defs/OtlpHttpEncoding" description: | Configure the encoding used for messages. Values include: protobuf, json. Implementations may not support json. If omitted or null, protobuf is used. + defaultBehavior: TODO OtlpHttpEncoding: type: - string @@ -118,9 +127,11 @@ $defs: description: | Configure endpoint. If omitted or null, http://localhost:4317 is used. + defaultBehavior: TODO tls: $ref: "#/$defs/GrpcTls" description: Configure TLS settings for the exporter. + defaultBehavior: TODO headers: type: array minItems: 1 @@ -129,6 +140,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 headers_list: type: - string @@ -137,6 +149,7 @@ $defs: 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. + defaultBehavior: TODO compression: type: - string @@ -145,6 +158,7 @@ $defs: Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used. + defaultBehavior: TODO timeout: type: - integer @@ -154,6 +168,7 @@ $defs: 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. + defaultBehavior: TODO ExperimentalOtlpFileExporter: type: - object @@ -168,6 +183,7 @@ $defs: Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used. + defaultBehavior: TODO ConsoleExporter: type: - object @@ -187,6 +203,7 @@ $defs: 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. + defaultBehavior: TODO key_file: type: - string @@ -195,6 +212,7 @@ $defs: 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. + defaultBehavior: TODO cert_file: type: - string @@ -203,6 +221,7 @@ $defs: 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. + defaultBehavior: TODO GrpcTls: type: - object @@ -217,6 +236,7 @@ $defs: 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. + defaultBehavior: TODO key_file: type: - string @@ -225,6 +245,7 @@ $defs: 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. + defaultBehavior: TODO cert_file: type: - string @@ -233,6 +254,7 @@ $defs: 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. + defaultBehavior: TODO insecure: type: - boolean @@ -241,3 +263,4 @@ $defs: 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. + defaultBehavior: TODO diff --git a/schema/instrumentation.yaml b/schema/instrumentation.yaml index f81b3628..812ad5d3 100644 --- a/schema/instrumentation.yaml +++ b/schema/instrumentation.yaml @@ -6,59 +6,71 @@ properties: description: | Configure general SemConv options that may apply to multiple languages and instrumentations. Instrumenation may merge general config options with the language specific configuration at .instrumentation.. + defaultBehavior: TODO cpp: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: Configure C++ language-specific instrumentation libraries. + defaultBehavior: TODO dotnet: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure .NET language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO erlang: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Erlang language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO go: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Go language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO java: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Java language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO js: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure JavaScript language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO php: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure PHP language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO python: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Python language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO ruby: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Ruby language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO rust: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Rust language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO swift: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Swift language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. + defaultBehavior: TODO $defs: ExperimentalGeneralInstrumentation: type: object @@ -69,11 +81,13 @@ $defs: description: | Configure instrumentations following the peer semantic conventions. See peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/ + defaultBehavior: TODO http: $ref: "#/$defs/ExperimentalHttpInstrumentation" description: | Configure instrumentations following the http semantic conventions. See http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/ + defaultBehavior: TODO ExperimentalPeerInstrumentation: type: object additionalProperties: false @@ -86,6 +100,7 @@ $defs: description: | Configure the service mapping for instrumentations following peer.service semantic conventions. See peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes + defaultBehavior: TODO ExperimentalPeerServiceMapping: type: object additionalProperties: false @@ -112,12 +127,14 @@ $defs: type: string description: | Configure headers to capture for outbound http requests. + defaultBehavior: TODO response_captured_headers: type: array items: type: string description: | Configure headers to capture for inbound http responses. + defaultBehavior: TODO ExperimentalHttpServerInstrumentation: type: object additionalProperties: false @@ -129,6 +146,7 @@ $defs: type: string description: | Configure headers to capture for inbound http requests. + defaultBehavior: TODO response_captured_headers: type: array minItems: 1 @@ -136,6 +154,7 @@ $defs: type: string description: | Configure headers to capture for outbound http responses. + defaultBehavior: TODO ExperimentalHttpInstrumentation: type: object additionalProperties: false @@ -143,9 +162,11 @@ $defs: client: $ref: "#/$defs/ExperimentalHttpClientInstrumentation" description: Configure instrumentations following the http client semantic conventions. + defaultBehavior: TODO server: $ref: "#/$defs/ExperimentalHttpServerInstrumentation" description: Configure instrumentations following the http server semantic conventions. + defaultBehavior: TODO ExperimentalLanguageSpecificInstrumentation: type: object additionalProperties: diff --git a/schema/logger_provider.yaml b/schema/logger_provider.yaml index a3d17c94..5b0bd59f 100644 --- a/schema/logger_provider.yaml +++ b/schema/logger_provider.yaml @@ -10,10 +10,12 @@ properties: limits: $ref: "#/$defs/LogRecordLimits" description: Configure log record limits. See also attribute_limits. + defaultBehavior: TODO logger_configurator/development: $ref: "#/$defs/ExperimentalLoggerConfigurator" description: | Configure loggers. + defaultBehavior: TODO required: - processors $defs: @@ -39,6 +41,7 @@ $defs: Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. If omitted or null, 1000 is used. + defaultBehavior: TODO export_timeout: type: - integer @@ -48,6 +51,7 @@ $defs: 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. + defaultBehavior: TODO max_queue_size: type: - integer @@ -56,6 +60,7 @@ $defs: description: | Configure maximum queue size. Value must be positive. If omitted or null, 2048 is used. + defaultBehavior: TODO max_export_batch_size: type: - integer @@ -64,6 +69,7 @@ $defs: description: | Configure maximum batch size. Value must be positive. If omitted or null, 512 is used. + defaultBehavior: TODO exporter: $ref: "#/$defs/LogRecordExporter" description: Configure exporter. @@ -81,16 +87,20 @@ $defs: otlp_http: $ref: common.yaml#/$defs/OtlpHttpExporter description: Configure exporter to be OTLP with HTTP transport. + defaultBehavior: TODO otlp_grpc: $ref: common.yaml#/$defs/OtlpGrpcExporter description: Configure exporter to be OTLP with gRPC transport. + defaultBehavior: TODO otlp_file/development: $ref: common.yaml#/$defs/ExperimentalOtlpFileExporter description: | Configure exporter to be OTLP with file transport. + defaultBehavior: TODO console: $ref: common.yaml#/$defs/ConsoleExporter description: Configure exporter to be console. + defaultBehavior: TODO isSdkExtensionPlugin: true LogRecordLimits: type: object @@ -105,6 +115,7 @@ $defs: 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. + defaultBehavior: TODO attribute_count_limit: type: - integer @@ -114,6 +125,7 @@ $defs: Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used. + defaultBehavior: TODO LogRecordProcessor: type: object additionalProperties: @@ -126,9 +138,11 @@ $defs: batch: $ref: "#/$defs/BatchLogRecordProcessor" description: Configure a batch log record processor. + defaultBehavior: TODO simple: $ref: "#/$defs/SimpleLogRecordProcessor" description: Configure a simple log record processor. + defaultBehavior: TODO isSdkExtensionPlugin: true ExperimentalLoggerConfigurator: type: @@ -138,12 +152,14 @@ $defs: default_config: $ref: "#/$defs/ExperimentalLoggerConfig" description: Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers. + defaultBehavior: TODO loggers: type: array minItems: 1 items: $ref: "#/$defs/ExperimentalLoggerMatcherAndConfig" description: Configure loggers. + defaultBehavior: TODO ExperimentalLoggerMatcherAndConfig: type: - object @@ -175,6 +191,7 @@ $defs: description: | Configure if the logger is enabled or not. If omitted or null, false is used. + defaultBehavior: TODO minimum_severity: $ref: "#/$defs/ExperimentalSeverityNumber" description: | @@ -182,6 +199,7 @@ $defs: Log records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed. Values include: TRACE, TRACE2, TRACE3, TRACE4, DEBUG, DEBUG2, DEBUG3, DEBUG4, INFO, INFO2, INFO3, INFO4, WARN, WARN2, WARN3, WARN4, ERROR, ERROR2, ERROR3, ERROR4, FATAL, FATAL2, FATAL3, FATAL4. If omitted or null, severity filtering is not applied. + defaultBehavior: TODO trace_based: type: - boolean @@ -190,6 +208,7 @@ $defs: 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. + defaultBehavior: TODO ExperimentalSeverityNumber: type: - string diff --git a/schema/meter_provider.yaml b/schema/meter_provider.yaml index 7a8f4834..5690f800 100644 --- a/schema/meter_provider.yaml +++ b/schema/meter_provider.yaml @@ -15,16 +15,19 @@ 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 exemplar_filter: $ref: "#/$defs/ExemplarFilter" description: | 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. If omitted or null, trace_based is used. + defaultBehavior: TODO meter_configurator/development: $ref: "#/$defs/ExperimentalMeterConfigurator" description: | Configure meters. + defaultBehavior: TODO required: - readers $defs: @@ -53,6 +56,7 @@ $defs: Configure delay interval (in milliseconds) between start of two consecutive exports. Value must be non-negative. If omitted or null, 60000 is used. + defaultBehavior: TODO timeout: type: - integer @@ -62,6 +66,7 @@ $defs: 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. + defaultBehavior: TODO exporter: $ref: "#/$defs/PushMetricExporter" description: Configure exporter. @@ -71,9 +76,11 @@ $defs: items: $ref: "#/$defs/MetricProducer" description: Configure metric producers. + defaultBehavior: TODO cardinality_limits: $ref: "#/$defs/CardinalityLimits" description: Configure cardinality limits. + defaultBehavior: TODO required: - exporter PullMetricReader: @@ -89,9 +96,11 @@ $defs: items: $ref: "#/$defs/MetricProducer" description: Configure metric producers. + defaultBehavior: TODO cardinality_limits: $ref: "#/$defs/CardinalityLimits" description: Configure cardinality limits. + defaultBehavior: TODO required: - exporter CardinalityLimits: @@ -107,6 +116,7 @@ $defs: Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority. If omitted or null, 2000 is used. + defaultBehavior: TODO counter: type: - integer @@ -115,6 +125,7 @@ $defs: description: | Configure default cardinality limit for counter instruments. If omitted or null, the value from .default is used. + defaultBehavior: TODO gauge: type: - integer @@ -123,6 +134,7 @@ $defs: description: | Configure default cardinality limit for gauge instruments. If omitted or null, the value from .default is used. + defaultBehavior: TODO histogram: type: - integer @@ -131,6 +143,7 @@ $defs: description: | Configure default cardinality limit for histogram instruments. If omitted or null, the value from .default is used. + defaultBehavior: TODO observable_counter: type: - integer @@ -139,6 +152,7 @@ $defs: description: | Configure default cardinality limit for observable_counter instruments. If omitted or null, the value from .default is used. + defaultBehavior: TODO observable_gauge: type: - integer @@ -147,6 +161,7 @@ $defs: description: | Configure default cardinality limit for observable_gauge instruments. If omitted or null, the value from .default is used. + defaultBehavior: TODO observable_up_down_counter: type: - integer @@ -155,6 +170,7 @@ $defs: description: | Configure default cardinality limit for observable_up_down_counter instruments. If omitted or null, the value from .default is used. + defaultBehavior: TODO up_down_counter: type: - integer @@ -163,6 +179,7 @@ $defs: description: | Configure default cardinality limit for up_down_counter instruments. If omitted or null, the value from .default is used. + defaultBehavior: TODO PushMetricExporter: type: object additionalProperties: @@ -176,18 +193,22 @@ $defs: $ref: "#/$defs/OtlpHttpMetricExporter" description: | Configure exporter to be OTLP with HTTP transport. + defaultBehavior: TODO otlp_grpc: $ref: "#/$defs/OtlpGrpcMetricExporter" description: | Configure exporter to be OTLP with gRPC transport. + defaultBehavior: TODO otlp_file/development: $ref: "#/$defs/ExperimentalOtlpFileMetricExporter" description: | Configure exporter to be OTLP with file transport. + defaultBehavior: TODO console: $ref: "#/$defs/ConsoleMetricExporter" description: | Configure exporter to be console. + defaultBehavior: TODO isSdkExtensionPlugin: true PullMetricExporter: type: object @@ -202,6 +223,7 @@ $defs: $ref: "#/$defs/ExperimentalPrometheusMetricExporter" description: | Configure exporter to be prometheus. + defaultBehavior: TODO isSdkExtensionPlugin: true MetricProducer: type: object @@ -215,6 +237,7 @@ $defs: opencensus: $ref: "#/$defs/OpenCensusMetricProducer" description: Configure metric producer to be opencensus. + defaultBehavior: TODO isSdkExtensionPlugin: true OpenCensusMetricProducer: type: @@ -234,6 +257,7 @@ $defs: description: | Configure host. If omitted or null, localhost is used. + defaultBehavior: TODO port: type: - integer @@ -241,6 +265,7 @@ $defs: description: | Configure port. If omitted or null, 9464 is used. + defaultBehavior: TODO without_scope_info: type: - boolean @@ -248,6 +273,7 @@ $defs: description: | Configure Prometheus Exporter to produce metrics without a scope info metric. If omitted or null, false is used. + defaultBehavior: TODO without_target_info: type: - boolean @@ -255,9 +281,11 @@ $defs: description: | Configure Prometheus Exporter to produce metrics without a target info metric for the resource. If omitted or null, false is used. + defaultBehavior: TODO with_resource_constant_labels: $ref: common.yaml#/$defs/IncludeExclude description: Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns. + defaultBehavior: TODO translation_strategy: $ref: "#/$defs/ExperimentalPrometheusTranslationStrategy" description: | @@ -269,6 +297,7 @@ $defs: * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered. If omitted or null, UnderscoreEscapingWithSuffixes is used. + defaultBehavior: TODO ExperimentalPrometheusTranslationStrategy: type: - string @@ -292,9 +321,11 @@ $defs: periodic: $ref: "#/$defs/PeriodicMetricReader" description: Configure a periodic metric reader. + defaultBehavior: TODO pull: $ref: "#/$defs/PullMetricReader" description: Configure a pull based metric reader. + defaultBehavior: TODO ExporterTemporalityPreference: type: - string @@ -330,9 +361,11 @@ $defs: description: | Configure endpoint. If omitted or null, http://localhost:4318/v1/metrics is used. + defaultBehavior: TODO tls: $ref: common.yaml#/$defs/HttpTls description: Configure TLS settings for the exporter. + defaultBehavior: TODO headers: type: array minItems: 1 @@ -341,6 +374,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 headers_list: type: - string @@ -349,6 +383,7 @@ $defs: 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. + defaultBehavior: TODO compression: type: - string @@ -357,6 +392,7 @@ $defs: Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used. + defaultBehavior: TODO timeout: type: - integer @@ -366,24 +402,28 @@ $defs: 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. + defaultBehavior: TODO encoding: $ref: common.yaml#/$defs/OtlpHttpEncoding description: | Configure the encoding used for messages. Values include: protobuf, json. Implementations may not support json. If omitted or null, protobuf is used. + defaultBehavior: TODO temporality_preference: $ref: "#/$defs/ExporterTemporalityPreference" description: | 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. If omitted or null, cumulative is used. + defaultBehavior: TODO default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. If omitted or null, explicit_bucket_histogram is used. + defaultBehavior: TODO OtlpGrpcMetricExporter: type: - object @@ -397,9 +437,11 @@ $defs: description: | Configure endpoint. If omitted or null, http://localhost:4317 is used. + defaultBehavior: TODO tls: $ref: common.yaml#/$defs/GrpcTls description: Configure TLS settings for the exporter. + defaultBehavior: TODO headers: type: array minItems: 1 @@ -408,6 +450,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 headers_list: type: - string @@ -416,6 +459,7 @@ $defs: 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. + defaultBehavior: TODO compression: type: - string @@ -424,6 +468,7 @@ $defs: Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. If omitted or null, none is used. + defaultBehavior: TODO timeout: type: - integer @@ -433,18 +478,21 @@ $defs: 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. + defaultBehavior: TODO temporality_preference: $ref: "#/$defs/ExporterTemporalityPreference" description: | 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. If omitted or null, cumulative is used. + defaultBehavior: TODO default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. If omitted or null, explicit_bucket_histogram is used. + defaultBehavior: TODO ExperimentalOtlpFileMetricExporter: type: - object @@ -459,18 +507,21 @@ $defs: Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. If omitted or null, stdout is used. + defaultBehavior: TODO temporality_preference: $ref: "#/$defs/ExporterTemporalityPreference" description: | 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. If omitted or null, cumulative is used. + defaultBehavior: TODO default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. If omitted or null, explicit_bucket_histogram is used. + defaultBehavior: TODO ConsoleMetricExporter: type: - object @@ -483,12 +534,14 @@ $defs: 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. If omitted or null, cumulative is used. + defaultBehavior: TODO default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. If omitted or null, explicit_bucket_histogram is used. + defaultBehavior: TODO View: type: object additionalProperties: false @@ -515,12 +568,14 @@ $defs: description: | Configure instrument name selection criteria. If omitted or null, all instrument names match. + defaultBehavior: TODO instrument_type: $ref: "#/$defs/InstrumentType" description: | Configure instrument type selection criteria. Values include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter. If omitted or null, all instrument types match. + defaultBehavior: TODO unit: type: - string @@ -528,6 +583,7 @@ $defs: description: | Configure the instrument unit selection criteria. If omitted or null, all instrument units match. + defaultBehavior: TODO meter_name: type: - string @@ -535,6 +591,7 @@ $defs: description: | Configure meter name selection criteria. If omitted or null, all meter names match. + defaultBehavior: TODO meter_version: type: - string @@ -542,6 +599,7 @@ $defs: description: | Configure meter version selection criteria. If omitted or null, all meter versions match. + defaultBehavior: TODO meter_schema_url: type: - string @@ -549,6 +607,7 @@ $defs: description: | Configure meter schema url selection criteria. If omitted or null, all meter schema URLs match. + defaultBehavior: TODO InstrumentType: type: - string @@ -580,6 +639,7 @@ $defs: description: | Configure metric name of the resulting stream(s). If omitted or null, the instrument's original name is used. + defaultBehavior: TODO description: type: - string @@ -587,12 +647,14 @@ $defs: description: | Configure metric description of the resulting stream(s). If omitted or null, the instrument's origin description is used. + defaultBehavior: TODO aggregation: $ref: "#/$defs/Aggregation" description: | 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. If omitted, default is used. + defaultBehavior: TODO aggregation_cardinality_limit: type: - integer @@ -601,10 +663,12 @@ $defs: description: | Configure the aggregation cardinality limit. If omitted or null, the metric reader's default cardinality limit is used. + defaultBehavior: TODO attribute_keys: $ref: common.yaml#/$defs/IncludeExclude description: | Configure attribute keys retained in the resulting stream(s). + defaultBehavior: TODO Aggregation: type: object additionalProperties: false @@ -614,21 +678,27 @@ $defs: default: $ref: "#/$defs/DefaultAggregation" description: TODO + defaultBehavior: TODO drop: $ref: "#/$defs/DropAggregation" description: TODO + defaultBehavior: TODO explicit_bucket_histogram: $ref: "#/$defs/ExplicitBucketHistogramAggregation" description: Configure aggregation to be explicit_bucket_histogram. + defaultBehavior: TODO base2_exponential_bucket_histogram: $ref: "#/$defs/Base2ExponentialBucketHistogramAggregation" description: TODO + defaultBehavior: TODO last_value: $ref: "#/$defs/LastValueAggregation" description: TODO + defaultBehavior: TODO sum: $ref: "#/$defs/SumAggregation" description: TODO + defaultBehavior: TODO DefaultAggregation: type: - object @@ -653,6 +723,7 @@ $defs: description: | Configure bucket boundaries. If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used. + defaultBehavior: TODO record_min_max: type: - boolean @@ -660,6 +731,7 @@ $defs: description: | Configure record min and max. If omitted or null, true is used. + defaultBehavior: TODO Base2ExponentialBucketHistogramAggregation: type: - object @@ -673,17 +745,20 @@ $defs: minimum: -10 maximum: 20 description: TODO + defaultBehavior: TODO max_size: type: - integer - "null" minimum: 2 description: TODO + defaultBehavior: TODO record_min_max: type: - boolean - "null" description: TODO + defaultBehavior: TODO LastValueAggregation: type: - object @@ -702,12 +777,14 @@ $defs: default_config: $ref: "#/$defs/ExperimentalMeterConfig" description: Configure the default meter config used there is no matching entry in .meter_configurator/development.meters. + defaultBehavior: TODO meters: type: array minItems: 1 items: $ref: "#/$defs/ExperimentalMeterMatcherAndConfig" description: Configure meters. + defaultBehavior: TODO ExperimentalMeterMatcherAndConfig: type: - object @@ -736,3 +813,4 @@ $defs: type: - boolean description: Configure if the meter is enabled or not. + defaultBehavior: TODO diff --git a/schema/opentelemetry_configuration.yaml b/schema/opentelemetry_configuration.yaml index d6a8d509..bdb97240 100644 --- a/schema/opentelemetry_configuration.yaml +++ b/schema/opentelemetry_configuration.yaml @@ -15,6 +15,7 @@ properties: description: | Configure if the SDK is disabled or not. If omitted or null, false is used. + defaultBehavior: TODO log_level: type: - string @@ -22,39 +23,47 @@ properties: description: | Configure the log level of the internal logger used by the SDK. If omitted, info is used. + defaultBehavior: TODO attribute_limits: $ref: "#/$defs/AttributeLimits" description: | Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits. + defaultBehavior: TODO logger_provider: $ref: "#/$defs/LoggerProvider" description: | Configure logger provider. If omitted, a noop logger provider is used. + defaultBehavior: TODO meter_provider: $ref: "#/$defs/MeterProvider" description: | Configure meter provider. If omitted, a noop meter provider is used. + defaultBehavior: TODO propagator: $ref: "#/$defs/Propagator" description: | Configure text map context propagators. If omitted, a noop propagator is used. + defaultBehavior: TODO tracer_provider: $ref: "#/$defs/TracerProvider" description: | Configure tracer provider. If omitted, a noop tracer provider is used. + defaultBehavior: TODO resource: $ref: "#/$defs/Resource" description: | Configure resource for all signals. If omitted, the default resource is used. + defaultBehavior: TODO instrumentation/development: $ref: "#/$defs/ExperimentalInstrumentation" description: | Configure instrumentation. + defaultBehavior: TODO required: - file_format $defs: @@ -71,6 +80,7 @@ $defs: Configure max attribute value size. Value must be non-negative. If omitted or null, there is no limit. + defaultBehavior: TODO attribute_count_limit: type: - integer @@ -80,6 +90,7 @@ $defs: Configure max attribute count. Value must be non-negative. If omitted or null, 128 is used. + defaultBehavior: TODO LoggerProvider: $ref: logger_provider.yaml MeterProvider: diff --git a/schema/propagator.yaml b/schema/propagator.yaml index 29544f82..3e9447f3 100644 --- a/schema/propagator.yaml +++ b/schema/propagator.yaml @@ -10,6 +10,7 @@ properties: 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 composite_list: type: - string @@ -19,6 +20,7 @@ properties: 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 $defs: TextMapPropagator: type: object @@ -32,21 +34,27 @@ $defs: tracecontext: $ref: "#/$defs/TraceContextPropagator" description: Include the w3c trace context propagator. + defaultBehavior: TODO baggage: $ref: "#/$defs/BaggagePropagator" description: Include the w3c baggage propagator. + defaultBehavior: TODO b3: $ref: "#/$defs/B3Propagator" description: Include the zipkin b3 propagator. + defaultBehavior: TODO b3multi: $ref: "#/$defs/B3MultiPropagator" description: Include the zipkin b3 multi propagator. + defaultBehavior: TODO jaeger: $ref: "#/$defs/JaegerPropagator" description: Include the jaeger propagator. + defaultBehavior: TODO ottrace: $ref: "#/$defs/OpenTracingPropagator" description: Include the opentracing propagator. + defaultBehavior: TODO isSdkExtensionPlugin: true TraceContextPropagator: type: diff --git a/schema/resource.yaml b/schema/resource.yaml index cfc8d5ed..a9c593e4 100644 --- a/schema/resource.yaml +++ b/schema/resource.yaml @@ -8,11 +8,13 @@ properties: $ref: "#/$defs/AttributeNameValue" description: | Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list. + defaultBehavior: TODO detection/development: $ref: "#/$defs/ExperimentalResourceDetection" description: | Configure resource detection. If omitted or null, resource detection is disabled. + defaultBehavior: TODO schema_url: type: - string @@ -20,6 +22,7 @@ properties: description: | Configure resource schema URL. If omitted or null, no schema URL is used. + defaultBehavior: TODO attributes_list: type: - string @@ -28,6 +31,7 @@ properties: 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. + defaultBehavior: TODO $defs: AttributeNameValue: type: object @@ -64,6 +68,7 @@ $defs: The attribute type. Values include: string, bool, int, double, string_array, bool_array, int_array, double_array. If omitted or null, string is used. + defaultBehavior: TODO required: - name - value @@ -96,6 +101,7 @@ $defs: attributes: $ref: common.yaml#/$defs/IncludeExclude description: Configure attributes provided by resource detectors. + defaultBehavior: TODO detectors: type: array minItems: 1 @@ -105,6 +111,7 @@ $defs: Configure resource detectors. Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. If omitted or null, no resource detectors are enabled. + defaultBehavior: TODO ExperimentalResourceDetector: type: object additionalProperties: @@ -118,18 +125,22 @@ $defs: $ref: "#/$defs/ExperimentalContainerResourceDetector" description: | Enable the container resource detector, which populates container.* attributes. + defaultBehavior: TODO host: $ref: "#/$defs/ExperimentalHostResourceDetector" description: | Enable the host resource detector, which populates host.* and os.* attributes. + defaultBehavior: TODO process: $ref: "#/$defs/ExperimentalProcessResourceDetector" description: | Enable the process resource detector, which populates process.* attributes. + defaultBehavior: TODO service: $ref: "#/$defs/ExperimentalServiceResourceDetector" description: | Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id. + defaultBehavior: TODO isSdkExtensionPlugin: true ExperimentalContainerResourceDetector: type: diff --git a/schema/tracer_provider.yaml b/schema/tracer_provider.yaml index 0163ac1d..8751c558 100644 --- a/schema/tracer_provider.yaml +++ b/schema/tracer_provider.yaml @@ -10,15 +10,18 @@ properties: limits: $ref: "#/$defs/SpanLimits" description: Configure span limits. See also attribute_limits. + defaultBehavior: TODO sampler: $ref: "#/$defs/Sampler" description: | Configure the sampler. If omitted, parent based sampler with a root of always_on is used. + defaultBehavior: TODO tracer_configurator/development: $ref: "#/$defs/ExperimentalTracerConfigurator" description: | Configure tracers. + defaultBehavior: TODO required: - processors $defs: @@ -35,6 +38,7 @@ $defs: Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. If omitted or null, 5000 is used. + defaultBehavior: TODO export_timeout: type: - integer @@ -44,6 +48,7 @@ $defs: 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. + defaultBehavior: TODO max_queue_size: type: - integer @@ -52,6 +57,7 @@ $defs: description: | Configure maximum queue size. Value must be positive. If omitted or null, 2048 is used. + defaultBehavior: TODO max_export_batch_size: type: - integer @@ -60,6 +66,7 @@ $defs: description: | Configure maximum batch size. Value must be positive. If omitted or null, 512 is used. + defaultBehavior: TODO exporter: $ref: "#/$defs/SpanExporter" description: Configure exporter. @@ -77,24 +84,31 @@ $defs: always_off: $ref: "#/$defs/AlwaysOffSampler" description: Configure sampler to be always_off. + defaultBehavior: TODO always_on: $ref: "#/$defs/AlwaysOnSampler" description: Configure sampler to be always_on. + defaultBehavior: TODO composite/development: $ref: "#/$defs/ExperimentalComposableSampler" description: Configure sampler to be composite. + defaultBehavior: TODO jaeger_remote/development: $ref: "#/$defs/ExperimentalJaegerRemoteSampler" description: TODO + defaultBehavior: TODO parent_based: $ref: "#/$defs/ParentBasedSampler" description: Configure sampler to be parent_based. + defaultBehavior: TODO probability/development: $ref: "#/$defs/ExperimentalProbabilitySampler" description: Configure sampler to be probability. + defaultBehavior: TODO trace_id_ratio_based: $ref: "#/$defs/TraceIdRatioBasedSampler" description: Configure sampler to be trace_id_ratio_based. + defaultBehavior: TODO isSdkExtensionPlugin: true AlwaysOffSampler: type: @@ -117,15 +131,18 @@ $defs: - string - "null" description: TODO + defaultBehavior: TODO interval: type: - integer - "null" minimum: 0 description: TODO + defaultBehavior: TODO initial_sampler: $ref: "#/$defs/Sampler" description: TODO + defaultBehavior: TODO ParentBasedSampler: type: - object @@ -137,26 +154,31 @@ $defs: description: | Configure root sampler. If omitted or null, always_on is used. + defaultBehavior: TODO remote_parent_sampled: $ref: "#/$defs/Sampler" description: | Configure remote_parent_sampled sampler. If omitted or null, always_on is used. + defaultBehavior: TODO remote_parent_not_sampled: $ref: "#/$defs/Sampler" description: | Configure remote_parent_not_sampled sampler. If omitted or null, always_off is used. + defaultBehavior: TODO local_parent_sampled: $ref: "#/$defs/Sampler" description: | Configure local_parent_sampled sampler. If omitted or null, always_on is used. + defaultBehavior: TODO local_parent_not_sampled: $ref: "#/$defs/Sampler" description: | Configure local_parent_not_sampled sampler. If omitted or null, always_off is used. + defaultBehavior: TODO ExperimentalProbabilitySampler: type: - object @@ -172,6 +194,7 @@ $defs: description: | Configure ratio. If omitted or null, 1.0 is used. + defaultBehavior: TODO TraceIdRatioBasedSampler: type: - object @@ -187,6 +210,7 @@ $defs: description: | Configure trace_id_ratio. If omitted or null, 1.0 is used. + defaultBehavior: TODO ExperimentalComposableAlwaysOffSampler: type: - object @@ -206,18 +230,23 @@ $defs: root: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with no parent. + defaultBehavior: TODO remote_parent_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a remote parent that is sampled. + defaultBehavior: TODO remote_parent_not_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a remote parent that is not sampled. + defaultBehavior: TODO local_parent_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a local parent that is sampled. + defaultBehavior: TODO local_parent_not_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a local parent that is not sampled. + defaultBehavior: TODO ExperimentalComposableProbabilitySampler: type: - object @@ -233,6 +262,7 @@ $defs: description: | Configure ratio. If omitted or null, 1.0 is used. + defaultBehavior: TODO ExperimentalComposableSampler: type: object additionalProperties: @@ -245,15 +275,19 @@ $defs: always_off: $ref: "#/$defs/ExperimentalComposableAlwaysOffSampler" description: Configure sampler to be always_off. + defaultBehavior: TODO always_on: $ref: "#/$defs/ExperimentalComposableAlwaysOnSampler" description: Configure sampler to be always_on. + defaultBehavior: TODO parent_based: $ref: "#/$defs/ExperimentalComposableParentBasedSampler" description: Configure sampler to be parent_based. + defaultBehavior: TODO probability: $ref: "#/$defs/ExperimentalComposableProbabilitySampler" description: Configure sampler to be probability. + defaultBehavior: TODO SimpleSpanProcessor: type: object additionalProperties: false @@ -275,19 +309,24 @@ $defs: otlp_http: $ref: common.yaml#/$defs/OtlpHttpExporter description: Configure exporter to be OTLP with HTTP transport. + defaultBehavior: TODO otlp_grpc: $ref: common.yaml#/$defs/OtlpGrpcExporter description: Configure exporter to be OTLP with gRPC transport. + defaultBehavior: TODO otlp_file/development: $ref: common.yaml#/$defs/ExperimentalOtlpFileExporter description: | Configure exporter to be OTLP with file transport. + defaultBehavior: TODO console: $ref: common.yaml#/$defs/ConsoleExporter description: Configure exporter to be console. + defaultBehavior: TODO zipkin: $ref: "#/$defs/ZipkinSpanExporter" description: Configure exporter to be zipkin. + defaultBehavior: TODO isSdkExtensionPlugin: true SpanLimits: type: object @@ -302,6 +341,7 @@ $defs: 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. + defaultBehavior: TODO attribute_count_limit: type: - integer @@ -311,6 +351,7 @@ $defs: Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. If omitted or null, 128 is used. + defaultBehavior: TODO event_count_limit: type: - integer @@ -320,6 +361,7 @@ $defs: Configure max span event count. Value must be non-negative. If omitted or null, 128 is used. + defaultBehavior: TODO link_count_limit: type: - integer @@ -329,6 +371,7 @@ $defs: Configure max span link count. Value must be non-negative. If omitted or null, 128 is used. + defaultBehavior: TODO event_attribute_count_limit: type: - integer @@ -338,6 +381,7 @@ $defs: Configure max attributes per span event. Value must be non-negative. If omitted or null, 128 is used. + defaultBehavior: TODO link_attribute_count_limit: type: - integer @@ -347,6 +391,7 @@ $defs: Configure max attributes per span link. Value must be non-negative. If omitted or null, 128 is used. + defaultBehavior: TODO SpanProcessor: type: object additionalProperties: @@ -359,9 +404,11 @@ $defs: batch: $ref: "#/$defs/BatchSpanProcessor" description: Configure a batch span processor. + defaultBehavior: TODO simple: $ref: "#/$defs/SimpleSpanProcessor" description: Configure a simple span processor. + defaultBehavior: TODO isSdkExtensionPlugin: true ZipkinSpanExporter: type: @@ -376,6 +423,7 @@ $defs: description: | Configure endpoint. If omitted or null, http://localhost:9411/api/v2/spans is used. + defaultBehavior: TODO timeout: type: - integer @@ -385,6 +433,7 @@ $defs: Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates indefinite. If omitted or null, 10000 is used. + defaultBehavior: TODO ExperimentalTracerConfigurator: type: - object @@ -393,12 +442,14 @@ $defs: default_config: $ref: "#/$defs/ExperimentalTracerConfig" description: Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers. + defaultBehavior: TODO tracers: type: array minItems: 1 items: $ref: "#/$defs/ExperimentalTracerMatcherAndConfig" description: Configure tracers. + defaultBehavior: TODO ExperimentalTracerMatcherAndConfig: type: - object @@ -427,3 +478,4 @@ $defs: type: - boolean description: Configure if the tracer is enabled or not. + defaultBehavior: TODO diff --git a/scripts/compile-schema.js b/scripts/compile-schema.js index 3318cef6..c2c2503c 100644 --- a/scripts/compile-schema.js +++ b/scripts/compile-schema.js @@ -27,31 +27,14 @@ sourceTypes.sort((a, b) => a.type.localeCompare(b.type)); const defs = {}; sourceTypes.filter(sourceSchemaType => sourceSchemaType.type !== rootTypeName) .forEach(sourceSchemaType => { - // Clone schema to avoid modifying original - const schema = JSON.parse(JSON.stringify(sourceSchemaType.schema)); - - // Replace cross-file refs to resolve refs from defs in local file - const properties = schema.properties; - if (properties) { - Object.values(properties).forEach(replaceCrossFileRefs); - } - - // Strip away defs from top level schemas - delete schema['$defs']; - - // Strip extra source meta data - delete schema['enumDescriptions']; - delete schema['isSdkExtensionPlugin']; - - defs[sourceSchemaType.type] = schema; + defs[sourceSchemaType.type] = prepareSchemaForOutput(sourceSchemaType.schema); }); const rootType = sourceTypes.find(sourceSchemaType => sourceSchemaType.type === rootTypeName); if (!rootType) { throw new Error(`Root type ${rootTypeName} not found in source schema.`); } -const rootTypeSchema = JSON.parse(JSON.stringify(rootType.schema)); -delete rootTypeSchema['$defs']; +const rootTypeSchema = prepareSchemaForOutput(rootType.schema); const output = { "$id": "https://opentelemetry.io/otelconfig/opentelemetry_configuration.json", @@ -64,18 +47,47 @@ fs.writeFileSync(schemaPath, JSON.stringify(output, null, 2)); // Helper functions -function replaceCrossFileRefs(propertySchema) { - const ref = propertySchema['$ref']; - if (ref) { - propertySchema['$ref'] = ref.substring(ref.indexOf('#')); +function prepareSchemaForOutput(schema) { + const copy = JSON.parse(JSON.stringify(schema)); + + delete copy['$defs']; + + stripMetadata(copy); + replaceCrossFileRefs(copy); + return copy; +} + +function stripMetadata(schema) { + delete schema['enumDescriptions']; + delete schema['isSdkExtensionPlugin']; + + const properties = schema.properties; + if (!properties) { + return; } - const items = propertySchema['items']; - if (items) { - const itemsRef = items['$ref']; - if (itemsRef) { - items['$ref'] = itemsRef.substring(itemsRef.indexOf('#')); - } + Object.values(properties).forEach(propertySchema => { + delete propertySchema['defaultBehavior']; + }); +} + +function replaceCrossFileRefs(schema) { + const properties = schema.properties; + if (!properties) { + return; } + Object.values(properties).forEach(propertySchema => { + const ref = propertySchema['$ref']; + if (ref) { + propertySchema['$ref'] = ref.substring(ref.indexOf('#')); + } + const items = propertySchema['items']; + if (items) { + const itemsRef = items['$ref']; + if (itemsRef) { + items['$ref'] = itemsRef.substring(itemsRef.indexOf('#')); + } + } + }); } // Validation functions @@ -151,14 +163,14 @@ function optionalPropertiesHaveDefaultBehavior(sourceSchemaType, messages) { if (sourceSchemaType.isEnumType()) { return; } - const required = sourceSchemaType.schema.required || []; + const required = sourceSchemaType.schema['required'] || []; sourceSchemaType.properties - .filter(property => !required.includes(property.property) && !property.schema.defaultBehavior) + .filter(property => !required.includes(property.property) && !property.schema['defaultBehavior']) .forEach(property => { messages.push(`Please add 'defaultBehavior' to optional property ${sourceSchemaType.type}.${property.property}.`); }); sourceSchemaType.properties - .filter(property => required.includes(property.property) && property.schema.defaultBehavior) + .filter(property => required.includes(property.property) && property.schema['defaultBehavior']) .forEach(property => { messages.push(`Please remove 'defaultBehavior' from required property ${sourceSchemaType.type}.${property.property}.`); }); diff --git a/scripts/migrate-schema.js b/scripts/migrate-schema.js deleted file mode 100644 index c4dea833..00000000 --- a/scripts/migrate-schema.js +++ /dev/null @@ -1,27 +0,0 @@ -import fs from 'fs'; -import {rootTypeName, schemaPath, schemaSourceDirPath} from "./util.js"; -import {readSourceTypesByType} from "./source-schema.js"; -import yaml from "yaml"; - -fs.readdirSync(schemaSourceDirPath) - .forEach(file => { - const sourceContent = yaml.parse(fs.readFileSync(schemaSourceDirPath + file, 'utf-8')); - addDefaultToOptionalProperties(sourceContent); - fs.writeFileSync(schemaSourceDirPath + file, yaml.stringify(sourceContent, {lineWidth: 0})); - }); - -function addDefaultToOptionalProperties(type) { - const properties = type.properties; - if (properties) { - const required = type.required || []; - Object.entries(properties).forEach(([key, property]) => { - if (!required.includes(key)) { - property.defaultBehavior = "TODO"; - } - }); - } - const defs = type['$defs']; - if (defs) { - Object.values(defs).forEach(addDefaultToOptionalProperties); - } -} From e007f1505ea60a732d1799e081fbdc20cf59f0b1 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Thu, 20 Nov 2025 16:06:39 -0600 Subject: [PATCH 3/5] Migrate default behavior from descriptions --- opentelemetry_configuration.json | 218 ++++++++++++------------ schema/common.yaml | 65 +++---- schema/logger_provider.yaml | 27 +-- schema/meter_provider.yaml | 138 +++++---------- schema/opentelemetry_configuration.yaml | 27 +-- schema/resource.yaml | 15 +- schema/tracer_provider.yaml | 63 +++---- scripts/compile-schema.js | 9 +- 8 files changed, 229 insertions(+), 333 deletions(-) diff --git a/opentelemetry_configuration.json b/opentelemetry_configuration.json index 3ae275ea..ef414e9b 100644 --- a/opentelemetry_configuration.json +++ b/opentelemetry_configuration.json @@ -14,14 +14,14 @@ "boolean", "null" ], - "description": "Configure if the SDK is disabled or not.\nIf omitted or null, false is used.\n" + "description": "Configure if the SDK is disabled or not.\n" }, "log_level": { "type": [ "string", "null" ], - "description": "Configure the log level of the internal logger used by the SDK.\nIf omitted, info is used.\n" + "description": "Configure the log level of the internal logger used by the SDK.\n" }, "attribute_limits": { "$ref": "#/$defs/AttributeLimits", @@ -29,23 +29,23 @@ }, "logger_provider": { "$ref": "#/$defs/LoggerProvider", - "description": "Configure logger provider.\nIf omitted, a noop logger provider is used.\n" + "description": "Configure logger provider.\n" }, "meter_provider": { "$ref": "#/$defs/MeterProvider", - "description": "Configure meter provider.\nIf omitted, a noop meter provider is used.\n" + "description": "Configure meter provider.\n" }, "propagator": { "$ref": "#/$defs/Propagator", - "description": "Configure text map context propagators.\nIf omitted, a noop propagator is used.\n" + "description": "Configure text map context propagators.\n" }, "tracer_provider": { "$ref": "#/$defs/TracerProvider", - "description": "Configure tracer provider.\nIf omitted, a noop tracer provider is used.\n" + "description": "Configure tracer provider.\n" }, "resource": { "$ref": "#/$defs/Resource", - "description": "Configure resource for all signals.\nIf omitted, the default resource is used.\n" + "description": "Configure resource for all signals.\n" }, "instrumentation/development": { "$ref": "#/$defs/ExperimentalInstrumentation", @@ -112,7 +112,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute value size. \nValue must be non-negative.\nIf omitted or null, there is no limit.\n" + "description": "Configure max attribute value size. \nValue must be non-negative.\n" }, "attribute_count_limit": { "type": [ @@ -120,7 +120,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute count. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" + "description": "Configure max attribute count. \nValue must be non-negative.\n" } } }, @@ -172,7 +172,7 @@ }, "type": { "$ref": "#/$defs/AttributeType", - "description": "The attribute type.\nValues include: string, bool, int, double, string_array, bool_array, int_array, double_array.\nIf omitted or null, string is used.\n" + "description": "The attribute type.\nValues include: string, bool, int, double, string_array, bool_array, int_array, double_array.\n" } }, "required": [ @@ -260,7 +260,7 @@ "null" ], "minimum": 0, - "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\nIf omitted or null, 1000 is used.\n" + "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\n" }, "export_timeout": { "type": [ @@ -268,7 +268,7 @@ "null" ], "minimum": 0, - "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 30000 is used.\n" + "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" }, "max_queue_size": { "type": [ @@ -276,7 +276,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum queue size. Value must be positive.\nIf omitted or null, 2048 is used.\n" + "description": "Configure maximum queue size. Value must be positive.\n" }, "max_export_batch_size": { "type": [ @@ -284,7 +284,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum batch size. Value must be positive.\nIf omitted or null, 512 is used.\n" + "description": "Configure maximum batch size. Value must be positive.\n" }, "exporter": { "$ref": "#/$defs/LogRecordExporter", @@ -305,7 +305,7 @@ "null" ], "minimum": 0, - "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\nIf omitted or null, 5000 is used.\n" + "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\n" }, "export_timeout": { "type": [ @@ -313,7 +313,7 @@ "null" ], "minimum": 0, - "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 30000 is used.\n" + "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" }, "max_queue_size": { "type": [ @@ -321,7 +321,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum queue size. Value must be positive.\nIf omitted or null, 2048 is used.\n" + "description": "Configure maximum queue size. Value must be positive.\n" }, "max_export_batch_size": { "type": [ @@ -329,7 +329,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum batch size. Value must be positive.\nIf omitted or null, 512 is used.\n" + "description": "Configure maximum batch size. Value must be positive.\n" }, "exporter": { "$ref": "#/$defs/SpanExporter", @@ -350,7 +350,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for all instrument types.\nInstrument-specific cardinality limits take priority. \nIf omitted or null, 2000 is used.\n" + "description": "Configure default cardinality limit for all instrument types.\nInstrument-specific cardinality limits take priority. \n" }, "counter": { "type": [ @@ -358,7 +358,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for counter instruments.\nIf omitted or null, the value from .default is used.\n" + "description": "Configure default cardinality limit for counter instruments.\n" }, "gauge": { "type": [ @@ -366,7 +366,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for gauge instruments.\nIf omitted or null, the value from .default is used.\n" + "description": "Configure default cardinality limit for gauge instruments.\n" }, "histogram": { "type": [ @@ -374,7 +374,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for histogram instruments.\nIf omitted or null, the value from .default is used.\n" + "description": "Configure default cardinality limit for histogram instruments.\n" }, "observable_counter": { "type": [ @@ -382,7 +382,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for observable_counter instruments.\nIf omitted or null, the value from .default is used.\n" + "description": "Configure default cardinality limit for observable_counter instruments.\n" }, "observable_gauge": { "type": [ @@ -390,7 +390,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for observable_gauge instruments.\nIf omitted or null, the value from .default is used.\n" + "description": "Configure default cardinality limit for observable_gauge instruments.\n" }, "observable_up_down_counter": { "type": [ @@ -398,7 +398,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for observable_up_down_counter instruments.\nIf omitted or null, the value from .default is used.\n" + "description": "Configure default cardinality limit for observable_up_down_counter instruments.\n" }, "up_down_counter": { "type": [ @@ -406,7 +406,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for up_down_counter instruments.\nIf omitted or null, the value from .default is used.\n" + "description": "Configure default cardinality limit for up_down_counter instruments.\n" } } }, @@ -426,11 +426,11 @@ "properties": { "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\nIf omitted or null, cumulative is used.\n" + "description": "Configure temporality preference.\nValues 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.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted or null, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues 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.\n" } } }, @@ -516,7 +516,7 @@ ], "minimum": 0, "maximum": 1, - "description": "Configure ratio.\nIf omitted or null, 1.0 is used.\n" + "description": "Configure ratio.\n" } } }, @@ -733,18 +733,18 @@ "boolean", "null" ], - "description": "Configure if the logger is enabled or not.\nIf omitted or null, false is used.\n" + "description": "Configure if the logger is enabled or not.\n" }, "minimum_severity": { "$ref": "#/$defs/ExperimentalSeverityNumber", - "description": "Configure severity filtering.\nLog records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed.\nValues include: TRACE, TRACE2, TRACE3, TRACE4, DEBUG, DEBUG2, DEBUG3, DEBUG4, INFO, INFO2, INFO3, INFO4, WARN, WARN2, WARN3, WARN4, ERROR, ERROR2, ERROR3, ERROR4, FATAL, FATAL2, FATAL3, FATAL4.\nIf omitted or null, severity filtering is not applied.\n" + "description": "Configure severity filtering.\nLog records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed.\nValues include: TRACE, TRACE2, TRACE3, TRACE4, DEBUG, DEBUG2, DEBUG3, DEBUG4, INFO, INFO2, INFO3, INFO4, WARN, WARN2, WARN3, WARN4, ERROR, ERROR2, ERROR3, ERROR4, FATAL, FATAL2, FATAL3, FATAL4.\n" }, "trace_based": { "type": [ "boolean", "null" ], - "description": "Configure trace based filtering.\nIf 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.\nIf omitted or null, trace based filtering is not applied.\n" + "description": "Configure trace based filtering.\nIf 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.\n" } } }, @@ -858,7 +858,7 @@ "string", "null" ], - "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\nIf omitted or null, stdout is used.\n" + "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\n" } } }, @@ -874,15 +874,15 @@ "string", "null" ], - "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\nIf omitted or null, stdout is used.\n" + "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\n" }, "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\nIf omitted or null, cumulative is used.\n" + "description": "Configure temporality preference.\nValues 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.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted or null, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues 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.\n" } } }, @@ -932,7 +932,7 @@ ], "minimum": 0, "maximum": 1, - "description": "Configure ratio.\nIf omitted or null, 1.0 is used.\n" + "description": "Configure ratio.\n" } } }, @@ -955,28 +955,28 @@ "string", "null" ], - "description": "Configure host.\nIf omitted or null, localhost is used.\n" + "description": "Configure host.\n" }, "port": { "type": [ "integer", "null" ], - "description": "Configure port.\nIf omitted or null, 9464 is used.\n" + "description": "Configure port.\n" }, "without_scope_info": { "type": [ "boolean", "null" ], - "description": "Configure Prometheus Exporter to produce metrics without a scope info metric.\nIf omitted or null, false is used.\n" + "description": "Configure Prometheus Exporter to produce metrics without a scope info metric.\n" }, "without_target_info": { "type": [ "boolean", "null" ], - "description": "Configure Prometheus Exporter to produce metrics without a target info metric for the resource.\nIf omitted or null, false is used.\n" + "description": "Configure Prometheus Exporter to produce metrics without a target info metric for the resource.\n" }, "with_resource_constant_labels": { "$ref": "#/$defs/IncludeExclude", @@ -984,7 +984,7 @@ }, "translation_strategy": { "$ref": "#/$defs/ExperimentalPrometheusTranslationStrategy", - "description": "Configure how Prometheus metrics are exposed. Values include:\n\n * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.\n * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.\n * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.\n * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.\n\nIf omitted or null, UnderscoreEscapingWithSuffixes is used.\n" + "description": "Configure how Prometheus metrics are exposed. Values include:\n\n * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.\n * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.\n * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.\n * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.\n" } } }, @@ -1014,7 +1014,7 @@ "items": { "$ref": "#/$defs/ExperimentalResourceDetector" }, - "description": "Configure resource detectors.\nResource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. \nIf omitted or null, no resource detectors are enabled.\n" + "description": "Configure resource detectors.\nResource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. \n" } } }, @@ -1155,14 +1155,14 @@ "items": { "type": "number" }, - "description": "Configure bucket boundaries.\nIf omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used.\n" + "description": "Configure bucket boundaries.\n" }, "record_min_max": { "type": [ "boolean", "null" ], - "description": "Configure record min and max.\nIf omitted or null, true is used.\n" + "description": "Configure record min and max.\n" } } }, @@ -1199,28 +1199,28 @@ "string", "null" ], - "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\nIf omitted or null, system default certificate verification is used for secure connections.\n" + "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\n" }, "key_file": { "type": [ "string", "null" ], - "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\nIf omitted or null, mTLS is not used.\n" + "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\n" }, "cert_file": { "type": [ "string", "null" ], - "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\nIf omitted or null, mTLS is not used.\n" + "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\n" }, "insecure": { "type": [ "boolean", "null" ], - "description": "Configure client transport security for the exporter's connection. \nOnly applicable when .endpoint is provided without http or https scheme. Implementations may choose to ignore .insecure.\nIf omitted or null, false is used.\n" + "description": "Configure client transport security for the exporter's connection. \nOnly applicable when .endpoint is provided without http or https scheme. Implementations may choose to ignore .insecure.\n" } } }, @@ -1236,21 +1236,21 @@ "string", "null" ], - "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\nIf omitted or null, system default certificate verification is used for secure connections.\n" + "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\n" }, "key_file": { "type": [ "string", "null" ], - "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\nIf omitted or null, mTLS is not used.\n" + "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\n" }, "cert_file": { "type": [ "string", "null" ], - "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\nIf omitted or null, mTLS is not used.\n" + "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\n" } } }, @@ -1264,7 +1264,7 @@ "items": { "type": "string" }, - "description": "Configure list of value patterns to include.\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\nIf omitted, all values are included.\n" + "description": "Configure list of value patterns to include.\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\n" }, "excluded": { "type": "array", @@ -1272,7 +1272,7 @@ "items": { "type": "string" }, - "description": "Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included).\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\nIf omitted, .included attributes are included.\n" + "description": "Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included).\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\n" } } }, @@ -1369,7 +1369,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\nIf omitted or null, there is no limit.\n" + "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\n" }, "attribute_count_limit": { "type": [ @@ -1377,7 +1377,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" + "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\n" } } }, @@ -1424,7 +1424,7 @@ }, "exemplar_filter": { "$ref": "#/$defs/ExemplarFilter", - "description": "Configure the exemplar filter. \nValues 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.\nIf omitted or null, trace_based is used.\n" + "description": "Configure the exemplar filter. \nValues 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.\n" }, "meter_configurator/development": { "$ref": "#/$defs/ExperimentalMeterConfigurator", @@ -1515,7 +1515,7 @@ "string", "null" ], - "description": "Configure endpoint.\nIf omitted or null, http://localhost:4317 is used.\n" + "description": "Configure endpoint.\n" }, "tls": { "$ref": "#/$defs/GrpcTls", @@ -1534,14 +1534,14 @@ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" }, "timeout": { "type": [ @@ -1549,7 +1549,7 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" } } }, @@ -1565,7 +1565,7 @@ "string", "null" ], - "description": "Configure endpoint.\nIf omitted or null, http://localhost:4317 is used.\n" + "description": "Configure endpoint.\n" }, "tls": { "$ref": "#/$defs/GrpcTls", @@ -1584,14 +1584,14 @@ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" }, "timeout": { "type": [ @@ -1599,15 +1599,15 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" }, "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\nIf omitted or null, cumulative is used.\n" + "description": "Configure temporality preference.\nValues 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.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted or null, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues 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.\n" } } }, @@ -1633,7 +1633,7 @@ "string", "null" ], - "description": "Configure endpoint, including the signal specific path.\nIf omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.\n" + "description": "Configure endpoint, including the signal specific path.\n" }, "tls": { "$ref": "#/$defs/HttpTls", @@ -1652,14 +1652,14 @@ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" }, "timeout": { "type": [ @@ -1667,11 +1667,11 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" }, "encoding": { "$ref": "#/$defs/OtlpHttpEncoding", - "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\nIf omitted or null, protobuf is used.\n" + "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\n" } } }, @@ -1687,7 +1687,7 @@ "string", "null" ], - "description": "Configure endpoint.\nIf omitted or null, http://localhost:4318/v1/metrics is used.\n" + "description": "Configure endpoint.\n" }, "tls": { "$ref": "#/$defs/HttpTls", @@ -1706,14 +1706,14 @@ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" }, "timeout": { "type": [ @@ -1721,19 +1721,19 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" }, "encoding": { "$ref": "#/$defs/OtlpHttpEncoding", - "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\nIf omitted or null, protobuf is used.\n" + "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\n" }, "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\nIf omitted or null, cumulative is used.\n" + "description": "Configure temporality preference.\nValues 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.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted or null, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues 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.\n" } } }, @@ -1746,23 +1746,23 @@ "properties": { "root": { "$ref": "#/$defs/Sampler", - "description": "Configure root sampler.\nIf omitted or null, always_on is used.\n" + "description": "Configure root sampler.\n" }, "remote_parent_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure remote_parent_sampled sampler.\nIf omitted or null, always_on is used.\n" + "description": "Configure remote_parent_sampled sampler.\n" }, "remote_parent_not_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure remote_parent_not_sampled sampler.\nIf omitted or null, always_off is used.\n" + "description": "Configure remote_parent_not_sampled sampler.\n" }, "local_parent_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure local_parent_sampled sampler.\nIf omitted or null, always_on is used.\n" + "description": "Configure local_parent_sampled sampler.\n" }, "local_parent_not_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure local_parent_not_sampled sampler.\nIf omitted or null, always_off is used.\n" + "description": "Configure local_parent_not_sampled sampler.\n" } } }, @@ -1776,7 +1776,7 @@ "null" ], "minimum": 0, - "description": "Configure delay interval (in milliseconds) between start of two consecutive exports. \nValue must be non-negative.\nIf omitted or null, 60000 is used.\n" + "description": "Configure delay interval (in milliseconds) between start of two consecutive exports. \nValue must be non-negative.\n" }, "timeout": { "type": [ @@ -1784,7 +1784,7 @@ "null" ], "minimum": 0, - "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 30000 is used.\n" + "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" }, "exporter": { "$ref": "#/$defs/PushMetricExporter", @@ -1913,21 +1913,21 @@ }, "detection/development": { "$ref": "#/$defs/ExperimentalResourceDetection", - "description": "Configure resource detection.\nIf omitted or null, resource detection is disabled.\n" + "description": "Configure resource detection.\n" }, "schema_url": { "type": [ "string", "null" ], - "description": "Configure resource schema URL.\nIf omitted or null, no schema URL is used.\n" + "description": "Configure resource schema URL.\n" }, "attributes_list": { "type": [ "string", "null" ], - "description": "Configure resource attributes. Entries have lower priority than entries from .resource.attributes.\nThe 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.\nIf omitted or null, no resource attributes are added.\n" + "description": "Configure resource attributes. Entries have lower priority than entries from .resource.attributes.\nThe 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.\n" } } }, @@ -2041,7 +2041,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\nIf omitted or null, there is no limit.\n" + "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\n" }, "attribute_count_limit": { "type": [ @@ -2049,7 +2049,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" + "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\n" }, "event_count_limit": { "type": [ @@ -2057,7 +2057,7 @@ "null" ], "minimum": 0, - "description": "Configure max span event count. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" + "description": "Configure max span event count. \nValue must be non-negative.\n" }, "link_count_limit": { "type": [ @@ -2065,7 +2065,7 @@ "null" ], "minimum": 0, - "description": "Configure max span link count. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" + "description": "Configure max span link count. \nValue must be non-negative.\n" }, "event_attribute_count_limit": { "type": [ @@ -2073,7 +2073,7 @@ "null" ], "minimum": 0, - "description": "Configure max attributes per span event. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" + "description": "Configure max attributes per span event. \nValue must be non-negative.\n" }, "link_attribute_count_limit": { "type": [ @@ -2081,7 +2081,7 @@ "null" ], "minimum": 0, - "description": "Configure max attributes per span link. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" + "description": "Configure max attributes per span link. \nValue must be non-negative.\n" } } }, @@ -2171,7 +2171,7 @@ ], "minimum": 0, "maximum": 1, - "description": "Configure trace_id_ratio.\nIf omitted or null, 1.0 is used.\n" + "description": "Configure trace_id_ratio.\n" } } }, @@ -2193,7 +2193,7 @@ }, "sampler": { "$ref": "#/$defs/Sampler", - "description": "Configure the sampler.\nIf omitted, parent based sampler with a root of always_on is used.\n" + "description": "Configure the sampler.\n" }, "tracer_configurator/development": { "$ref": "#/$defs/ExperimentalTracerConfigurator", @@ -2231,39 +2231,39 @@ "string", "null" ], - "description": "Configure instrument name selection criteria.\nIf omitted or null, all instrument names match.\n" + "description": "Configure instrument name selection criteria.\n" }, "instrument_type": { "$ref": "#/$defs/InstrumentType", - "description": "Configure instrument type selection criteria.\nValues include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter.\nIf omitted or null, all instrument types match.\n" + "description": "Configure instrument type selection criteria.\nValues include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter.\n" }, "unit": { "type": [ "string", "null" ], - "description": "Configure the instrument unit selection criteria.\nIf omitted or null, all instrument units match.\n" + "description": "Configure the instrument unit selection criteria.\n" }, "meter_name": { "type": [ "string", "null" ], - "description": "Configure meter name selection criteria.\nIf omitted or null, all meter names match.\n" + "description": "Configure meter name selection criteria.\n" }, "meter_version": { "type": [ "string", "null" ], - "description": "Configure meter version selection criteria.\nIf omitted or null, all meter versions match.\n" + "description": "Configure meter version selection criteria.\n" }, "meter_schema_url": { "type": [ "string", "null" ], - "description": "Configure meter schema url selection criteria.\nIf omitted or null, all meter schema URLs match.\n" + "description": "Configure meter schema url selection criteria.\n" } } }, @@ -2276,18 +2276,18 @@ "string", "null" ], - "description": "Configure metric name of the resulting stream(s).\nIf omitted or null, the instrument's original name is used.\n" + "description": "Configure metric name of the resulting stream(s).\n" }, "description": { "type": [ "string", "null" ], - "description": "Configure metric description of the resulting stream(s).\nIf omitted or null, the instrument's origin description is used.\n" + "description": "Configure metric description of the resulting stream(s).\n" }, "aggregation": { "$ref": "#/$defs/Aggregation", - "description": "Configure aggregation of the resulting stream(s). \nValues 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.\nIf omitted, default is used.\n" + "description": "Configure aggregation of the resulting stream(s). \nValues 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.\n" }, "aggregation_cardinality_limit": { "type": [ @@ -2295,7 +2295,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure the aggregation cardinality limit.\nIf omitted or null, the metric reader's default cardinality limit is used.\n" + "description": "Configure the aggregation cardinality limit.\n" }, "attribute_keys": { "$ref": "#/$defs/IncludeExclude", @@ -2315,7 +2315,7 @@ "string", "null" ], - "description": "Configure endpoint.\nIf omitted or null, http://localhost:9411/api/v2/spans is used.\n" + "description": "Configure endpoint.\n" }, "timeout": { "type": [ @@ -2323,7 +2323,7 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export. \nValue must be non-negative. A value of 0 indicates indefinite.\nIf omitted or null, 10000 is used.\n" + "description": "Configure max time (in milliseconds) to wait for each export. \nValue must be non-negative. A value of 0 indicates indefinite.\n" } } } diff --git a/schema/common.yaml b/schema/common.yaml index d219a694..e55f3c72 100644 --- a/schema/common.yaml +++ b/schema/common.yaml @@ -13,8 +13,7 @@ $defs: 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. - defaultBehavior: TODO + defaultBehavior: all values are included excluded: type: array minItems: 1 @@ -25,8 +24,7 @@ $defs: 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. - defaultBehavior: TODO + defaultBehavior: .included attributes are included NameStringValuePair: type: object additionalProperties: false @@ -54,12 +52,11 @@ $defs: - "null" description: | 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. - defaultBehavior: TODO + defaultBehavior: the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used tls: $ref: "#/$defs/HttpTls" description: Configure TLS settings for the exporter. - defaultBehavior: TODO + defaultBehavior: system default TLS settings are used headers: type: array minItems: 1 @@ -68,7 +65,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 @@ -76,8 +73,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: no headers are added compression: type: - string @@ -85,8 +81,7 @@ $defs: description: | Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. - If omitted or null, none is used. - defaultBehavior: TODO + defaultBehavior: none is used timeout: type: - integer @@ -95,15 +90,13 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: 10000 is used encoding: $ref: "#/$defs/OtlpHttpEncoding" description: | Configure the encoding used for messages. Values include: protobuf, json. Implementations may not support json. - If omitted or null, protobuf is used. - defaultBehavior: TODO + defaultBehavior: protobuf is used OtlpHttpEncoding: type: - string @@ -126,12 +119,11 @@ $defs: - "null" description: | Configure endpoint. - If omitted or null, http://localhost:4317 is used. - defaultBehavior: TODO + defaultBehavior: http://localhost:4317 is used tls: $ref: "#/$defs/GrpcTls" description: Configure TLS settings for the exporter. - defaultBehavior: TODO + defaultBehavior: system default TLS settings are used headers: type: array minItems: 1 @@ -140,7 +132,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 @@ -148,8 +140,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: no headers are added compression: type: - string @@ -157,8 +148,7 @@ $defs: description: | Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. - If omitted or null, none is used. - defaultBehavior: TODO + defaultBehavior: none is used timeout: type: - integer @@ -167,8 +157,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: 10000 is used ExperimentalOtlpFileExporter: type: - object @@ -182,8 +171,7 @@ $defs: description: | Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. - If omitted or null, stdout is used. - defaultBehavior: TODO + defaultBehavior: stdout is used ConsoleExporter: type: - object @@ -202,8 +190,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: system default certificate verification is used for secure connections key_file: type: - string @@ -211,8 +198,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: mTLS is not used cert_file: type: - string @@ -220,8 +206,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: mTLS is not used GrpcTls: type: - object @@ -235,8 +220,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: system default certificate verification is used for secure connections key_file: type: - string @@ -244,8 +228,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: mTLS is not used cert_file: type: - string @@ -253,8 +236,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: mTLS is not used insecure: type: - boolean @@ -262,5 +244,4 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: false is used diff --git a/schema/logger_provider.yaml b/schema/logger_provider.yaml index 5b0bd59f..8123b2e0 100644 --- a/schema/logger_provider.yaml +++ b/schema/logger_provider.yaml @@ -40,8 +40,7 @@ $defs: description: | Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. - If omitted or null, 1000 is used. - defaultBehavior: TODO + defaultBehavior: 1000 is used export_timeout: type: - integer @@ -50,8 +49,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: 30000 is used max_queue_size: type: - integer @@ -59,8 +57,7 @@ $defs: exclusiveMinimum: 0 description: | Configure maximum queue size. Value must be positive. - If omitted or null, 2048 is used. - defaultBehavior: TODO + defaultBehavior: 2048 is used max_export_batch_size: type: - integer @@ -68,8 +65,7 @@ $defs: exclusiveMinimum: 0 description: | Configure maximum batch size. Value must be positive. - If omitted or null, 512 is used. - defaultBehavior: TODO + defaultBehavior: 512 is used exporter: $ref: "#/$defs/LogRecordExporter" description: Configure exporter. @@ -114,8 +110,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: there is no limit attribute_count_limit: type: - integer @@ -124,8 +119,7 @@ $defs: description: | Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. - If omitted or null, 128 is used. - defaultBehavior: TODO + defaultBehavior: 128 is used LogRecordProcessor: type: object additionalProperties: @@ -190,16 +184,14 @@ $defs: - "null" description: | Configure if the logger is enabled or not. - If omitted or null, false is used. - defaultBehavior: TODO + defaultBehavior: false is used minimum_severity: $ref: "#/$defs/ExperimentalSeverityNumber" description: | Configure severity filtering. Log records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed. Values include: TRACE, TRACE2, TRACE3, TRACE4, DEBUG, DEBUG2, DEBUG3, DEBUG4, INFO, INFO2, INFO3, INFO4, WARN, WARN2, WARN3, WARN4, ERROR, ERROR2, ERROR3, ERROR4, FATAL, FATAL2, FATAL3, FATAL4. - If omitted or null, severity filtering is not applied. - defaultBehavior: TODO + defaultBehavior: severity filtering is not applied trace_based: type: - boolean @@ -207,8 +199,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: trace based filtering is not applied ExperimentalSeverityNumber: type: - string diff --git a/schema/meter_provider.yaml b/schema/meter_provider.yaml index 5690f800..b56f4f99 100644 --- a/schema/meter_provider.yaml +++ b/schema/meter_provider.yaml @@ -21,8 +21,7 @@ properties: description: | 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. - If omitted or null, trace_based is used. - defaultBehavior: TODO + defaultBehavior: trace_based is used meter_configurator/development: $ref: "#/$defs/ExperimentalMeterConfigurator" description: | @@ -55,8 +54,7 @@ $defs: description: | Configure delay interval (in milliseconds) between start of two consecutive exports. Value must be non-negative. - If omitted or null, 60000 is used. - defaultBehavior: TODO + defaultBehavior: 60000 is used timeout: type: - integer @@ -65,8 +63,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: 30000 is used exporter: $ref: "#/$defs/PushMetricExporter" description: Configure exporter. @@ -115,8 +112,7 @@ $defs: description: | Configure default cardinality limit for all instrument types. Instrument-specific cardinality limits take priority. - If omitted or null, 2000 is used. - defaultBehavior: TODO + defaultBehavior: 2000 is used counter: type: - integer @@ -124,8 +120,7 @@ $defs: exclusiveMinimum: 0 description: | Configure default cardinality limit for counter instruments. - If omitted or null, the value from .default is used. - defaultBehavior: TODO + defaultBehavior: the value from .default is used gauge: type: - integer @@ -133,8 +128,7 @@ $defs: exclusiveMinimum: 0 description: | Configure default cardinality limit for gauge instruments. - If omitted or null, the value from .default is used. - defaultBehavior: TODO + defaultBehavior: the value from .default is used histogram: type: - integer @@ -142,8 +136,7 @@ $defs: exclusiveMinimum: 0 description: | Configure default cardinality limit for histogram instruments. - If omitted or null, the value from .default is used. - defaultBehavior: TODO + defaultBehavior: the value from .default is used observable_counter: type: - integer @@ -151,8 +144,7 @@ $defs: exclusiveMinimum: 0 description: | Configure default cardinality limit for observable_counter instruments. - If omitted or null, the value from .default is used. - defaultBehavior: TODO + defaultBehavior: the value from .default is used observable_gauge: type: - integer @@ -160,8 +152,7 @@ $defs: exclusiveMinimum: 0 description: | Configure default cardinality limit for observable_gauge instruments. - If omitted or null, the value from .default is used. - defaultBehavior: TODO + defaultBehavior: the value from .default is used observable_up_down_counter: type: - integer @@ -169,8 +160,7 @@ $defs: exclusiveMinimum: 0 description: | Configure default cardinality limit for observable_up_down_counter instruments. - If omitted or null, the value from .default is used. - defaultBehavior: TODO + defaultBehavior: the value from .default is used up_down_counter: type: - integer @@ -178,8 +168,7 @@ $defs: exclusiveMinimum: 0 description: | Configure default cardinality limit for up_down_counter instruments. - If omitted or null, the value from .default is used. - defaultBehavior: TODO + defaultBehavior: the value from .default is used PushMetricExporter: type: object additionalProperties: @@ -256,32 +245,28 @@ $defs: - "null" description: | Configure host. - If omitted or null, localhost is used. - defaultBehavior: TODO + defaultBehavior: localhost is used port: type: - integer - "null" description: | Configure port. - If omitted or null, 9464 is used. - defaultBehavior: TODO + defaultBehavior: 9464 is used without_scope_info: type: - boolean - "null" description: | Configure Prometheus Exporter to produce metrics without a scope info metric. - If omitted or null, false is used. - defaultBehavior: TODO + defaultBehavior: false is used without_target_info: type: - boolean - "null" description: | Configure Prometheus Exporter to produce metrics without a target info metric for the resource. - If omitted or null, false is used. - defaultBehavior: TODO + defaultBehavior: false is used with_resource_constant_labels: $ref: common.yaml#/$defs/IncludeExclude description: Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns. @@ -296,8 +281,7 @@ $defs: * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached. * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered. - If omitted or null, UnderscoreEscapingWithSuffixes is used. - defaultBehavior: TODO + defaultBehavior: UnderscoreEscapingWithSuffixes is used ExperimentalPrometheusTranslationStrategy: type: - string @@ -360,8 +344,7 @@ $defs: - "null" description: | Configure endpoint. - If omitted or null, http://localhost:4318/v1/metrics is used. - defaultBehavior: TODO + defaultBehavior: http://localhost:4318/v1/metrics is used tls: $ref: common.yaml#/$defs/HttpTls description: Configure TLS settings for the exporter. @@ -382,8 +365,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: no headers are added compression: type: - string @@ -391,8 +373,7 @@ $defs: description: | Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. - If omitted or null, none is used. - defaultBehavior: TODO + defaultBehavior: none is used timeout: type: - integer @@ -401,29 +382,25 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: 10000 is used encoding: $ref: common.yaml#/$defs/OtlpHttpEncoding description: | Configure the encoding used for messages. Values include: protobuf, json. Implementations may not support json. - If omitted or null, protobuf is used. - defaultBehavior: TODO + defaultBehavior: protobuf is used temporality_preference: $ref: "#/$defs/ExporterTemporalityPreference" description: | 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. - If omitted or null, cumulative is used. - defaultBehavior: TODO + defaultBehavior: cumulative is used default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. - If omitted or null, explicit_bucket_histogram is used. - defaultBehavior: TODO + defaultBehavior: explicit_bucket_histogram is used OtlpGrpcMetricExporter: type: - object @@ -436,8 +413,7 @@ $defs: - "null" description: | Configure endpoint. - If omitted or null, http://localhost:4317 is used. - defaultBehavior: TODO + defaultBehavior: http://localhost:4317 is used tls: $ref: common.yaml#/$defs/GrpcTls description: Configure TLS settings for the exporter. @@ -458,8 +434,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: no headers are added compression: type: - string @@ -467,8 +442,7 @@ $defs: description: | Configure compression. Values include: gzip, none. Implementations may support other compression algorithms. - If omitted or null, none is used. - defaultBehavior: TODO + defaultBehavior: none is used timeout: type: - integer @@ -477,22 +451,19 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: 10000 is used temporality_preference: $ref: "#/$defs/ExporterTemporalityPreference" description: | 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. - If omitted or null, cumulative is used. - defaultBehavior: TODO + defaultBehavior: cumulative is used default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. - If omitted or null, explicit_bucket_histogram is used. - defaultBehavior: TODO + defaultBehavior: explicit_bucket_histogram is used ExperimentalOtlpFileMetricExporter: type: - object @@ -506,22 +477,19 @@ $defs: description: | Configure output stream. Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl. - If omitted or null, stdout is used. - defaultBehavior: TODO + defaultBehavior: stdout is used temporality_preference: $ref: "#/$defs/ExporterTemporalityPreference" description: | 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. - If omitted or null, cumulative is used. - defaultBehavior: TODO + defaultBehavior: cumulative is used default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. - If omitted or null, explicit_bucket_histogram is used. - defaultBehavior: TODO + defaultBehavior: explicit_bucket_histogram is used ConsoleMetricExporter: type: - object @@ -533,15 +501,13 @@ $defs: description: | 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. - If omitted or null, cumulative is used. - defaultBehavior: TODO + defaultBehavior: cumulative is used default_histogram_aggregation: $ref: "#/$defs/ExporterDefaultHistogramAggregation" description: | 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. - If omitted or null, explicit_bucket_histogram is used. - defaultBehavior: TODO + defaultBehavior: explicit_bucket_histogram is used View: type: object additionalProperties: false @@ -567,47 +533,41 @@ $defs: - "null" description: | Configure instrument name selection criteria. - If omitted or null, all instrument names match. - defaultBehavior: TODO + defaultBehavior: all instrument names match instrument_type: $ref: "#/$defs/InstrumentType" description: | Configure instrument type selection criteria. Values include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter. - If omitted or null, all instrument types match. - defaultBehavior: TODO + defaultBehavior: all instrument types match unit: type: - string - "null" description: | Configure the instrument unit selection criteria. - If omitted or null, all instrument units match. - defaultBehavior: TODO + defaultBehavior: all instrument units match meter_name: type: - string - "null" description: | Configure meter name selection criteria. - If omitted or null, all meter names match. - defaultBehavior: TODO + defaultBehavior: all meter names match meter_version: type: - string - "null" description: | Configure meter version selection criteria. - If omitted or null, all meter versions match. - defaultBehavior: TODO + defaultBehavior: all meter versions match meter_schema_url: type: - string - "null" description: | Configure meter schema url selection criteria. - If omitted or null, all meter schema URLs match. - defaultBehavior: TODO + defaultBehavior: all meter schema URLs match InstrumentType: type: - string @@ -638,23 +598,20 @@ $defs: - "null" description: | Configure metric name of the resulting stream(s). - If omitted or null, the instrument's original name is used. - defaultBehavior: TODO + defaultBehavior: the instrument's original name is used description: type: - string - "null" description: | Configure metric description of the resulting stream(s). - If omitted or null, the instrument's origin description is used. - defaultBehavior: TODO + defaultBehavior: the instrument's origin description is used aggregation: $ref: "#/$defs/Aggregation" description: | 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. - If omitted, default is used. - defaultBehavior: TODO + defaultBehavior: default is used aggregation_cardinality_limit: type: - integer @@ -662,8 +619,7 @@ $defs: exclusiveMinimum: 0 description: | Configure the aggregation cardinality limit. - If omitted or null, the metric reader's default cardinality limit is used. - defaultBehavior: TODO + defaultBehavior: the metric reader's default cardinality limit is used attribute_keys: $ref: common.yaml#/$defs/IncludeExclude description: | @@ -722,16 +678,14 @@ $defs: type: number description: | Configure bucket boundaries. - If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used. - defaultBehavior: TODO + defaultBehavior: "[0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used" record_min_max: type: - boolean - "null" description: | Configure record min and max. - If omitted or null, true is used. - defaultBehavior: TODO + defaultBehavior: true is used Base2ExponentialBucketHistogramAggregation: type: - object diff --git a/schema/opentelemetry_configuration.yaml b/schema/opentelemetry_configuration.yaml index bdb97240..290e88c6 100644 --- a/schema/opentelemetry_configuration.yaml +++ b/schema/opentelemetry_configuration.yaml @@ -14,16 +14,14 @@ properties: - "null" description: | Configure if the SDK is disabled or not. - If omitted or null, false is used. - defaultBehavior: TODO + defaultBehavior: false is used log_level: type: - string - "null" description: | Configure the log level of the internal logger used by the SDK. - If omitted, info is used. - defaultBehavior: TODO + defaultBehavior: info is used attribute_limits: $ref: "#/$defs/AttributeLimits" description: | @@ -33,32 +31,27 @@ properties: $ref: "#/$defs/LoggerProvider" description: | Configure logger provider. - If omitted, a noop logger provider is used. - defaultBehavior: TODO + defaultBehavior: a noop logger provider is used meter_provider: $ref: "#/$defs/MeterProvider" description: | Configure meter provider. - If omitted, a noop meter provider is used. - defaultBehavior: TODO + defaultBehavior: a noop meter provider is used propagator: $ref: "#/$defs/Propagator" description: | Configure text map context propagators. - If omitted, a noop propagator is used. - defaultBehavior: TODO + defaultBehavior: a noop propagator is used tracer_provider: $ref: "#/$defs/TracerProvider" description: | Configure tracer provider. - If omitted, a noop tracer provider is used. - defaultBehavior: TODO + defaultBehavior: a noop tracer provider is used resource: $ref: "#/$defs/Resource" description: | Configure resource for all signals. - If omitted, the default resource is used. - defaultBehavior: TODO + defaultBehavior: the default resource is used instrumentation/development: $ref: "#/$defs/ExperimentalInstrumentation" description: | @@ -79,8 +72,7 @@ $defs: description: | Configure max attribute value size. Value must be non-negative. - If omitted or null, there is no limit. - defaultBehavior: TODO + defaultBehavior: there is no limit attribute_count_limit: type: - integer @@ -89,8 +81,7 @@ $defs: description: | Configure max attribute count. Value must be non-negative. - If omitted or null, 128 is used. - defaultBehavior: TODO + defaultBehavior: 128 is used LoggerProvider: $ref: logger_provider.yaml MeterProvider: diff --git a/schema/resource.yaml b/schema/resource.yaml index a9c593e4..7216256f 100644 --- a/schema/resource.yaml +++ b/schema/resource.yaml @@ -13,16 +13,14 @@ properties: $ref: "#/$defs/ExperimentalResourceDetection" description: | Configure resource detection. - If omitted or null, resource detection is disabled. - defaultBehavior: TODO + defaultBehavior: resource detection is disabled schema_url: type: - string - "null" description: | Configure resource schema URL. - If omitted or null, no schema URL is used. - defaultBehavior: TODO + defaultBehavior: no schema URL is used attributes_list: type: - string @@ -30,8 +28,7 @@ properties: description: | 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. - defaultBehavior: TODO + defaultBehavior: no resource attributes are added $defs: AttributeNameValue: type: object @@ -67,8 +64,7 @@ $defs: description: | The attribute type. Values include: string, bool, int, double, string_array, bool_array, int_array, double_array. - If omitted or null, string is used. - defaultBehavior: TODO + defaultBehavior: string is used required: - name - value @@ -110,8 +106,7 @@ $defs: description: | Configure resource detectors. Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. - If omitted or null, no resource detectors are enabled. - defaultBehavior: TODO + defaultBehavior: no resource detectors are enabled ExperimentalResourceDetector: type: object additionalProperties: diff --git a/schema/tracer_provider.yaml b/schema/tracer_provider.yaml index 8751c558..042bd06a 100644 --- a/schema/tracer_provider.yaml +++ b/schema/tracer_provider.yaml @@ -15,8 +15,7 @@ properties: $ref: "#/$defs/Sampler" description: | Configure the sampler. - If omitted, parent based sampler with a root of always_on is used. - defaultBehavior: TODO + defaultBehavior: parent based sampler with a root of always_on is used tracer_configurator/development: $ref: "#/$defs/ExperimentalTracerConfigurator" description: | @@ -37,8 +36,7 @@ $defs: description: | Configure delay interval (in milliseconds) between two consecutive exports. Value must be non-negative. - If omitted or null, 5000 is used. - defaultBehavior: TODO + defaultBehavior: 5000 is used export_timeout: type: - integer @@ -47,8 +45,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: 30000 is used max_queue_size: type: - integer @@ -56,8 +53,7 @@ $defs: exclusiveMinimum: 0 description: | Configure maximum queue size. Value must be positive. - If omitted or null, 2048 is used. - defaultBehavior: TODO + defaultBehavior: 2048 is used max_export_batch_size: type: - integer @@ -65,8 +61,7 @@ $defs: exclusiveMinimum: 0 description: | Configure maximum batch size. Value must be positive. - If omitted or null, 512 is used. - defaultBehavior: TODO + defaultBehavior: 512 is used exporter: $ref: "#/$defs/SpanExporter" description: Configure exporter. @@ -153,32 +148,27 @@ $defs: $ref: "#/$defs/Sampler" description: | Configure root sampler. - If omitted or null, always_on is used. - defaultBehavior: TODO + defaultBehavior: always_on is used remote_parent_sampled: $ref: "#/$defs/Sampler" description: | Configure remote_parent_sampled sampler. - If omitted or null, always_on is used. - defaultBehavior: TODO + defaultBehavior: always_on is used remote_parent_not_sampled: $ref: "#/$defs/Sampler" description: | Configure remote_parent_not_sampled sampler. - If omitted or null, always_off is used. - defaultBehavior: TODO + defaultBehavior: always_off is used local_parent_sampled: $ref: "#/$defs/Sampler" description: | Configure local_parent_sampled sampler. - If omitted or null, always_on is used. - defaultBehavior: TODO + defaultBehavior: always_on is used local_parent_not_sampled: $ref: "#/$defs/Sampler" description: | Configure local_parent_not_sampled sampler. - If omitted or null, always_off is used. - defaultBehavior: TODO + defaultBehavior: always_off is used ExperimentalProbabilitySampler: type: - object @@ -193,8 +183,7 @@ $defs: maximum: 1 description: | Configure ratio. - If omitted or null, 1.0 is used. - defaultBehavior: TODO + defaultBehavior: 1.0 is used TraceIdRatioBasedSampler: type: - object @@ -209,8 +198,7 @@ $defs: maximum: 1 description: | Configure trace_id_ratio. - If omitted or null, 1.0 is used. - defaultBehavior: TODO + defaultBehavior: 1.0 is used ExperimentalComposableAlwaysOffSampler: type: - object @@ -261,8 +249,7 @@ $defs: maximum: 1 description: | Configure ratio. - If omitted or null, 1.0 is used. - defaultBehavior: TODO + defaultBehavior: 1.0 is used ExperimentalComposableSampler: type: object additionalProperties: @@ -340,8 +327,7 @@ $defs: description: | 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. - defaultBehavior: TODO + defaultBehavior: there is no limit attribute_count_limit: type: - integer @@ -350,8 +336,7 @@ $defs: description: | Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. Value must be non-negative. - If omitted or null, 128 is used. - defaultBehavior: TODO + defaultBehavior: 128 is used event_count_limit: type: - integer @@ -360,8 +345,7 @@ $defs: description: | Configure max span event count. Value must be non-negative. - If omitted or null, 128 is used. - defaultBehavior: TODO + defaultBehavior: 128 is used link_count_limit: type: - integer @@ -370,8 +354,7 @@ $defs: description: | Configure max span link count. Value must be non-negative. - If omitted or null, 128 is used. - defaultBehavior: TODO + defaultBehavior: 128 is used event_attribute_count_limit: type: - integer @@ -380,8 +363,7 @@ $defs: description: | Configure max attributes per span event. Value must be non-negative. - If omitted or null, 128 is used. - defaultBehavior: TODO + defaultBehavior: 128 is used link_attribute_count_limit: type: - integer @@ -390,8 +372,7 @@ $defs: description: | Configure max attributes per span link. Value must be non-negative. - If omitted or null, 128 is used. - defaultBehavior: TODO + defaultBehavior: 128 is used SpanProcessor: type: object additionalProperties: @@ -422,8 +403,7 @@ $defs: - "null" description: | Configure endpoint. - If omitted or null, http://localhost:9411/api/v2/spans is used. - defaultBehavior: TODO + defaultBehavior: http://localhost:9411/api/v2/spans is used timeout: type: - integer @@ -432,8 +412,7 @@ $defs: description: | Configure max time (in milliseconds) to wait for each export. Value must be non-negative. A value of 0 indicates indefinite. - If omitted or null, 10000 is used. - defaultBehavior: TODO + defaultBehavior: 10000 is used ExperimentalTracerConfigurator: type: - object diff --git a/scripts/compile-schema.js b/scripts/compile-schema.js index c2c2503c..7f3285ea 100644 --- a/scripts/compile-schema.js +++ b/scripts/compile-schema.js @@ -170,8 +170,13 @@ function optionalPropertiesHaveDefaultBehavior(sourceSchemaType, messages) { messages.push(`Please add 'defaultBehavior' to optional property ${sourceSchemaType.type}.${property.property}.`); }); sourceSchemaType.properties - .filter(property => required.includes(property.property) && property.schema['defaultBehavior']) + .filter(property => required.includes(property.property)) .forEach(property => { - messages.push(`Please remove 'defaultBehavior' from required property ${sourceSchemaType.type}.${property.property}.`); + if (property.schema['defaultBehavior']) { + messages.push(`Please remove 'defaultBehavior' from required property ${sourceSchemaType.type}.${property.property}.`); + } + if (property.schema['nullBehavior']) { + messages.push(`Please remove 'nullBehavior' from required property ${sourceSchemaType.type}.${property.property}.`); + } }); } From 6c00b3df4779aac9665c4f670b96dda25003e4cb Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Thu, 20 Nov 2025 16:34:47 -0600 Subject: [PATCH 4/5] Update compile-schema, generate-markdown to include default / null behavior --- opentelemetry_configuration.json | 494 ++++++++++---------- schema-docs.md | 778 +++++++++++++++---------------- schema/common.yaml | 1 + scripts/compile-schema.js | 45 +- scripts/generate-markdown.js | 7 +- scripts/source-schema.js | 21 + 6 files changed, 698 insertions(+), 648 deletions(-) diff --git a/opentelemetry_configuration.json b/opentelemetry_configuration.json index ef414e9b..ec4fdd4d 100644 --- a/opentelemetry_configuration.json +++ b/opentelemetry_configuration.json @@ -7,49 +7,49 @@ "properties": { "file_format": { "type": "string", - "description": "The file format version.\nThe yaml format is documented at\nhttps://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema\n" + "description": "The file format version.\nThe yaml format is documented at\nhttps://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema\nProperty is required and must be non-null.\n" }, "disabled": { "type": [ "boolean", "null" ], - "description": "Configure if the SDK is disabled or not.\n" + "description": "Configure if the SDK is disabled or not.\nIf omitted or null, false is used.\n" }, "log_level": { "type": [ "string", "null" ], - "description": "Configure the log level of the internal logger used by the SDK.\n" + "description": "Configure the log level of the internal logger used by the SDK.\nIf omitted or null, info is used.\n" }, "attribute_limits": { "$ref": "#/$defs/AttributeLimits", - "description": "Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.\n" + "description": "Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.\nIf omitted, TODO.\n" }, "logger_provider": { "$ref": "#/$defs/LoggerProvider", - "description": "Configure logger provider.\n" + "description": "Configure logger provider.\nIf omitted, a noop logger provider is used.\n" }, "meter_provider": { "$ref": "#/$defs/MeterProvider", - "description": "Configure meter provider.\n" + "description": "Configure meter provider.\nIf omitted, a noop meter provider is used.\n" }, "propagator": { "$ref": "#/$defs/Propagator", - "description": "Configure text map context propagators.\n" + "description": "Configure text map context propagators.\nIf omitted, a noop propagator is used.\n" }, "tracer_provider": { "$ref": "#/$defs/TracerProvider", - "description": "Configure tracer provider.\n" + "description": "Configure tracer provider.\nIf omitted, a noop tracer provider is used.\n" }, "resource": { "$ref": "#/$defs/Resource", - "description": "Configure resource for all signals.\n" + "description": "Configure resource for all signals.\nIf omitted, the default resource is used.\n" }, "instrumentation/development": { "$ref": "#/$defs/ExperimentalInstrumentation", - "description": "Configure instrumentation.\n" + "description": "Configure instrumentation.\nIf omitted, TODO.\n" } }, "required": [ @@ -64,27 +64,27 @@ "properties": { "default": { "$ref": "#/$defs/DefaultAggregation", - "description": "TODO" + "description": "TODO\nIf omitted, TODO.\n" }, "drop": { "$ref": "#/$defs/DropAggregation", - "description": "TODO" + "description": "TODO\nIf omitted, TODO.\n" }, "explicit_bucket_histogram": { "$ref": "#/$defs/ExplicitBucketHistogramAggregation", - "description": "Configure aggregation to be explicit_bucket_histogram." + "description": "Configure aggregation to be explicit_bucket_histogram.\nIf omitted, TODO.\n" }, "base2_exponential_bucket_histogram": { "$ref": "#/$defs/Base2ExponentialBucketHistogramAggregation", - "description": "TODO" + "description": "TODO\nIf omitted, TODO.\n" }, "last_value": { "$ref": "#/$defs/LastValueAggregation", - "description": "TODO" + "description": "TODO\nIf omitted, TODO.\n" }, "sum": { "$ref": "#/$defs/SumAggregation", - "description": "TODO" + "description": "TODO\nIf omitted, TODO.\n" } } }, @@ -112,7 +112,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute value size. \nValue must be non-negative.\n" + "description": "Configure max attribute value size. \nValue must be non-negative.\nIf omitted or null, there is no limit.\n" }, "attribute_count_limit": { "type": [ @@ -120,7 +120,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute count. \nValue must be non-negative.\n" + "description": "Configure max attribute count. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" } } }, @@ -130,7 +130,7 @@ "properties": { "name": { "type": "string", - "description": "The attribute name.\n" + "description": "The attribute name.\nProperty is required and must be non-null.\n" }, "value": { "oneOf": [ @@ -168,11 +168,11 @@ "minItems": 1 } ], - "description": "The attribute value.\nThe type of value must match .type.\n" + "description": "The attribute value.\nThe type of value must match .type.\nProperty is required and must be non-null.\n" }, "type": { "$ref": "#/$defs/AttributeType", - "description": "The attribute type.\nValues include: string, bool, int, double, string_array, bool_array, int_array, double_array.\n" + "description": "The attribute type.\nValues include: string, bool, int, double, string_array, bool_array, int_array, double_array.\nIf omitted, string is used.\n" } }, "required": [ @@ -231,7 +231,7 @@ ], "minimum": -10, "maximum": 20, - "description": "TODO" + "description": "TODO\nIf omitted or null, TODO.\n" }, "max_size": { "type": [ @@ -239,14 +239,14 @@ "null" ], "minimum": 2, - "description": "TODO" + "description": "TODO\nIf omitted or null, TODO.\n" }, "record_min_max": { "type": [ "boolean", "null" ], - "description": "TODO" + "description": "TODO\nIf omitted or null, TODO.\n" } } }, @@ -260,7 +260,7 @@ "null" ], "minimum": 0, - "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\n" + "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\nIf omitted or null, 1000 is used.\n" }, "export_timeout": { "type": [ @@ -268,7 +268,7 @@ "null" ], "minimum": 0, - "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" + "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 30000 is used.\n" }, "max_queue_size": { "type": [ @@ -276,7 +276,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum queue size. Value must be positive.\n" + "description": "Configure maximum queue size. Value must be positive.\nIf omitted or null, 2048 is used.\n" }, "max_export_batch_size": { "type": [ @@ -284,11 +284,11 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum batch size. Value must be positive.\n" + "description": "Configure maximum batch size. Value must be positive.\nIf omitted or null, 512 is used.\n" }, "exporter": { "$ref": "#/$defs/LogRecordExporter", - "description": "Configure exporter." + "description": "Configure exporter.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -305,7 +305,7 @@ "null" ], "minimum": 0, - "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\n" + "description": "Configure delay interval (in milliseconds) between two consecutive exports. \nValue must be non-negative.\nIf omitted or null, 5000 is used.\n" }, "export_timeout": { "type": [ @@ -313,7 +313,7 @@ "null" ], "minimum": 0, - "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" + "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 30000 is used.\n" }, "max_queue_size": { "type": [ @@ -321,7 +321,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum queue size. Value must be positive.\n" + "description": "Configure maximum queue size. Value must be positive.\nIf omitted or null, 2048 is used.\n" }, "max_export_batch_size": { "type": [ @@ -329,11 +329,11 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure maximum batch size. Value must be positive.\n" + "description": "Configure maximum batch size. Value must be positive.\nIf omitted or null, 512 is used.\n" }, "exporter": { "$ref": "#/$defs/SpanExporter", - "description": "Configure exporter." + "description": "Configure exporter.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -350,7 +350,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for all instrument types.\nInstrument-specific cardinality limits take priority. \n" + "description": "Configure default cardinality limit for all instrument types.\nInstrument-specific cardinality limits take priority. \nIf omitted or null, 2000 is used.\n" }, "counter": { "type": [ @@ -358,7 +358,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for counter instruments.\n" + "description": "Configure default cardinality limit for counter instruments.\nIf omitted or null, the value from .default is used.\n" }, "gauge": { "type": [ @@ -366,7 +366,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for gauge instruments.\n" + "description": "Configure default cardinality limit for gauge instruments.\nIf omitted or null, the value from .default is used.\n" }, "histogram": { "type": [ @@ -374,7 +374,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for histogram instruments.\n" + "description": "Configure default cardinality limit for histogram instruments.\nIf omitted or null, the value from .default is used.\n" }, "observable_counter": { "type": [ @@ -382,7 +382,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for observable_counter instruments.\n" + "description": "Configure default cardinality limit for observable_counter instruments.\nIf omitted or null, the value from .default is used.\n" }, "observable_gauge": { "type": [ @@ -390,7 +390,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for observable_gauge instruments.\n" + "description": "Configure default cardinality limit for observable_gauge instruments.\nIf omitted or null, the value from .default is used.\n" }, "observable_up_down_counter": { "type": [ @@ -398,7 +398,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for observable_up_down_counter instruments.\n" + "description": "Configure default cardinality limit for observable_up_down_counter instruments.\nIf omitted or null, the value from .default is used.\n" }, "up_down_counter": { "type": [ @@ -406,7 +406,7 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure default cardinality limit for up_down_counter instruments.\n" + "description": "Configure default cardinality limit for up_down_counter instruments.\nIf omitted or null, the value from .default is used.\n" } } }, @@ -426,11 +426,11 @@ "properties": { "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\n" + "description": "Configure temporality preference.\nValues 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.\nIf omitted, cumulative is used.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\n" + "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -482,23 +482,23 @@ "properties": { "root": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with no parent." + "description": "Configures the sampler for spans with no parent.\nIf omitted, TODO.\n" }, "remote_parent_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a remote parent that is sampled." + "description": "Configures the sampler for spans with a remote parent that is sampled.\nIf omitted, TODO.\n" }, "remote_parent_not_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a remote parent that is not sampled." + "description": "Configures the sampler for spans with a remote parent that is not sampled.\nIf omitted, TODO.\n" }, "local_parent_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a local parent that is sampled." + "description": "Configures the sampler for spans with a local parent that is sampled.\nIf omitted, TODO.\n" }, "local_parent_not_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a local parent that is not sampled." + "description": "Configures the sampler for spans with a local parent that is not sampled.\nIf omitted, TODO.\n" } } }, @@ -516,7 +516,7 @@ ], "minimum": 0, "maximum": 1, - "description": "Configure ratio.\n" + "description": "Configure ratio.\nIf omitted or null, 1.0 is used.\n" } } }, @@ -533,19 +533,19 @@ "properties": { "always_off": { "$ref": "#/$defs/ExperimentalComposableAlwaysOffSampler", - "description": "Configure sampler to be always_off." + "description": "Configure sampler to be always_off.\nIf omitted, TODO.\n" }, "always_on": { "$ref": "#/$defs/ExperimentalComposableAlwaysOnSampler", - "description": "Configure sampler to be always_on." + "description": "Configure sampler to be always_on.\nIf omitted, TODO.\n" }, "parent_based": { "$ref": "#/$defs/ExperimentalComposableParentBasedSampler", - "description": "Configure sampler to be parent_based." + "description": "Configure sampler to be parent_based.\nIf omitted, TODO.\n" }, "probability": { "$ref": "#/$defs/ExperimentalComposableProbabilitySampler", - "description": "Configure sampler to be probability." + "description": "Configure sampler to be probability.\nIf omitted, TODO.\n" } } }, @@ -562,11 +562,11 @@ "properties": { "peer": { "$ref": "#/$defs/ExperimentalPeerInstrumentation", - "description": "Configure instrumentations following the peer semantic conventions.\nSee peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/\n" + "description": "Configure instrumentations following the peer semantic conventions.\nSee peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/\nIf omitted, TODO.\n" }, "http": { "$ref": "#/$defs/ExperimentalHttpInstrumentation", - "description": "Configure instrumentations following the http semantic conventions.\nSee http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/\n" + "description": "Configure instrumentations following the http semantic conventions.\nSee http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/\nIf omitted, TODO.\n" } } }, @@ -587,14 +587,14 @@ "items": { "type": "string" }, - "description": "Configure headers to capture for outbound http requests.\n" + "description": "Configure headers to capture for outbound http requests.\nIf omitted, TODO.\n" }, "response_captured_headers": { "type": "array", "items": { "type": "string" }, - "description": "Configure headers to capture for inbound http responses.\n" + "description": "Configure headers to capture for inbound http responses.\nIf omitted, TODO.\n" } } }, @@ -604,11 +604,11 @@ "properties": { "client": { "$ref": "#/$defs/ExperimentalHttpClientInstrumentation", - "description": "Configure instrumentations following the http client semantic conventions." + "description": "Configure instrumentations following the http client semantic conventions.\nIf omitted, TODO.\n" }, "server": { "$ref": "#/$defs/ExperimentalHttpServerInstrumentation", - "description": "Configure instrumentations following the http server semantic conventions." + "description": "Configure instrumentations following the http server semantic conventions.\nIf omitted, TODO.\n" } } }, @@ -622,7 +622,7 @@ "items": { "type": "string" }, - "description": "Configure headers to capture for inbound http requests.\n" + "description": "Configure headers to capture for inbound http requests.\nIf omitted, TODO.\n" }, "response_captured_headers": { "type": "array", @@ -630,7 +630,7 @@ "items": { "type": "string" }, - "description": "Configure headers to capture for outbound http responses.\n" + "description": "Configure headers to capture for outbound http responses.\nIf omitted, TODO.\n" } } }, @@ -640,51 +640,51 @@ "properties": { "general": { "$ref": "#/$defs/ExperimentalGeneralInstrumentation", - "description": "Configure general SemConv options that may apply to multiple languages and instrumentations.\nInstrumenation may merge general config options with the language specific configuration at .instrumentation..\n" + "description": "Configure general SemConv options that may apply to multiple languages and instrumentations.\nInstrumenation may merge general config options with the language specific configuration at .instrumentation..\nIf omitted, TODO.\n" }, "cpp": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure C++ language-specific instrumentation libraries." + "description": "Configure C++ language-specific instrumentation libraries.\nIf omitted, TODO.\n" }, "dotnet": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure .NET language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure .NET language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "erlang": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Erlang language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure Erlang language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "go": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Go language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure Go language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "java": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Java language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure Java language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "js": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure JavaScript language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure JavaScript language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "php": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure PHP language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure PHP language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "python": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Python language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure Python language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "ruby": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Ruby language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure Ruby language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "rust": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Rust language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure Rust language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" }, "swift": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Swift language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\n" + "description": "Configure Swift language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" } } }, @@ -700,7 +700,7 @@ "string", "null" ], - "description": "TODO" + "description": "TODO\nIf omitted or null, TODO.\n" }, "interval": { "type": [ @@ -708,11 +708,11 @@ "null" ], "minimum": 0, - "description": "TODO" + "description": "TODO\nIf omitted or null, TODO.\n" }, "initial_sampler": { "$ref": "#/$defs/Sampler", - "description": "TODO" + "description": "TODO\nIf omitted, TODO.\n" } } }, @@ -733,18 +733,18 @@ "boolean", "null" ], - "description": "Configure if the logger is enabled or not.\n" + "description": "Configure if the logger is enabled or not.\nIf omitted or null, false is used.\n" }, "minimum_severity": { "$ref": "#/$defs/ExperimentalSeverityNumber", - "description": "Configure severity filtering.\nLog records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed.\nValues include: TRACE, TRACE2, TRACE3, TRACE4, DEBUG, DEBUG2, DEBUG3, DEBUG4, INFO, INFO2, INFO3, INFO4, WARN, WARN2, WARN3, WARN4, ERROR, ERROR2, ERROR3, ERROR4, FATAL, FATAL2, FATAL3, FATAL4.\n" + "description": "Configure severity filtering.\nLog records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed.\nValues include: TRACE, TRACE2, TRACE3, TRACE4, DEBUG, DEBUG2, DEBUG3, DEBUG4, INFO, INFO2, INFO3, INFO4, WARN, WARN2, WARN3, WARN4, ERROR, ERROR2, ERROR3, ERROR4, FATAL, FATAL2, FATAL3, FATAL4.\nIf omitted, severity filtering is not applied.\n" }, "trace_based": { "type": [ "boolean", "null" ], - "description": "Configure trace based filtering.\nIf 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.\n" + "description": "Configure trace based filtering.\nIf 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.\nIf omitted or null, trace based filtering is not applied.\n" } } }, @@ -756,7 +756,7 @@ "properties": { "default_config": { "$ref": "#/$defs/ExperimentalLoggerConfig", - "description": "Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers." + "description": "Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers.\nIf omitted, TODO.\n" }, "loggers": { "type": "array", @@ -764,7 +764,7 @@ "items": { "$ref": "#/$defs/ExperimentalLoggerMatcherAndConfig" }, - "description": "Configure loggers." + "description": "Configure loggers.\nIf omitted, TODO.\n" } } }, @@ -778,11 +778,11 @@ "type": [ "string" ], - "description": "Configure logger names to match, evaluated as follows:\n\n * If the logger name exactly matches.\n * If the logger name matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\n" + "description": "Configure logger names to match, evaluated as follows:\n\n * If the logger name exactly matches.\n * If the logger name matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\nProperty is required and must be non-null.\n" }, "config": { "$ref": "#/$defs/ExperimentalLoggerConfig", - "description": "The logger config." + "description": "The logger config.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -800,7 +800,7 @@ "type": [ "boolean" ], - "description": "Configure if the meter is enabled or not." + "description": "Configure if the meter is enabled or not.\nIf omitted, TODO.\n" } } }, @@ -812,7 +812,7 @@ "properties": { "default_config": { "$ref": "#/$defs/ExperimentalMeterConfig", - "description": "Configure the default meter config used there is no matching entry in .meter_configurator/development.meters." + "description": "Configure the default meter config used there is no matching entry in .meter_configurator/development.meters.\nIf omitted, TODO.\n" }, "meters": { "type": "array", @@ -820,7 +820,7 @@ "items": { "$ref": "#/$defs/ExperimentalMeterMatcherAndConfig" }, - "description": "Configure meters." + "description": "Configure meters.\nIf omitted, TODO.\n" } } }, @@ -834,11 +834,11 @@ "type": [ "string" ], - "description": "Configure meter names to match, evaluated as follows:\n\n * If the meter name exactly matches.\n * If the meter name matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\n" + "description": "Configure meter names to match, evaluated as follows:\n\n * If the meter name exactly matches.\n * If the meter name matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\nProperty is required and must be non-null.\n" }, "config": { "$ref": "#/$defs/ExperimentalMeterConfig", - "description": "The meter config." + "description": "The meter config.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -858,7 +858,7 @@ "string", "null" ], - "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\n" + "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\nIf omitted or null, stdout is used.\n" } } }, @@ -874,15 +874,15 @@ "string", "null" ], - "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\n" + "description": "Configure output stream. \nValues include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.\nIf omitted or null, stdout is used.\n" }, "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\n" + "description": "Configure temporality preference.\nValues 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.\nIf omitted, cumulative is used.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\n" + "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -896,7 +896,7 @@ "items": { "$ref": "#/$defs/ExperimentalPeerServiceMapping" }, - "description": "Configure the service mapping for instrumentations following peer.service semantic conventions.\nSee peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes\n" + "description": "Configure the service mapping for instrumentations following peer.service semantic conventions.\nSee peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes\nIf omitted, TODO.\n" } } }, @@ -906,11 +906,11 @@ "properties": { "peer": { "type": "string", - "description": "The IP address to map.\n" + "description": "The IP address to map.\nProperty is required and must be non-null.\n" }, "service": { "type": "string", - "description": "The logical name corresponding to the IP address of .peer.\n" + "description": "The logical name corresponding to the IP address of .peer.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -932,7 +932,7 @@ ], "minimum": 0, "maximum": 1, - "description": "Configure ratio.\n" + "description": "Configure ratio.\nIf omitted or null, 1.0 is used.\n" } } }, @@ -955,36 +955,36 @@ "string", "null" ], - "description": "Configure host.\n" + "description": "Configure host.\nIf omitted or null, localhost is used.\n" }, "port": { "type": [ "integer", "null" ], - "description": "Configure port.\n" + "description": "Configure port.\nIf omitted or null, 9464 is used.\n" }, "without_scope_info": { "type": [ "boolean", "null" ], - "description": "Configure Prometheus Exporter to produce metrics without a scope info metric.\n" + "description": "Configure Prometheus Exporter to produce metrics without a scope info metric.\nIf omitted or null, false is used.\n" }, "without_target_info": { "type": [ "boolean", "null" ], - "description": "Configure Prometheus Exporter to produce metrics without a target info metric for the resource.\n" + "description": "Configure Prometheus Exporter to produce metrics without a target info metric for the resource.\nIf omitted or null, false is used.\n" }, "with_resource_constant_labels": { "$ref": "#/$defs/IncludeExclude", - "description": "Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns." + "description": "Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns.\nIf omitted, TODO.\n" }, "translation_strategy": { "$ref": "#/$defs/ExperimentalPrometheusTranslationStrategy", - "description": "Configure how Prometheus metrics are exposed. Values include:\n\n * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.\n * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.\n * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.\n * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.\n" + "description": "Configure how Prometheus metrics are exposed. Values include:\n\n * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.\n * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.\n * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.\n * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.\nIf omitted, UnderscoreEscapingWithSuffixes is used.\n" } } }, @@ -1006,7 +1006,7 @@ "properties": { "attributes": { "$ref": "#/$defs/IncludeExclude", - "description": "Configure attributes provided by resource detectors." + "description": "Configure attributes provided by resource detectors.\nIf omitted, TODO.\n" }, "detectors": { "type": "array", @@ -1014,7 +1014,7 @@ "items": { "$ref": "#/$defs/ExperimentalResourceDetector" }, - "description": "Configure resource detectors.\nResource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. \n" + "description": "Configure resource detectors.\nResource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language. \nIf omitted, no resource detectors are enabled.\n" } } }, @@ -1031,19 +1031,19 @@ "properties": { "container": { "$ref": "#/$defs/ExperimentalContainerResourceDetector", - "description": "Enable the container resource detector, which populates container.* attributes.\n" + "description": "Enable the container resource detector, which populates container.* attributes.\nIf omitted, TODO.\n" }, "host": { "$ref": "#/$defs/ExperimentalHostResourceDetector", - "description": "Enable the host resource detector, which populates host.* and os.* attributes.\n" + "description": "Enable the host resource detector, which populates host.* and os.* attributes.\nIf omitted, TODO.\n" }, "process": { "$ref": "#/$defs/ExperimentalProcessResourceDetector", - "description": "Enable the process resource detector, which populates process.* attributes.\n" + "description": "Enable the process resource detector, which populates process.* attributes.\nIf omitted, TODO.\n" }, "service": { "$ref": "#/$defs/ExperimentalServiceResourceDetector", - "description": "Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.\n" + "description": "Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.\nIf omitted, TODO.\n" } } }, @@ -1096,7 +1096,7 @@ "type": [ "boolean" ], - "description": "Configure if the tracer is enabled or not." + "description": "Configure if the tracer is enabled or not.\nIf omitted, TODO.\n" } } }, @@ -1108,7 +1108,7 @@ "properties": { "default_config": { "$ref": "#/$defs/ExperimentalTracerConfig", - "description": "Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers." + "description": "Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers.\nIf omitted, TODO.\n" }, "tracers": { "type": "array", @@ -1116,7 +1116,7 @@ "items": { "$ref": "#/$defs/ExperimentalTracerMatcherAndConfig" }, - "description": "Configure tracers." + "description": "Configure tracers.\nIf omitted, TODO.\n" } } }, @@ -1130,11 +1130,11 @@ "type": [ "string" ], - "description": "Configure tracer names to match, evaluated as follows:\n\n * If the tracer name exactly matches.\n * If the tracer name matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\n" + "description": "Configure tracer names to match, evaluated as follows:\n\n * If the tracer name exactly matches.\n * If the tracer name matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\nProperty is required and must be non-null.\n" }, "config": { "$ref": "#/$defs/ExperimentalTracerConfig", - "description": "The tracer config." + "description": "The tracer config.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -1155,14 +1155,14 @@ "items": { "type": "number" }, - "description": "Configure bucket boundaries.\n" + "description": "Configure bucket boundaries.\nIf omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used.\n" }, "record_min_max": { "type": [ "boolean", "null" ], - "description": "Configure record min and max.\n" + "description": "Configure record min and max.\nIf omitted or null, true is used.\n" } } }, @@ -1199,28 +1199,28 @@ "string", "null" ], - "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\n" + "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\nIf omitted or null, system default certificate verification is used for secure connections.\n" }, "key_file": { "type": [ "string", "null" ], - "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\n" + "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\nIf omitted or null, mTLS is not used.\n" }, "cert_file": { "type": [ "string", "null" ], - "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\n" + "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\nIf omitted or null, mTLS is not used.\n" }, "insecure": { "type": [ "boolean", "null" ], - "description": "Configure client transport security for the exporter's connection. \nOnly applicable when .endpoint is provided without http or https scheme. Implementations may choose to ignore .insecure.\n" + "description": "Configure client transport security for the exporter's connection. \nOnly applicable when .endpoint is provided without http or https scheme. Implementations may choose to ignore .insecure.\nIf omitted or null, false is used.\n" } } }, @@ -1236,21 +1236,21 @@ "string", "null" ], - "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\n" + "description": "Configure certificate used to verify a server's TLS credentials. \nAbsolute path to certificate file in PEM format.\nIf omitted or null, system default certificate verification is used for secure connections.\n" }, "key_file": { "type": [ "string", "null" ], - "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\n" + "description": "Configure mTLS private client key. \nAbsolute path to client key file in PEM format. If set, .client_certificate must also be set.\nIf omitted or null, mTLS is not used.\n" }, "cert_file": { "type": [ "string", "null" ], - "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\n" + "description": "Configure mTLS client certificate. \nAbsolute path to client certificate file in PEM format. If set, .client_key must also be set.\nIf omitted or null, mTLS is not used.\n" } } }, @@ -1264,7 +1264,7 @@ "items": { "type": "string" }, - "description": "Configure list of value patterns to include.\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\n" + "description": "Configure list of value patterns to include.\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\nIf omitted, all values are included.\n" }, "excluded": { "type": "array", @@ -1272,7 +1272,7 @@ "items": { "type": "string" }, - "description": "Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included).\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\n" + "description": "Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included).\nValues are evaluated to match as follows:\n * If the value exactly matches.\n * If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.\nIf omitted, .included attributes are included.\n" } } }, @@ -1315,15 +1315,15 @@ "items": { "$ref": "#/$defs/LogRecordProcessor" }, - "description": "Configure log record processors." + "description": "Configure log record processors.\nProperty is required and must be non-null.\n" }, "limits": { "$ref": "#/$defs/LogRecordLimits", - "description": "Configure log record limits. See also attribute_limits." + "description": "Configure log record limits. See also attribute_limits.\nIf omitted, TODO.\n" }, "logger_configurator/development": { "$ref": "#/$defs/ExperimentalLoggerConfigurator", - "description": "Configure loggers.\n" + "description": "Configure loggers.\nIf omitted, TODO.\n" } }, "required": [ @@ -1343,19 +1343,19 @@ "properties": { "otlp_http": { "$ref": "#/$defs/OtlpHttpExporter", - "description": "Configure exporter to be OTLP with HTTP transport." + "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, TODO.\n" }, "otlp_grpc": { "$ref": "#/$defs/OtlpGrpcExporter", - "description": "Configure exporter to be OTLP with gRPC transport." + "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, TODO.\n" }, "otlp_file/development": { "$ref": "#/$defs/ExperimentalOtlpFileExporter", - "description": "Configure exporter to be OTLP with file transport.\n" + "description": "Configure exporter to be OTLP with file transport.\nIf omitted, TODO.\n" }, "console": { "$ref": "#/$defs/ConsoleExporter", - "description": "Configure exporter to be console." + "description": "Configure exporter to be console.\nIf omitted, TODO.\n" } } }, @@ -1369,7 +1369,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\n" + "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\nIf omitted or null, there is no limit.\n" }, "attribute_count_limit": { "type": [ @@ -1377,7 +1377,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\n" + "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" } } }, @@ -1394,11 +1394,11 @@ "properties": { "batch": { "$ref": "#/$defs/BatchLogRecordProcessor", - "description": "Configure a batch log record processor." + "description": "Configure a batch log record processor.\nIf omitted, TODO.\n" }, "simple": { "$ref": "#/$defs/SimpleLogRecordProcessor", - "description": "Configure a simple log record processor." + "description": "Configure a simple log record processor.\nIf omitted, TODO.\n" } } }, @@ -1412,7 +1412,7 @@ "items": { "$ref": "#/$defs/MetricReader" }, - "description": "Configure metric readers." + "description": "Configure metric readers.\nProperty is required and must be non-null.\n" }, "views": { "type": "array", @@ -1420,15 +1420,15 @@ "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).\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, TODO.\n" }, "exemplar_filter": { "$ref": "#/$defs/ExemplarFilter", - "description": "Configure the exemplar filter. \nValues 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.\n" + "description": "Configure the exemplar filter. \nValues 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.\nIf omitted, trace_based is used.\n" }, "meter_configurator/development": { "$ref": "#/$defs/ExperimentalMeterConfigurator", - "description": "Configure meters.\n" + "description": "Configure meters.\nIf omitted, TODO.\n" } }, "required": [ @@ -1448,7 +1448,7 @@ "properties": { "opencensus": { "$ref": "#/$defs/OpenCensusMetricProducer", - "description": "Configure metric producer to be opencensus." + "description": "Configure metric producer to be opencensus.\nIf omitted, TODO.\n" } } }, @@ -1460,11 +1460,11 @@ "properties": { "periodic": { "$ref": "#/$defs/PeriodicMetricReader", - "description": "Configure a periodic metric reader." + "description": "Configure a periodic metric reader.\nIf omitted, TODO.\n" }, "pull": { "$ref": "#/$defs/PullMetricReader", - "description": "Configure a pull based metric reader." + "description": "Configure a pull based metric reader.\nIf omitted, TODO.\n" } } }, @@ -1474,14 +1474,14 @@ "properties": { "name": { "type": "string", - "description": "The name of the pair." + "description": "The name of the pair.\nProperty is required and must be non-null.\n" }, "value": { "type": [ "string", "null" ], - "description": "The value of the pair." + "description": "The value of the pair.\nProperty must be present, but if null TODO.\n" } }, "required": [ @@ -1515,11 +1515,11 @@ "string", "null" ], - "description": "Configure endpoint.\n" + "description": "Configure endpoint.\nIf omitted or null, http://localhost:4317 is used.\n" }, "tls": { "$ref": "#/$defs/GrpcTls", - "description": "Configure TLS settings for the exporter." + "description": "Configure TLS settings for the exporter.\nIf omitted, system default TLS settings are used.\n" }, "headers": { "type": "array", @@ -1527,21 +1527,21 @@ "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.\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": [ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" }, "timeout": { "type": [ @@ -1549,7 +1549,7 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" } } }, @@ -1565,11 +1565,11 @@ "string", "null" ], - "description": "Configure endpoint.\n" + "description": "Configure endpoint.\nIf omitted or null, http://localhost:4317 is used.\n" }, "tls": { "$ref": "#/$defs/GrpcTls", - "description": "Configure TLS settings for the exporter." + "description": "Configure TLS settings for the exporter.\nIf omitted, TODO.\n" }, "headers": { "type": "array", @@ -1577,21 +1577,21 @@ "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.\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, TODO.\n" }, "headers_list": { "type": [ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" }, "timeout": { "type": [ @@ -1599,15 +1599,15 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" }, "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\n" + "description": "Configure temporality preference.\nValues 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.\nIf omitted, cumulative is used.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\n" + "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -1633,11 +1633,11 @@ "string", "null" ], - "description": "Configure endpoint, including the signal specific path.\n" + "description": "Configure endpoint, including the signal specific path.\nIf omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.\n" }, "tls": { "$ref": "#/$defs/HttpTls", - "description": "Configure TLS settings for the exporter." + "description": "Configure TLS settings for the exporter.\nIf omitted, system default TLS settings are used.\n" }, "headers": { "type": "array", @@ -1645,21 +1645,21 @@ "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.\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": [ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" }, "timeout": { "type": [ @@ -1667,11 +1667,11 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" }, "encoding": { "$ref": "#/$defs/OtlpHttpEncoding", - "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\n" + "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\nIf omitted, protobuf is used.\n" } } }, @@ -1687,11 +1687,11 @@ "string", "null" ], - "description": "Configure endpoint.\n" + "description": "Configure endpoint.\nIf omitted or null, http://localhost:4318/v1/metrics is used.\n" }, "tls": { "$ref": "#/$defs/HttpTls", - "description": "Configure TLS settings for the exporter." + "description": "Configure TLS settings for the exporter.\nIf omitted, TODO.\n" }, "headers": { "type": "array", @@ -1699,21 +1699,21 @@ "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.\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, TODO.\n" }, "headers_list": { "type": [ "string", "null" ], - "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\n" + "description": "Configure headers. Entries have lower priority than entries from .headers.\nThe 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.\nIf omitted or null, no headers are added.\n" }, "compression": { "type": [ "string", "null" ], - "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\n" + "description": "Configure compression.\nValues include: gzip, none. Implementations may support other compression algorithms.\nIf omitted or null, none is used.\n" }, "timeout": { "type": [ @@ -1721,19 +1721,19 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" + "description": "Configure max time (in milliseconds) to wait for each export.\nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 10000 is used.\n" }, "encoding": { "$ref": "#/$defs/OtlpHttpEncoding", - "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\n" + "description": "Configure the encoding used for messages. \nValues include: protobuf, json. Implementations may not support json.\nIf omitted, protobuf is used.\n" }, "temporality_preference": { "$ref": "#/$defs/ExporterTemporalityPreference", - "description": "Configure temporality preference.\nValues 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.\n" + "description": "Configure temporality preference.\nValues 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.\nIf omitted, cumulative is used.\n" }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues 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.\n" + "description": "Configure default histogram aggregation.\nValues 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.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -1746,23 +1746,23 @@ "properties": { "root": { "$ref": "#/$defs/Sampler", - "description": "Configure root sampler.\n" + "description": "Configure root sampler.\nIf omitted, always_on is used.\n" }, "remote_parent_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure remote_parent_sampled sampler.\n" + "description": "Configure remote_parent_sampled sampler.\nIf omitted, always_on is used.\n" }, "remote_parent_not_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure remote_parent_not_sampled sampler.\n" + "description": "Configure remote_parent_not_sampled sampler.\nIf omitted, always_off is used.\n" }, "local_parent_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure local_parent_sampled sampler.\n" + "description": "Configure local_parent_sampled sampler.\nIf omitted, always_on is used.\n" }, "local_parent_not_sampled": { "$ref": "#/$defs/Sampler", - "description": "Configure local_parent_not_sampled sampler.\n" + "description": "Configure local_parent_not_sampled sampler.\nIf omitted, always_off is used.\n" } } }, @@ -1776,7 +1776,7 @@ "null" ], "minimum": 0, - "description": "Configure delay interval (in milliseconds) between start of two consecutive exports. \nValue must be non-negative.\n" + "description": "Configure delay interval (in milliseconds) between start of two consecutive exports. \nValue must be non-negative.\nIf omitted or null, 60000 is used.\n" }, "timeout": { "type": [ @@ -1784,11 +1784,11 @@ "null" ], "minimum": 0, - "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\n" + "description": "Configure maximum allowed time (in milliseconds) to export data. \nValue must be non-negative. A value of 0 indicates no limit (infinity).\nIf omitted or null, 30000 is used.\n" }, "exporter": { "$ref": "#/$defs/PushMetricExporter", - "description": "Configure exporter." + "description": "Configure exporter.\nProperty is required and must be non-null.\n" }, "producers": { "type": "array", @@ -1796,11 +1796,11 @@ "items": { "$ref": "#/$defs/MetricProducer" }, - "description": "Configure metric producers." + "description": "Configure metric producers.\nIf omitted, TODO.\n" }, "cardinality_limits": { "$ref": "#/$defs/CardinalityLimits", - "description": "Configure cardinality limits." + "description": "Configure cardinality limits.\nIf omitted, TODO.\n" } }, "required": [ @@ -1817,14 +1817,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.\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 the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.\nIf omitted, TODO.\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.\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 the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.\nIf omitted or null, TODO.\n" } } }, @@ -1841,7 +1841,7 @@ "properties": { "prometheus/development": { "$ref": "#/$defs/ExperimentalPrometheusMetricExporter", - "description": "Configure exporter to be prometheus.\n" + "description": "Configure exporter to be prometheus.\nIf omitted, TODO.\n" } } }, @@ -1851,7 +1851,7 @@ "properties": { "exporter": { "$ref": "#/$defs/PullMetricExporter", - "description": "Configure exporter." + "description": "Configure exporter.\nProperty is required and must be non-null.\n" }, "producers": { "type": "array", @@ -1859,11 +1859,11 @@ "items": { "$ref": "#/$defs/MetricProducer" }, - "description": "Configure metric producers." + "description": "Configure metric producers.\nIf omitted, TODO.\n" }, "cardinality_limits": { "$ref": "#/$defs/CardinalityLimits", - "description": "Configure cardinality limits." + "description": "Configure cardinality limits.\nIf omitted, TODO.\n" } }, "required": [ @@ -1883,19 +1883,19 @@ "properties": { "otlp_http": { "$ref": "#/$defs/OtlpHttpMetricExporter", - "description": "Configure exporter to be OTLP with HTTP transport.\n" + "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, TODO.\n" }, "otlp_grpc": { "$ref": "#/$defs/OtlpGrpcMetricExporter", - "description": "Configure exporter to be OTLP with gRPC transport.\n" + "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, TODO.\n" }, "otlp_file/development": { "$ref": "#/$defs/ExperimentalOtlpFileMetricExporter", - "description": "Configure exporter to be OTLP with file transport.\n" + "description": "Configure exporter to be OTLP with file transport.\nIf omitted, TODO.\n" }, "console": { "$ref": "#/$defs/ConsoleMetricExporter", - "description": "Configure exporter to be console.\n" + "description": "Configure exporter to be console.\nIf omitted, TODO.\n" } } }, @@ -1909,25 +1909,25 @@ "items": { "$ref": "#/$defs/AttributeNameValue" }, - "description": "Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.\n" + "description": "Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.\nIf omitted, TODO.\n" }, "detection/development": { "$ref": "#/$defs/ExperimentalResourceDetection", - "description": "Configure resource detection.\n" + "description": "Configure resource detection.\nIf omitted, resource detection is disabled.\n" }, "schema_url": { "type": [ "string", "null" ], - "description": "Configure resource schema URL.\n" + "description": "Configure resource schema URL.\nIf omitted or null, no schema URL is used.\n" }, "attributes_list": { "type": [ "string", "null" ], - "description": "Configure resource attributes. Entries have lower priority than entries from .resource.attributes.\nThe 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.\n" + "description": "Configure resource attributes. Entries have lower priority than entries from .resource.attributes.\nThe 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.\nIf omitted or null, no resource attributes are added.\n" } } }, @@ -1944,31 +1944,31 @@ "properties": { "always_off": { "$ref": "#/$defs/AlwaysOffSampler", - "description": "Configure sampler to be always_off." + "description": "Configure sampler to be always_off.\nIf omitted, TODO.\n" }, "always_on": { "$ref": "#/$defs/AlwaysOnSampler", - "description": "Configure sampler to be always_on." + "description": "Configure sampler to be always_on.\nIf omitted, TODO.\n" }, "composite/development": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configure sampler to be composite." + "description": "Configure sampler to be composite.\nIf omitted, TODO.\n" }, "jaeger_remote/development": { "$ref": "#/$defs/ExperimentalJaegerRemoteSampler", - "description": "TODO" + "description": "TODO\nIf omitted, TODO.\n" }, "parent_based": { "$ref": "#/$defs/ParentBasedSampler", - "description": "Configure sampler to be parent_based." + "description": "Configure sampler to be parent_based.\nIf omitted, TODO.\n" }, "probability/development": { "$ref": "#/$defs/ExperimentalProbabilitySampler", - "description": "Configure sampler to be probability." + "description": "Configure sampler to be probability.\nIf omitted, TODO.\n" }, "trace_id_ratio_based": { "$ref": "#/$defs/TraceIdRatioBasedSampler", - "description": "Configure sampler to be trace_id_ratio_based." + "description": "Configure sampler to be trace_id_ratio_based.\nIf omitted, TODO.\n" } } }, @@ -1978,7 +1978,7 @@ "properties": { "exporter": { "$ref": "#/$defs/LogRecordExporter", - "description": "Configure exporter." + "description": "Configure exporter.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -1991,7 +1991,7 @@ "properties": { "exporter": { "$ref": "#/$defs/SpanExporter", - "description": "Configure exporter." + "description": "Configure exporter.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -2011,23 +2011,23 @@ "properties": { "otlp_http": { "$ref": "#/$defs/OtlpHttpExporter", - "description": "Configure exporter to be OTLP with HTTP transport." + "description": "Configure exporter to be OTLP with HTTP transport.\nIf omitted, TODO.\n" }, "otlp_grpc": { "$ref": "#/$defs/OtlpGrpcExporter", - "description": "Configure exporter to be OTLP with gRPC transport." + "description": "Configure exporter to be OTLP with gRPC transport.\nIf omitted, TODO.\n" }, "otlp_file/development": { "$ref": "#/$defs/ExperimentalOtlpFileExporter", - "description": "Configure exporter to be OTLP with file transport.\n" + "description": "Configure exporter to be OTLP with file transport.\nIf omitted, TODO.\n" }, "console": { "$ref": "#/$defs/ConsoleExporter", - "description": "Configure exporter to be console." + "description": "Configure exporter to be console.\nIf omitted, TODO.\n" }, "zipkin": { "$ref": "#/$defs/ZipkinSpanExporter", - "description": "Configure exporter to be zipkin." + "description": "Configure exporter to be zipkin.\nIf omitted, TODO.\n" } } }, @@ -2041,7 +2041,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\n" + "description": "Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. \nValue must be non-negative.\nIf omitted or null, there is no limit.\n" }, "attribute_count_limit": { "type": [ @@ -2049,7 +2049,7 @@ "null" ], "minimum": 0, - "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\n" + "description": "Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" }, "event_count_limit": { "type": [ @@ -2057,7 +2057,7 @@ "null" ], "minimum": 0, - "description": "Configure max span event count. \nValue must be non-negative.\n" + "description": "Configure max span event count. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" }, "link_count_limit": { "type": [ @@ -2065,7 +2065,7 @@ "null" ], "minimum": 0, - "description": "Configure max span link count. \nValue must be non-negative.\n" + "description": "Configure max span link count. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" }, "event_attribute_count_limit": { "type": [ @@ -2073,7 +2073,7 @@ "null" ], "minimum": 0, - "description": "Configure max attributes per span event. \nValue must be non-negative.\n" + "description": "Configure max attributes per span event. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" }, "link_attribute_count_limit": { "type": [ @@ -2081,7 +2081,7 @@ "null" ], "minimum": 0, - "description": "Configure max attributes per span link. \nValue must be non-negative.\n" + "description": "Configure max attributes per span link. \nValue must be non-negative.\nIf omitted or null, 128 is used.\n" } } }, @@ -2098,11 +2098,11 @@ "properties": { "batch": { "$ref": "#/$defs/BatchSpanProcessor", - "description": "Configure a batch span processor." + "description": "Configure a batch span processor.\nIf omitted, TODO.\n" }, "simple": { "$ref": "#/$defs/SimpleSpanProcessor", - "description": "Configure a simple span processor." + "description": "Configure a simple span processor.\nIf omitted, TODO.\n" } } }, @@ -2126,27 +2126,27 @@ "properties": { "tracecontext": { "$ref": "#/$defs/TraceContextPropagator", - "description": "Include the w3c trace context propagator." + "description": "Include the w3c trace context propagator.\nIf omitted, TODO.\n" }, "baggage": { "$ref": "#/$defs/BaggagePropagator", - "description": "Include the w3c baggage propagator." + "description": "Include the w3c baggage propagator.\nIf omitted, TODO.\n" }, "b3": { "$ref": "#/$defs/B3Propagator", - "description": "Include the zipkin b3 propagator." + "description": "Include the zipkin b3 propagator.\nIf omitted, TODO.\n" }, "b3multi": { "$ref": "#/$defs/B3MultiPropagator", - "description": "Include the zipkin b3 multi propagator." + "description": "Include the zipkin b3 multi propagator.\nIf omitted, TODO.\n" }, "jaeger": { "$ref": "#/$defs/JaegerPropagator", - "description": "Include the jaeger propagator." + "description": "Include the jaeger propagator.\nIf omitted, TODO.\n" }, "ottrace": { "$ref": "#/$defs/OpenTracingPropagator", - "description": "Include the opentracing propagator." + "description": "Include the opentracing propagator.\nIf omitted, TODO.\n" } } }, @@ -2171,7 +2171,7 @@ ], "minimum": 0, "maximum": 1, - "description": "Configure trace_id_ratio.\n" + "description": "Configure trace_id_ratio.\nIf omitted or null, 1.0 is used.\n" } } }, @@ -2185,19 +2185,19 @@ "items": { "$ref": "#/$defs/SpanProcessor" }, - "description": "Configure span processors." + "description": "Configure span processors.\nProperty is required and must be non-null.\n" }, "limits": { "$ref": "#/$defs/SpanLimits", - "description": "Configure span limits. See also attribute_limits." + "description": "Configure span limits. See also attribute_limits.\nIf omitted, TODO.\n" }, "sampler": { "$ref": "#/$defs/Sampler", - "description": "Configure the sampler.\n" + "description": "Configure the sampler.\nIf omitted, parent based sampler with a root of always_on is used.\n" }, "tracer_configurator/development": { "$ref": "#/$defs/ExperimentalTracerConfigurator", - "description": "Configure tracers.\n" + "description": "Configure tracers.\nIf omitted, TODO.\n" } }, "required": [ @@ -2210,11 +2210,11 @@ "properties": { "selector": { "$ref": "#/$defs/ViewSelector", - "description": "Configure view selector. \nSelection criteria is additive as described in https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#instrument-selection-criteria.\n" + "description": "Configure view selector. \nSelection criteria is additive as described in https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#instrument-selection-criteria.\nProperty is required and must be non-null.\n" }, "stream": { "$ref": "#/$defs/ViewStream", - "description": "Configure view stream." + "description": "Configure view stream.\nProperty is required and must be non-null.\n" } }, "required": [ @@ -2231,39 +2231,39 @@ "string", "null" ], - "description": "Configure instrument name selection criteria.\n" + "description": "Configure instrument name selection criteria.\nIf omitted or null, all instrument names match.\n" }, "instrument_type": { "$ref": "#/$defs/InstrumentType", - "description": "Configure instrument type selection criteria.\nValues include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter.\n" + "description": "Configure instrument type selection criteria.\nValues include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter.\nIf omitted, all instrument types match.\n" }, "unit": { "type": [ "string", "null" ], - "description": "Configure the instrument unit selection criteria.\n" + "description": "Configure the instrument unit selection criteria.\nIf omitted or null, all instrument units match.\n" }, "meter_name": { "type": [ "string", "null" ], - "description": "Configure meter name selection criteria.\n" + "description": "Configure meter name selection criteria.\nIf omitted or null, all meter names match.\n" }, "meter_version": { "type": [ "string", "null" ], - "description": "Configure meter version selection criteria.\n" + "description": "Configure meter version selection criteria.\nIf omitted or null, all meter versions match.\n" }, "meter_schema_url": { "type": [ "string", "null" ], - "description": "Configure meter schema url selection criteria.\n" + "description": "Configure meter schema url selection criteria.\nIf omitted or null, all meter schema URLs match.\n" } } }, @@ -2276,18 +2276,18 @@ "string", "null" ], - "description": "Configure metric name of the resulting stream(s).\n" + "description": "Configure metric name of the resulting stream(s).\nIf omitted or null, the instrument's original name is used.\n" }, "description": { "type": [ "string", "null" ], - "description": "Configure metric description of the resulting stream(s).\n" + "description": "Configure metric description of the resulting stream(s).\nIf omitted or null, the instrument's origin description is used.\n" }, "aggregation": { "$ref": "#/$defs/Aggregation", - "description": "Configure aggregation of the resulting stream(s). \nValues 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.\n" + "description": "Configure aggregation of the resulting stream(s). \nValues 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.\nIf omitted, default is used.\n" }, "aggregation_cardinality_limit": { "type": [ @@ -2295,11 +2295,11 @@ "null" ], "exclusiveMinimum": 0, - "description": "Configure the aggregation cardinality limit.\n" + "description": "Configure the aggregation cardinality limit.\nIf omitted or null, the metric reader's default cardinality limit is used.\n" }, "attribute_keys": { "$ref": "#/$defs/IncludeExclude", - "description": "Configure attribute keys retained in the resulting stream(s).\n" + "description": "Configure attribute keys retained in the resulting stream(s).\nIf omitted, TODO.\n" } } }, @@ -2315,7 +2315,7 @@ "string", "null" ], - "description": "Configure endpoint.\n" + "description": "Configure endpoint.\nIf omitted or null, http://localhost:9411/api/v2/spans is used.\n" }, "timeout": { "type": [ @@ -2323,7 +2323,7 @@ "null" ], "minimum": 0, - "description": "Configure max time (in milliseconds) to wait for each export. \nValue must be non-negative. A value of 0 indicates indefinite.\n" + "description": "Configure max time (in milliseconds) to wait for each export. \nValue must be non-negative. A value of 0 indicates indefinite.\nIf omitted or null, 10000 is used.\n" } } } diff --git a/schema-docs.md b/schema-docs.md index f950e60a..07d09318 100644 --- a/schema-docs.md +++ b/schema-docs.md @@ -14,14 +14,14 @@ This document is an auto-generated view of the declarative configuration JSON sc ## Aggregation -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `base2_exponential_bucket_histogram` | [`Base2ExponentialBucketHistogramAggregation`](#base2exponentialbuckethistogramaggregation) | `false` | No constraints. | TODO | -| `default` | [`DefaultAggregation`](#defaultaggregation) | `false` | No constraints. | TODO | -| `drop` | [`DropAggregation`](#dropaggregation) | `false` | No constraints. | TODO | -| `explicit_bucket_histogram` | [`ExplicitBucketHistogramAggregation`](#explicitbuckethistogramaggregation) | `false` | No constraints. | Configure aggregation to be explicit_bucket_histogram. | -| `last_value` | [`LastValueAggregation`](#lastvalueaggregation) | `false` | No constraints. | TODO | -| `sum` | [`SumAggregation`](#sumaggregation) | `false` | No constraints. | TODO | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `base2_exponential_bucket_histogram` | [`Base2ExponentialBucketHistogramAggregation`](#base2exponentialbuckethistogramaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | +| `default` | [`DefaultAggregation`](#defaultaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | +| `drop` | [`DropAggregation`](#dropaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | +| `explicit_bucket_histogram` | [`ExplicitBucketHistogramAggregation`](#explicitbuckethistogramaggregation) | `false` | If omitted, TODO. | No constraints. | Configure aggregation to be explicit_bucket_histogram. | +| `last_value` | [`LastValueAggregation`](#lastvalueaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | +| `sum` | [`SumAggregation`](#sumaggregation) | `false` | If omitted, TODO. | No constraints. | TODO |
Language support status @@ -130,10 +130,10 @@ Usages: ## AttributeLimits -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max attribute count.
Value must be non-negative.
If omitted or null, 128 is used.
| -| `attribute_value_length_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max attribute value size.
Value must be non-negative.
If omitted or null, there is no limit.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 128 is used. | * `minimum`: `0`
| Configure max attribute count.
Value must be non-negative.
| +| `attribute_value_length_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, there is no limit. | * `minimum`: `0`
| Configure max attribute value size.
Value must be non-negative.
|
Language support status @@ -180,11 +180,11 @@ Usages: ## AttributeNameValue -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `name` | `string` | `true` | No constraints. | The attribute name.
| -| `type` | [`AttributeType`](#attributetype) | `false` | No constraints. | The attribute type.
Values include: string, bool, int, double, string_array, bool_array, int_array, double_array.
If omitted or null, string is used.
| -| `value` | `oneOf` | `true` | No constraints. | The attribute value.
The type of value must match .type.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `name` | `string` | `true` | Property is required and must be non-null. | No constraints. | The attribute name.
| +| `type` | [`AttributeType`](#attributetype) | `false` | If omitted, string is used. | No constraints. | The attribute type.
Values include: string, bool, int, double, string_array, bool_array, int_array, double_array.
| +| `value` | `oneOf` | `true` | Property is required and must be non-null. | No constraints. | The attribute value.
The type of value must match .type.
|
Language support status @@ -399,11 +399,11 @@ Usages: ## Base2ExponentialBucketHistogramAggregation -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `max_scale` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `-10`
* `maximum`: `20`
| TODO | -| `max_size` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `2`
| TODO | -| `record_min_max` | one of:
* `boolean`
* `null`
| `false` | No constraints. | TODO | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `max_scale` | one of:
* `integer`
* `null`
| `false` | If omitted or null, TODO. | * `minimum`: `-10`
* `maximum`: `20`
| TODO | +| `max_size` | one of:
* `integer`
* `null`
| `false` | If omitted or null, TODO. | * `minimum`: `2`
| TODO | +| `record_min_max` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, TODO. | No constraints. | TODO |
Language support status @@ -461,13 +461,13 @@ Usages: ## BatchLogRecordProcessor -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `export_timeout` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| 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.
| -| `exporter` | [`LogRecordExporter`](#logrecordexporter) | `true` | No constraints. | Configure exporter. | -| `max_export_batch_size` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure maximum batch size. Value must be positive.
If omitted or null, 512 is used.
| -| `max_queue_size` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure maximum queue size. Value must be positive.
If omitted or null, 2048 is used.
| -| `schedule_delay` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure delay interval (in milliseconds) between two consecutive exports.
Value must be non-negative.
If omitted or null, 1000 is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `export_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).
| +| `exporter` | [`LogRecordExporter`](#logrecordexporter) | `true` | Property is required and must be non-null. | No constraints. | Configure exporter. | +| `max_export_batch_size` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 512 is used. | * `exclusiveMinimum`: `0`
| Configure maximum batch size. Value must be positive.
| +| `max_queue_size` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 2048 is used. | * `exclusiveMinimum`: `0`
| Configure maximum queue size. Value must be positive.
| +| `schedule_delay` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 1000 is used. | * `minimum`: `0`
| Configure delay interval (in milliseconds) between two consecutive exports.
Value must be non-negative.
|
Language support status @@ -538,13 +538,13 @@ Usages: ## BatchSpanProcessor -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `export_timeout` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| 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.
| -| `exporter` | [`SpanExporter`](#spanexporter) | `true` | No constraints. | Configure exporter. | -| `max_export_batch_size` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure maximum batch size. Value must be positive.
If omitted or null, 512 is used.
| -| `max_queue_size` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure maximum queue size. Value must be positive.
If omitted or null, 2048 is used.
| -| `schedule_delay` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure delay interval (in milliseconds) between two consecutive exports.
Value must be non-negative.
If omitted or null, 5000 is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `export_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).
| +| `exporter` | [`SpanExporter`](#spanexporter) | `true` | Property is required and must be non-null. | No constraints. | Configure exporter. | +| `max_export_batch_size` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 512 is used. | * `exclusiveMinimum`: `0`
| Configure maximum batch size. Value must be positive.
| +| `max_queue_size` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 2048 is used. | * `exclusiveMinimum`: `0`
| Configure maximum queue size. Value must be positive.
| +| `schedule_delay` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 5000 is used. | * `minimum`: `0`
| Configure delay interval (in milliseconds) between two consecutive exports.
Value must be non-negative.
|
Language support status @@ -615,16 +615,16 @@ Usages: ## CardinalityLimits -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `counter` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for counter instruments.
If omitted or null, the value from .default is used.
| -| `default` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for all instrument types.
Instrument-specific cardinality limits take priority.
If omitted or null, 2000 is used.
| -| `gauge` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for gauge instruments.
If omitted or null, the value from .default is used.
| -| `histogram` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for histogram instruments.
If omitted or null, the value from .default is used.
| -| `observable_counter` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for observable_counter instruments.
If omitted or null, the value from .default is used.
| -| `observable_gauge` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for observable_gauge instruments.
If omitted or null, the value from .default is used.
| -| `observable_up_down_counter` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for observable_up_down_counter instruments.
If omitted or null, the value from .default is used.
| -| `up_down_counter` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for up_down_counter instruments.
If omitted or null, the value from .default is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `counter` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the value from .default is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for counter instruments.
| +| `default` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 2000 is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for all instrument types.
Instrument-specific cardinality limits take priority.
| +| `gauge` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the value from .default is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for gauge instruments.
| +| `histogram` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the value from .default is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for histogram instruments.
| +| `observable_counter` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the value from .default is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for observable_counter instruments.
| +| `observable_gauge` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the value from .default is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for observable_gauge instruments.
| +| `observable_up_down_counter` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the value from .default is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for observable_up_down_counter instruments.
| +| `up_down_counter` | one of:
* `integer`
* `null`
| `false` | If omitted or null, the value from .default is used. | * `exclusiveMinimum`: `0`
| Configure default cardinality limit for up_down_counter instruments.
|
Language support status @@ -746,10 +746,10 @@ Usages: ## ConsoleMetricExporter -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `default_histogram_aggregation` | [`ExporterDefaultHistogramAggregation`](#exporterdefaulthistogramaggregation) | `false` | 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.
If omitted or null, explicit_bucket_histogram is used.
| -| `temporality_preference` | [`ExporterTemporalityPreference`](#exportertemporalitypreference) | `false` | 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.
If omitted or null, cumulative is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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.
| +| `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.
|
Language support status @@ -884,10 +884,10 @@ Usages: ## ExplicitBucketHistogramAggregation -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `boundaries` | `array` of `number` | `false` | * `minItems`: `0`
| Configure bucket boundaries.
If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used.
| -| `record_min_max` | one of:
* `boolean`
* `null`
| `false` | No constraints. | Configure record min and max.
If omitted or null, true is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `boundaries` | `array` of `number` | `false` | If omitted, [0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000, 7500, 10000] is used. | * `minItems`: `0`
| Configure bucket boundaries.
| +| `record_min_max` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, true is used. | No constraints. | Configure record min and max.
|
Language support status @@ -1025,12 +1025,12 @@ Usages: ## GrpcTls -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `ca_file` | one of:
* `string`
* `null`
| `false` | No constraints. | 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.
| -| `cert_file` | one of:
* `string`
* `null`
| `false` | No constraints. | 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` | one of:
* `boolean`
* `null`
| `false` | No constraints. | 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.
| -| `key_file` | one of:
* `string`
* `null`
| `false` | No constraints. | 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.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `ca_file` | one of:
* `string`
* `null`
| `false` | If omitted or null, system default certificate verification is used for secure connections. | No constraints. | Configure certificate used to verify a server's TLS credentials.
Absolute path to certificate file in PEM format.
| +| `cert_file` | one of:
* `string`
* `null`
| `false` | If omitted or null, mTLS is not used. | No constraints. | Configure mTLS client certificate.
Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
| +| `insecure` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, false is used. | No constraints. | Configure client transport security for the exporter's connection.
Only applicable when .endpoint is provided without http or https scheme. Implementations may choose to ignore .insecure.
| +| `key_file` | one of:
* `string`
* `null`
| `false` | If omitted or null, mTLS is not used. | No constraints. | Configure mTLS private client key.
Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
|
Language support status @@ -1093,11 +1093,11 @@ Usages: ## HttpTls -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `ca_file` | one of:
* `string`
* `null`
| `false` | No constraints. | 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.
| -| `cert_file` | one of:
* `string`
* `null`
| `false` | No constraints. | 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.
| -| `key_file` | one of:
* `string`
* `null`
| `false` | No constraints. | 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.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `ca_file` | one of:
* `string`
* `null`
| `false` | If omitted or null, system default certificate verification is used for secure connections. | No constraints. | Configure certificate used to verify a server's TLS credentials.
Absolute path to certificate file in PEM format.
| +| `cert_file` | one of:
* `string`
* `null`
| `false` | If omitted or null, mTLS is not used. | No constraints. | Configure mTLS client certificate.
Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
| +| `key_file` | one of:
* `string`
* `null`
| `false` | If omitted or null, mTLS is not used. | No constraints. | Configure mTLS private client key.
Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
|
Language support status @@ -1153,10 +1153,10 @@ Usages: ## IncludeExclude -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `excluded` | `array` of `string` | `false` | * `minItems`: `1`
| Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included).
Values are evaluated to match as follows:
* If the value exactly matches.
* If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.
If omitted, .included attributes are included.
| -| `included` | `array` of `string` | `false` | * `minItems`: `1`
| Configure list of value patterns to include.
Values are evaluated to match as follows:
* If the value exactly matches.
* If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.
If omitted, all values are included.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `excluded` | `array` of `string` | `false` | If omitted, .included attributes are included. | * `minItems`: `1`
| Configure list of value patterns to exclude. Applies after .included (i.e. excluded has higher priority than included).
Values are evaluated to match as follows:
* If the value exactly matches.
* If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.
| +| `included` | `array` of `string` | `false` | If omitted, all values are included. | * `minItems`: `1`
| Configure list of value patterns to include.
Values are evaluated to match as follows:
* If the value exactly matches.
* If the value matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none.
|
Language support status @@ -1310,11 +1310,11 @@ Usages: ## LoggerProvider -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `limits` | [`LogRecordLimits`](#logrecordlimits) | `false` | No constraints. | Configure log record limits. See also attribute_limits. | -| `processors` | `array` of [`LogRecordProcessor`](#logrecordprocessor) | `true` | * `minItems`: `1`
| Configure log record processors. | -| `logger_configurator/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalLoggerConfigurator`](#experimentalloggerconfigurator) | `false` | No constraints. | Configure loggers.
| +| 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. | +| `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, TODO. | No constraints. | Configure loggers.
|
Language support status @@ -1367,12 +1367,12 @@ Usages: `LogRecordExporter` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `console` | [`ConsoleExporter`](#consoleexporter) | `false` | No constraints. | Configure exporter to be console. | -| `otlp_grpc` | [`OtlpGrpcExporter`](#otlpgrpcexporter) | `false` | No constraints. | Configure exporter to be OTLP with gRPC transport. | -| `otlp_http` | [`OtlpHttpExporter`](#otlphttpexporter) | `false` | 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` | No constraints. | Configure exporter to be OTLP with file transport.
| +| 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. | +| `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileExporter`](#experimentalotlpfileexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with file transport.
|
Language support status @@ -1429,10 +1429,10 @@ Usages: ## LogRecordLimits -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max attribute count. Overrides .attribute_limits.attribute_count_limit.
Value must be non-negative.
If omitted or null, 128 is used.
| -| `attribute_value_length_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| 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.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 128 is used. | * `minimum`: `0`
| Configure max attribute count. Overrides .attribute_limits.attribute_count_limit.
Value must be non-negative.
| +| `attribute_value_length_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, there is no limit. | * `minimum`: `0`
| Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit.
Value must be non-negative.
|
Language support status @@ -1481,10 +1481,10 @@ Usages: `LogRecordProcessor` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `batch` | [`BatchLogRecordProcessor`](#batchlogrecordprocessor) | `false` | No constraints. | Configure a batch log record processor. | -| `simple` | [`SimpleLogRecordProcessor`](#simplelogrecordprocessor) | `false` | No constraints. | Configure a simple log record processor. | +| 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. |
Language support status @@ -1532,12 +1532,12 @@ Usages: ## MeterProvider -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `exemplar_filter` | [`ExemplarFilter`](#exemplarfilter) | `false` | 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.
If omitted or null, trace_based is used.
| -| `readers` | `array` of [`MetricReader`](#metricreader) | `true` | * `minItems`: `1`
| Configure metric readers. | -| `views` | `array` of [`View`](#view) | `false` | * `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` | No constraints. | Configure meters.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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).
| +| `meter_configurator/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalMeterConfigurator`](#experimentalmeterconfigurator) | `false` | If omitted, TODO. | No constraints. | Configure meters.
|
Language support status @@ -1598,9 +1598,9 @@ Usages: `MetricProducer` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `opencensus` | [`OpenCensusMetricProducer`](#opencensusmetricproducer) | `false` | No constraints. | Configure metric producer to be opencensus. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `opencensus` | [`OpenCensusMetricProducer`](#opencensusmetricproducer) | `false` | If omitted, TODO. | No constraints. | Configure metric producer to be opencensus. |
Language support status @@ -1645,10 +1645,10 @@ Usages: ## MetricReader -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `periodic` | [`PeriodicMetricReader`](#periodicmetricreader) | `false` | No constraints. | Configure a periodic metric reader. | -| `pull` | [`PullMetricReader`](#pullmetricreader) | `false` | No constraints. | Configure a pull based metric reader. | +| 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. |
Language support status @@ -1691,10 +1691,10 @@ Usages: ## NameStringValuePair -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `name` | `string` | `true` | No constraints. | The name of the pair. | -| `value` | one of:
* `string`
* `null`
| `true` | No constraints. | The value of the pair. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `name` | `string` | `true` | Property is required and must be non-null. | No constraints. | The name of the pair. | +| `value` | one of:
* `string`
* `null`
| `true` | Property must be present, but if null TODO. | No constraints. | The value of the pair. |
Language support status @@ -1769,18 +1769,18 @@ Usages: ## OpenTelemetryConfiguration -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `attribute_limits` | [`AttributeLimits`](#attributelimits) | `false` | No constraints. | Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.
| -| `disabled` | one of:
* `boolean`
* `null`
| `false` | No constraints. | Configure if the SDK is disabled or not.
If omitted or null, false is used.
| -| `file_format` | `string` | `true` | 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` | No constraints. | Configure the log level of the internal logger used by the SDK.
If omitted, info is used.
| -| `logger_provider` | [`LoggerProvider`](#loggerprovider) | `false` | No constraints. | Configure logger provider.
If omitted, a noop logger provider is used.
| -| `meter_provider` | [`MeterProvider`](#meterprovider) | `false` | No constraints. | Configure meter provider.
If omitted, a noop meter provider is used.
| -| `propagator` | [`Propagator`](#propagator) | `false` | No constraints. | Configure text map context propagators.
If omitted, a noop propagator is used.
| -| `resource` | [`Resource`](#resource) | `false` | No constraints. | Configure resource for all signals.
If omitted, the default resource is used.
| -| `tracer_provider` | [`TracerProvider`](#tracerprovider) | `false` | No constraints. | Configure tracer provider.
If omitted, a noop tracer provider is used.
| -| `instrumentation/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalInstrumentation`](#experimentalinstrumentation) | `false` | No constraints. | Configure instrumentation.
| +| 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.
| +| `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.
| +| `logger_provider` | [`LoggerProvider`](#loggerprovider) | `false` | If omitted, a noop logger provider is used. | No constraints. | Configure logger provider.
| +| `meter_provider` | [`MeterProvider`](#meterprovider) | `false` | If omitted, a noop meter provider is used. | No constraints. | Configure meter provider.
| +| `propagator` | [`Propagator`](#propagator) | `false` | If omitted, a noop propagator is used. | No constraints. | Configure text map context propagators.
| +| `resource` | [`Resource`](#resource) | `false` | If omitted, the default resource is used. | No constraints. | Configure resource for all signals.
| +| `tracer_provider` | [`TracerProvider`](#tracerprovider) | `false` | If omitted, a noop tracer provider is used. | No constraints. | Configure tracer provider.
| +| `instrumentation/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalInstrumentation`](#experimentalinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentation.
|
Language support status @@ -1887,14 +1887,14 @@ Usages: ## OtlpGrpcExporter -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `compression` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure compression.
Values include: gzip, none. Implementations may support other compression algorithms.
If omitted or null, none is used.
| -| `endpoint` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure endpoint.
If omitted or null, http://localhost:4317 is used.
| -| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | * `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` | 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.
If omitted or null, no headers are added.
| -| `timeout` | one of:
* `integer`
* `null`
| `false` | * `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).
If omitted or null, 10000 is used.
| -| `tls` | [`GrpcTls`](#grpctls) | `false` | No constraints. | Configure TLS settings for the exporter. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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.
| +| `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, 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.
| +| `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, system default TLS settings are used. | No constraints. | Configure TLS settings for the exporter. |
Language support status @@ -1970,16 +1970,16 @@ Usages: ## OtlpGrpcMetricExporter -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `compression` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure compression.
Values include: gzip, none. Implementations may support other compression algorithms.
If omitted or null, none is used.
| -| `default_histogram_aggregation` | [`ExporterDefaultHistogramAggregation`](#exporterdefaulthistogramaggregation) | `false` | 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.
If omitted or null, explicit_bucket_histogram is used.
| -| `endpoint` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure endpoint.
If omitted or null, http://localhost:4317 is used.
| -| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | * `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` | 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.
If omitted or null, no headers are added.
| -| `temporality_preference` | [`ExporterTemporalityPreference`](#exportertemporalitypreference) | `false` | 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.
If omitted or null, cumulative is used.
| -| `timeout` | one of:
* `integer`
* `null`
| `false` | * `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).
If omitted or null, 10000 is used.
| -| `tls` | [`GrpcTls`](#grpctls) | `false` | No constraints. | Configure TLS settings for the exporter. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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_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. |
Language support status @@ -2103,15 +2103,15 @@ Usages: ## OtlpHttpExporter -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `compression` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure compression.
Values include: gzip, none. Implementations may support other compression algorithms.
If omitted or null, none is used.
| -| `encoding` | [`OtlpHttpEncoding`](#otlphttpencoding) | `false` | No constraints. | Configure the encoding used for messages.
Values include: protobuf, json. Implementations may not support json.
If omitted or null, protobuf is used.
| -| `endpoint` | one of:
* `string`
* `null`
| `false` | No constraints. | 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.
| -| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | * `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` | 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.
If omitted or null, no headers are added.
| -| `timeout` | one of:
* `integer`
* `null`
| `false` | * `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).
If omitted or null, 10000 is used.
| -| `tls` | [`HttpTls`](#httptls) | `false` | No constraints. | Configure TLS settings for the exporter. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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.
| +| `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, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used. | No constraints. | Configure endpoint, including the signal specific path.
| +| `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.
| +| `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, system default TLS settings are used. | No constraints. | Configure TLS settings for the exporter. |
Language support status @@ -2191,17 +2191,17 @@ Usages: ## OtlpHttpMetricExporter -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `compression` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure compression.
Values include: gzip, none. Implementations may support other compression algorithms.
If omitted or null, none is used.
| -| `default_histogram_aggregation` | [`ExporterDefaultHistogramAggregation`](#exporterdefaulthistogramaggregation) | `false` | 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.
If omitted or null, explicit_bucket_histogram is used.
| -| `encoding` | [`OtlpHttpEncoding`](#otlphttpencoding) | `false` | No constraints. | Configure the encoding used for messages.
Values include: protobuf, json. Implementations may not support json.
If omitted or null, protobuf is used.
| -| `endpoint` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure endpoint.
If omitted or null, http://localhost:4318/v1/metrics is used.
| -| `headers` | `array` of [`NameStringValuePair`](#namestringvaluepair) | `false` | * `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` | 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.
If omitted or null, no headers are added.
| -| `temporality_preference` | [`ExporterTemporalityPreference`](#exportertemporalitypreference) | `false` | 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.
If omitted or null, cumulative is used.
| -| `timeout` | one of:
* `integer`
* `null`
| `false` | * `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).
If omitted or null, 10000 is used.
| -| `tls` | [`HttpTls`](#httptls) | `false` | No constraints. | Configure TLS settings for the exporter. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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.
| +| `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_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. |
Language support status @@ -2288,13 +2288,13 @@ Usages: ## ParentBasedSampler -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `local_parent_not_sampled` | [`Sampler`](#sampler) | `false` | No constraints. | Configure local_parent_not_sampled sampler.
If omitted or null, always_off is used.
| -| `local_parent_sampled` | [`Sampler`](#sampler) | `false` | No constraints. | Configure local_parent_sampled sampler.
If omitted or null, always_on is used.
| -| `remote_parent_not_sampled` | [`Sampler`](#sampler) | `false` | No constraints. | Configure remote_parent_not_sampled sampler.
If omitted or null, always_off is used.
| -| `remote_parent_sampled` | [`Sampler`](#sampler) | `false` | No constraints. | Configure remote_parent_sampled sampler.
If omitted or null, always_on is used.
| -| `root` | [`Sampler`](#sampler) | `false` | No constraints. | Configure root sampler.
If omitted or null, always_on is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `local_parent_not_sampled` | [`Sampler`](#sampler) | `false` | If omitted, always_off is used. | No constraints. | Configure local_parent_not_sampled sampler.
| +| `local_parent_sampled` | [`Sampler`](#sampler) | `false` | If omitted, always_on is used. | No constraints. | Configure local_parent_sampled sampler.
| +| `remote_parent_not_sampled` | [`Sampler`](#sampler) | `false` | If omitted, always_off is used. | No constraints. | Configure remote_parent_not_sampled sampler.
| +| `remote_parent_sampled` | [`Sampler`](#sampler) | `false` | If omitted, always_on is used. | No constraints. | Configure remote_parent_sampled sampler.
| +| `root` | [`Sampler`](#sampler) | `false` | If omitted, always_on is used. | No constraints. | Configure root sampler.
|
Language support status @@ -2348,13 +2348,13 @@ Usages: ## PeriodicMetricReader -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | No constraints. | Configure cardinality limits. | -| `exporter` | [`PushMetricExporter`](#pushmetricexporter) | `true` | No constraints. | Configure exporter. | -| `interval` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure delay interval (in milliseconds) between start of two consecutive exports.
Value must be non-negative.
If omitted or null, 60000 is used.
| -| `producers` | `array` of [`MetricProducer`](#metricproducer) | `false` | * `minItems`: `1`
| Configure metric producers. | -| `timeout` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| 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.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | If omitted, TODO. | 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. | +| `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).
|
Language support status @@ -2421,10 +2421,10 @@ Usages: ## Propagator -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `composite` | `array` of [`TextMapPropagator`](#textmappropagator) | `false` | * `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` | 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.
| +| 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.
|
Language support status @@ -2472,9 +2472,9 @@ Usages: `PullMetricExporter` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `prometheus/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | `false` | No constraints. | Configure exporter to be prometheus.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `prometheus/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be prometheus.
|
Language support status @@ -2518,11 +2518,11 @@ Usages: ## PullMetricReader -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | No constraints. | Configure cardinality limits. | -| `exporter` | [`PullMetricExporter`](#pullmetricexporter) | `true` | No constraints. | Configure exporter. | -| `producers` | `array` of [`MetricProducer`](#metricproducer) | `false` | * `minItems`: `1`
| Configure metric producers. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `cardinality_limits` | [`CardinalityLimits`](#cardinalitylimits) | `false` | If omitted, TODO. | 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. |
Language support status @@ -2575,12 +2575,12 @@ Usages: `PushMetricExporter` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `console` | [`ConsoleMetricExporter`](#consolemetricexporter) | `false` | No constraints. | Configure exporter to be console.
| -| `otlp_grpc` | [`OtlpGrpcMetricExporter`](#otlpgrpcmetricexporter) | `false` | No constraints. | Configure exporter to be OTLP with gRPC transport.
| -| `otlp_http` | [`OtlpHttpMetricExporter`](#otlphttpmetricexporter) | `false` | 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` | No constraints. | Configure exporter to be OTLP with file transport.
| +| 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.
| +| `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileMetricExporter`](#experimentalotlpfilemetricexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with file transport.
|
Language support status @@ -2636,12 +2636,12 @@ Usages: ## Resource -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `attributes` | `array` of [`AttributeNameValue`](#attributenamevalue) | `false` | * `minItems`: `1`
| Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.
| -| `attributes_list` | one of:
* `string`
* `null`
| `false` | 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.
If omitted or null, no resource attributes are added.
| -| `schema_url` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure resource schema URL.
If omitted or null, no schema URL is used.
| -| `detection/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalResourceDetection`](#experimentalresourcedetection) | `false` | No constraints. | Configure resource detection.
If omitted or null, resource detection is disabled.
| +| 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_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.
|
Language support status @@ -2700,15 +2700,15 @@ Usages: `Sampler` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `always_off` | [`AlwaysOffSampler`](#alwaysoffsampler) | `false` | No constraints. | Configure sampler to be always_off. | -| `always_on` | [`AlwaysOnSampler`](#alwaysonsampler) | `false` | No constraints. | Configure sampler to be always_on. | -| `parent_based` | [`ParentBasedSampler`](#parentbasedsampler) | `false` | No constraints. | Configure sampler to be parent_based. | -| `trace_id_ratio_based` | [`TraceIdRatioBasedSampler`](#traceidratiobasedsampler) | `false` | No constraints. | Configure sampler to be trace_id_ratio_based. | -| `composite/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configure sampler to be composite. | -| `jaeger_remote/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalJaegerRemoteSampler`](#experimentaljaegerremotesampler) | `false` | No constraints. | TODO | -| `probability/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | `false` | No constraints. | Configure sampler to be probability. | +| 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. | +| `composite/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be composite. | +| `jaeger_remote/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalJaegerRemoteSampler`](#experimentaljaegerremotesampler) | `false` | If omitted, TODO. | No constraints. | TODO | +| `probability/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be probability. |
Language support status @@ -2782,9 +2782,9 @@ Usages: ## SimpleLogRecordProcessor -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `exporter` | [`LogRecordExporter`](#logrecordexporter) | `true` | No constraints. | Configure exporter. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `exporter` | [`LogRecordExporter`](#logrecordexporter) | `true` | Property is required and must be non-null. | No constraints. | Configure exporter. |
Language support status @@ -2823,9 +2823,9 @@ Usages: ## SimpleSpanProcessor -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `exporter` | [`SpanExporter`](#spanexporter) | `true` | No constraints. | Configure exporter. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `exporter` | [`SpanExporter`](#spanexporter) | `true` | Property is required and must be non-null. | No constraints. | Configure exporter. |
Language support status @@ -2866,13 +2866,13 @@ Usages: `SpanExporter` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `console` | [`ConsoleExporter`](#consoleexporter) | `false` | No constraints. | Configure exporter to be console. | -| `otlp_grpc` | [`OtlpGrpcExporter`](#otlpgrpcexporter) | `false` | No constraints. | Configure exporter to be OTLP with gRPC transport. | -| `otlp_http` | [`OtlpHttpExporter`](#otlphttpexporter) | `false` | No constraints. | Configure exporter to be OTLP with HTTP transport. | -| `zipkin` | [`ZipkinSpanExporter`](#zipkinspanexporter) | `false` | No constraints. | Configure exporter to be zipkin. | -| `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileExporter`](#experimentalotlpfileexporter) | `false` | No constraints. | Configure exporter to be OTLP with file transport.
| +| 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. | +| `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileExporter`](#experimentalotlpfileexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with file transport.
|
Language support status @@ -2933,14 +2933,14 @@ Usages: ## SpanLimits -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max attribute count. Overrides .attribute_limits.attribute_count_limit.
Value must be non-negative.
If omitted or null, 128 is used.
| -| `attribute_value_length_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| 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.
| -| `event_attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max attributes per span event.
Value must be non-negative.
If omitted or null, 128 is used.
| -| `event_count_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max span event count.
Value must be non-negative.
If omitted or null, 128 is used.
| -| `link_attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max attributes per span link.
Value must be non-negative.
If omitted or null, 128 is used.
| -| `link_count_limit` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max span link count.
Value must be non-negative.
If omitted or null, 128 is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 128 is used. | * `minimum`: `0`
| Configure max attribute count. Overrides .attribute_limits.attribute_count_limit.
Value must be non-negative.
| +| `attribute_value_length_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, there is no limit. | * `minimum`: `0`
| Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit.
Value must be non-negative.
| +| `event_attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 128 is used. | * `minimum`: `0`
| Configure max attributes per span event.
Value must be non-negative.
| +| `event_count_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 128 is used. | * `minimum`: `0`
| Configure max span event count.
Value must be non-negative.
| +| `link_attribute_count_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 128 is used. | * `minimum`: `0`
| Configure max attributes per span link.
Value must be non-negative.
| +| `link_count_limit` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 128 is used. | * `minimum`: `0`
| Configure max span link count.
Value must be non-negative.
|
Language support status @@ -3021,10 +3021,10 @@ Usages: `SpanProcessor` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `batch` | [`BatchSpanProcessor`](#batchspanprocessor) | `false` | No constraints. | Configure a batch span processor. | -| `simple` | [`SimpleSpanProcessor`](#simplespanprocessor) | `false` | No constraints. | Configure a simple span processor. | +| 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. |
Language support status @@ -3099,14 +3099,14 @@ Usages: `TextMapPropagator` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `b3` | [`B3Propagator`](#b3propagator) | `false` | No constraints. | Include the zipkin b3 propagator. | -| `b3multi` | [`B3MultiPropagator`](#b3multipropagator) | `false` | No constraints. | Include the zipkin b3 multi propagator. | -| `baggage` | [`BaggagePropagator`](#baggagepropagator) | `false` | No constraints. | Include the w3c baggage propagator. | -| `jaeger` | [`JaegerPropagator`](#jaegerpropagator) | `false` | No constraints. | Include the jaeger propagator. | -| `ottrace` | [`OpenTracingPropagator`](#opentracingpropagator) | `false` | No constraints. | Include the opentracing propagator. | -| `tracecontext` | [`TraceContextPropagator`](#tracecontextpropagator) | `false` | No constraints. | Include the w3c trace context propagator. | +| 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. |
Language support status @@ -3195,9 +3195,9 @@ Usages: ## TraceIdRatioBasedSampler -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `ratio` | one of:
* `number`
* `null`
| `false` | * `minimum`: `0`
* `maximum`: `1`
| Configure trace_id_ratio.
If omitted or null, 1.0 is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `ratio` | one of:
* `number`
* `null`
| `false` | If omitted or null, 1.0 is used. | * `minimum`: `0`
* `maximum`: `1`
| Configure trace_id_ratio.
|
Language support status @@ -3240,12 +3240,12 @@ Usages: ## TracerProvider -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `limits` | [`SpanLimits`](#spanlimits) | `false` | No constraints. | Configure span limits. See also attribute_limits. | -| `processors` | `array` of [`SpanProcessor`](#spanprocessor) | `true` | * `minItems`: `1`
| Configure span processors. | -| `sampler` | [`Sampler`](#sampler) | `false` | No constraints. | Configure the sampler.
If omitted, parent based sampler with a root of always_on is used.
| -| `tracer_configurator/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalTracerConfigurator`](#experimentaltracerconfigurator) | `false` | No constraints. | Configure tracers.
| +| 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. | +| `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, TODO. | No constraints. | Configure tracers.
|
Language support status @@ -3300,10 +3300,10 @@ Usages: ## View -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `selector` | [`ViewSelector`](#viewselector) | `true` | No constraints. | Configure view selector.
Selection criteria is additive as described in https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#instrument-selection-criteria.
| -| `stream` | [`ViewStream`](#viewstream) | `true` | No constraints. | Configure view stream. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `selector` | [`ViewSelector`](#viewselector) | `true` | Property is required and must be non-null. | No constraints. | Configure view selector.
Selection criteria is additive as described in https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#instrument-selection-criteria.
| +| `stream` | [`ViewStream`](#viewstream) | `true` | Property is required and must be non-null. | No constraints. | Configure view stream. |
Language support status @@ -3347,14 +3347,14 @@ Usages: ## ViewSelector -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `instrument_name` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure instrument name selection criteria.
If omitted or null, all instrument names match.
| -| `instrument_type` | [`InstrumentType`](#instrumenttype) | `false` | No constraints. | Configure instrument type selection criteria.
Values include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter.
If omitted or null, all instrument types match.
| -| `meter_name` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure meter name selection criteria.
If omitted or null, all meter names match.
| -| `meter_schema_url` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure meter schema url selection criteria.
If omitted or null, all meter schema URLs match.
| -| `meter_version` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure meter version selection criteria.
If omitted or null, all meter versions match.
| -| `unit` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure the instrument unit selection criteria.
If omitted or null, all instrument units match.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `instrument_name` | one of:
* `string`
* `null`
| `false` | If omitted or null, all instrument names match. | No constraints. | Configure instrument name selection criteria.
| +| `instrument_type` | [`InstrumentType`](#instrumenttype) | `false` | If omitted, all instrument types match. | No constraints. | Configure instrument type selection criteria.
Values include: counter, gauge, histogram, observable_counter, observable_gauge, observable_up_down_counter, up_down_counter.
| +| `meter_name` | one of:
* `string`
* `null`
| `false` | If omitted or null, all meter names match. | No constraints. | Configure meter name selection criteria.
| +| `meter_schema_url` | one of:
* `string`
* `null`
| `false` | If omitted or null, all meter schema URLs match. | No constraints. | Configure meter schema url selection criteria.
| +| `meter_version` | one of:
* `string`
* `null`
| `false` | If omitted or null, all meter versions match. | No constraints. | Configure meter version selection criteria.
| +| `unit` | one of:
* `string`
* `null`
| `false` | If omitted or null, all instrument units match. | No constraints. | Configure the instrument unit selection criteria.
|
Language support status @@ -3424,13 +3424,13 @@ Usages: ## ViewStream -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `aggregation` | [`Aggregation`](#aggregation) | `false` | 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.
If omitted, default is used.
| -| `aggregation_cardinality_limit` | one of:
* `integer`
* `null`
| `false` | * `exclusiveMinimum`: `0`
| Configure the aggregation cardinality limit.
If omitted or null, the metric reader's default cardinality limit is used.
| -| `attribute_keys` | [`IncludeExclude`](#includeexclude) | `false` | No constraints. | Configure attribute keys retained in the resulting stream(s).
| -| `description` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure metric description of the resulting stream(s).
If omitted or null, the instrument's origin description is used.
| -| `name` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure metric name of the resulting stream(s).
If omitted or null, the instrument's original name is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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).
| +| `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).
|
Language support status @@ -3491,10 +3491,10 @@ Usages: ## ZipkinSpanExporter -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `endpoint` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure endpoint.
If omitted or null, http://localhost:9411/api/v2/spans is used.
| -| `timeout` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| Configure max time (in milliseconds) to wait for each export.
Value must be non-negative. A value of 0 indicates indefinite.
If omitted or null, 10000 is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `endpoint` | one of:
* `string`
* `null`
| `false` | If omitted or null, http://localhost:9411/api/v2/spans is used. | No constraints. | Configure endpoint.
| +| `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 indefinite.
|
Language support status @@ -3604,13 +3604,13 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `local_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a local parent that is not sampled. | -| `local_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a local parent that is sampled. | -| `remote_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a remote parent that is not sampled. | -| `remote_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a remote parent that is sampled. | -| `root` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with no parent. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `local_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a local parent that is not sampled. | +| `local_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a local parent that is sampled. | +| `remote_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a remote parent that is not sampled. | +| `remote_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a remote parent that is sampled. | +| `root` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with no parent. |
Language support status @@ -3667,9 +3667,9 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `ratio` | one of:
* `number`
* `null`
| `false` | * `minimum`: `0`
* `maximum`: `1`
| Configure ratio.
If omitted or null, 1.0 is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `ratio` | one of:
* `number`
* `null`
| `false` | If omitted or null, 1.0 is used. | * `minimum`: `0`
* `maximum`: `1`
| Configure ratio.
|
Language support status @@ -3715,12 +3715,12 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `always_off` | [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | `false` | No constraints. | Configure sampler to be always_off. | -| `always_on` | [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | `false` | No constraints. | Configure sampler to be always_on. | -| `parent_based` | [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | `false` | No constraints. | Configure sampler to be parent_based. | -| `probability` | [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | `false` | No constraints. | Configure sampler to be probability. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `always_off` | [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be always_off. | +| `always_on` | [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be always_on. | +| `parent_based` | [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be parent_based. | +| `probability` | [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be probability. |
Language support status @@ -3812,10 +3812,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `http` | [`ExperimentalHttpInstrumentation`](#experimentalhttpinstrumentation) | `false` | No constraints. | Configure instrumentations following the http semantic conventions.
See http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/
| -| `peer` | [`ExperimentalPeerInstrumentation`](#experimentalpeerinstrumentation) | `false` | No constraints. | Configure instrumentations following the peer semantic conventions.
See peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `http` | [`ExperimentalHttpInstrumentation`](#experimentalhttpinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the http semantic conventions.
See http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/
| +| `peer` | [`ExperimentalPeerInstrumentation`](#experimentalpeerinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the peer semantic conventions.
See peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/
|
Language support status @@ -3885,10 +3885,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `request_captured_headers` | `array` of `string` | `false` | * `minItems`: `1`
| Configure headers to capture for outbound http requests.
| -| `response_captured_headers` | `array` of `string` | `false` | No constraints. | Configure headers to capture for inbound http responses.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `request_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers to capture for outbound http requests.
| +| `response_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | No constraints. | Configure headers to capture for inbound http responses.
|
Language support status @@ -3937,10 +3937,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `client` | [`ExperimentalHttpClientInstrumentation`](#experimentalhttpclientinstrumentation) | `false` | No constraints. | Configure instrumentations following the http client semantic conventions. | -| `server` | [`ExperimentalHttpServerInstrumentation`](#experimentalhttpserverinstrumentation) | `false` | No constraints. | Configure instrumentations following the http server semantic conventions. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `client` | [`ExperimentalHttpClientInstrumentation`](#experimentalhttpclientinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the http client semantic conventions. | +| `server` | [`ExperimentalHttpServerInstrumentation`](#experimentalhttpserverinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the http server semantic conventions. |
Language support status @@ -3982,10 +3982,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `request_captured_headers` | `array` of `string` | `false` | * `minItems`: `1`
| Configure headers to capture for inbound http requests.
| -| `response_captured_headers` | `array` of `string` | `false` | * `minItems`: `1`
| Configure headers to capture for outbound http responses.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `request_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers to capture for inbound http requests.
| +| `response_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers to capture for outbound http responses.
|
Language support status @@ -4035,20 +4035,20 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `cpp` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure C++ language-specific instrumentation libraries. | -| `dotnet` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure .NET language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `erlang` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure Erlang language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `general` | [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | `false` | No constraints. | Configure general SemConv options that may apply to multiple languages and instrumentations.
Instrumenation may merge general config options with the language specific configuration at .instrumentation..
| -| `go` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure Go language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `java` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure Java language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `js` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure JavaScript language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `php` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure PHP language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `python` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure Python language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `ruby` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure Ruby language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `rust` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure Rust language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `swift` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | No constraints. | Configure Swift language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `cpp` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure C++ language-specific instrumentation libraries. | +| `dotnet` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure .NET language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `erlang` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Erlang language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `general` | [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure general SemConv options that may apply to multiple languages and instrumentations.
Instrumenation may merge general config options with the language specific configuration at .instrumentation..
| +| `go` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Go language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `java` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Java language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `js` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure JavaScript language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `php` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure PHP language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `python` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Python language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `ruby` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Ruby language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `rust` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Rust language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `swift` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Swift language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
|
Language support status @@ -4130,11 +4130,11 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `endpoint` | one of:
* `string`
* `null`
| `false` | No constraints. | TODO | -| `initial_sampler` | [`Sampler`](#sampler) | `false` | No constraints. | TODO | -| `interval` | one of:
* `integer`
* `null`
| `false` | * `minimum`: `0`
| TODO | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `endpoint` | one of:
* `string`
* `null`
| `false` | If omitted or null, TODO. | No constraints. | TODO | +| `initial_sampler` | [`Sampler`](#sampler) | `false` | If omitted, TODO. | No constraints. | TODO | +| `interval` | one of:
* `integer`
* `null`
| `false` | If omitted or null, TODO. | * `minimum`: `0`
| TODO |
Language support status @@ -4227,11 +4227,11 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `disabled` | one of:
* `boolean`
* `null`
| `false` | No constraints. | Configure if the logger is enabled or not.
If omitted or null, false is used.
| -| `minimum_severity` | [`ExperimentalSeverityNumber`](#experimentalseveritynumber) | `false` | No constraints. | Configure severity filtering.
Log records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed.
Values include: TRACE, TRACE2, TRACE3, TRACE4, DEBUG, DEBUG2, DEBUG3, DEBUG4, INFO, INFO2, INFO3, INFO4, WARN, WARN2, WARN3, WARN4, ERROR, ERROR2, ERROR3, ERROR4, FATAL, FATAL2, FATAL3, FATAL4.
If omitted or null, severity filtering is not applied.
| -| `trace_based` | one of:
* `boolean`
* `null`
| `false` | No constraints. | 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.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `disabled` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, false is used. | No constraints. | Configure if the logger is enabled or not.
| +| `minimum_severity` | [`ExperimentalSeverityNumber`](#experimentalseveritynumber) | `false` | If omitted, severity filtering is not applied. | No constraints. | Configure severity filtering.
Log records with an non-zero (i.e. unspecified) severity number which is less than minimum_severity are not processed.
Values include: 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` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, trace based filtering is not applied. | No constraints. | 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.
|
Language support status @@ -4286,10 +4286,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `default_config` | [`ExperimentalLoggerConfig`](#experimentalloggerconfig) | `false` | No constraints. | Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers. | -| `loggers` | `array` of [`ExperimentalLoggerMatcherAndConfig`](#experimentalloggermatcherandconfig) | `false` | * `minItems`: `1`
| Configure loggers. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `default_config` | [`ExperimentalLoggerConfig`](#experimentalloggerconfig) | `false` | If omitted, TODO. | No constraints. | Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers. | +| `loggers` | `array` of [`ExperimentalLoggerMatcherAndConfig`](#experimentalloggermatcherandconfig) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure loggers. |
Language support status @@ -4337,10 +4337,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `config` | [`ExperimentalLoggerConfig`](#experimentalloggerconfig) | `true` | No constraints. | The logger config. | -| `name` | `string` | `true` | No constraints. | 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 | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `config` | [`ExperimentalLoggerConfig`](#experimentalloggerconfig) | `true` | Property is required and must be non-null. | No constraints. | The logger config. | +| `name` | `string` | `true` | Property is required and must be non-null. | No constraints. | 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.
|
Language support status @@ -4391,9 +4391,9 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `disabled` | `boolean` | `false` | No constraints. | Configure if the meter is enabled or not. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `disabled` | `boolean` | `false` | If omitted, TODO. | No constraints. | Configure if the meter is enabled or not. |
Language support status @@ -4436,10 +4436,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `default_config` | [`ExperimentalMeterConfig`](#experimentalmeterconfig) | `false` | No constraints. | Configure the default meter config used there is no matching entry in .meter_configurator/development.meters. | -| `meters` | `array` of [`ExperimentalMeterMatcherAndConfig`](#experimentalmetermatcherandconfig) | `false` | * `minItems`: `1`
| Configure meters. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `default_config` | [`ExperimentalMeterConfig`](#experimentalmeterconfig) | `false` | If omitted, TODO. | No constraints. | Configure the default meter config used there is no matching entry in .meter_configurator/development.meters. | +| `meters` | `array` of [`ExperimentalMeterMatcherAndConfig`](#experimentalmetermatcherandconfig) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure meters. |
Language support status @@ -4487,10 +4487,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `config` | [`ExperimentalMeterConfig`](#experimentalmeterconfig) | `true` | No constraints. | The meter config. | -| `name` | `string` | `true` | No constraints. | 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 | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `config` | [`ExperimentalMeterConfig`](#experimentalmeterconfig) | `true` | Property is required and must be non-null. | No constraints. | The meter config. | +| `name` | `string` | `true` | Property is required and must be non-null. | No constraints. | 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.
|
Language support status @@ -4541,9 +4541,9 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `output_stream` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure output stream.
Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.
If omitted or null, stdout is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `output_stream` | one of:
* `string`
* `null`
| `false` | If omitted or null, stdout is used. | No constraints. | Configure output stream.
Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.
|
Language support status @@ -4588,11 +4588,11 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `default_histogram_aggregation` | [`ExporterDefaultHistogramAggregation`](#exporterdefaulthistogramaggregation) | `false` | 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.
If omitted or null, explicit_bucket_histogram is used.
| -| `output_stream` | one of:
* `string`
* `null`
| `false` | No constraints. | 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` | [`ExporterTemporalityPreference`](#exportertemporalitypreference) | `false` | 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.
If omitted or null, cumulative is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `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.
| +| `output_stream` | one of:
* `string`
* `null`
| `false` | If omitted or null, stdout is used. | No constraints. | Configure output stream.
Values include stdout, or scheme+destination. For example: file:///path/to/file.jsonl.
| +| `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.
|
Language support status @@ -4644,9 +4644,9 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `service_mapping` | `array` of [`ExperimentalPeerServiceMapping`](#experimentalpeerservicemapping) | `false` | * `minItems`: `1`
| Configure the service mapping for instrumentations following peer.service semantic conventions.
See peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `service_mapping` | `array` of [`ExperimentalPeerServiceMapping`](#experimentalpeerservicemapping) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure the service mapping for instrumentations following peer.service semantic conventions.
See peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes
|
Language support status @@ -4688,10 +4688,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `peer` | `string` | `true` | No constraints. | The IP address to map.
| -| `service` | `string` | `true` | No constraints. | The logical name corresponding to the IP address of .peer.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `peer` | `string` | `true` | Property is required and must be non-null. | No constraints. | The IP address to map.
| +| `service` | `string` | `true` | Property is required and must be non-null. | No constraints. | The logical name corresponding to the IP address of .peer.
|
Language support status @@ -4738,9 +4738,9 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `ratio` | one of:
* `number`
* `null`
| `false` | * `minimum`: `0`
* `maximum`: `1`
| Configure ratio.
If omitted or null, 1.0 is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `ratio` | one of:
* `number`
* `null`
| `false` | If omitted or null, 1.0 is used. | * `minimum`: `0`
* `maximum`: `1`
| Configure ratio.
|
Language support status @@ -4814,14 +4814,14 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `host` | one of:
* `string`
* `null`
| `false` | No constraints. | Configure host.
If omitted or null, localhost is used.
| -| `port` | one of:
* `integer`
* `null`
| `false` | No constraints. | Configure port.
If omitted or null, 9464 is used.
| -| `translation_strategy` | [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | `false` | No constraints. | Configure how Prometheus metrics are exposed. Values include:

* UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.
* UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.
* NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.
* NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.

If omitted or null, UnderscoreEscapingWithSuffixes is used.
| -| `with_resource_constant_labels` | [`IncludeExclude`](#includeexclude) | `false` | No constraints. | Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns. | -| `without_scope_info` | one of:
* `boolean`
* `null`
| `false` | No constraints. | Configure Prometheus Exporter to produce metrics without a scope info metric.
If omitted or null, false is used.
| -| `without_target_info` | one of:
* `boolean`
* `null`
| `false` | No constraints. | Configure Prometheus Exporter to produce metrics without a target info metric for the resource.
If omitted or null, false is used.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `host` | one of:
* `string`
* `null`
| `false` | If omitted or null, localhost is used. | No constraints. | Configure host.
| +| `port` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 9464 is used. | No constraints. | Configure port.
| +| `translation_strategy` | [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | `false` | If omitted, UnderscoreEscapingWithSuffixes is used. | No constraints. | Configure how Prometheus metrics are exposed. Values include:

* UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.
* UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.
* NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.
* NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.
| +| `with_resource_constant_labels` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, TODO. | No constraints. | Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns. | +| `without_scope_info` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, false is used. | No constraints. | Configure Prometheus Exporter to produce metrics without a scope info metric.
| +| `without_target_info` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, false is used. | No constraints. | Configure Prometheus Exporter to produce metrics without a target info metric for the resource.
|
Language support status @@ -4943,10 +4943,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `attributes` | [`IncludeExclude`](#includeexclude) | `false` | No constraints. | Configure attributes provided by resource detectors. | -| `detectors` | `array` of [`ExperimentalResourceDetector`](#experimentalresourcedetector) | `false` | * `minItems`: `1`
| Configure resource detectors.
Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language.
If omitted or null, no resource detectors are enabled.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `attributes` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, TODO. | No constraints. | Configure attributes provided by resource detectors. | +| `detectors` | `array` of [`ExperimentalResourceDetector`](#experimentalresourcedetector) | `false` | If omitted, no resource detectors are enabled. | * `minItems`: `1`
| Configure resource detectors.
Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language.
|
Language support status @@ -4994,12 +4994,12 @@ Usages: `ExperimentalResourceDetector` is an [SDK extension plugin](#sdk-extension-plugins). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `container` | [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | `false` | No constraints. | Enable the container resource detector, which populates container.* attributes.
| -| `host` | [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | `false` | No constraints. | Enable the host resource detector, which populates host.* and os.* attributes.
| -| `process` | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | `false` | No constraints. | Enable the process resource detector, which populates process.* attributes.
| -| `service` | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | `false` | No constraints. | Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.
| +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `container` | [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the container resource detector, which populates container.* attributes.
| +| `host` | [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the host resource detector, which populates host.* and os.* attributes.
| +| `process` | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the process resource detector, which populates process.* attributes.
| +| `service` | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.
|
Language support status @@ -5195,9 +5195,9 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `disabled` | `boolean` | `false` | No constraints. | Configure if the tracer is enabled or not. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `disabled` | `boolean` | `false` | If omitted, TODO. | No constraints. | Configure if the tracer is enabled or not. |
Language support status @@ -5240,10 +5240,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `default_config` | [`ExperimentalTracerConfig`](#experimentaltracerconfig) | `false` | No constraints. | Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers. | -| `tracers` | `array` of [`ExperimentalTracerMatcherAndConfig`](#experimentaltracermatcherandconfig) | `false` | * `minItems`: `1`
| Configure tracers. | +| Property | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `default_config` | [`ExperimentalTracerConfig`](#experimentaltracerconfig) | `false` | If omitted, TODO. | No constraints. | Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers. | +| `tracers` | `array` of [`ExperimentalTracerMatcherAndConfig`](#experimentaltracermatcherandconfig) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure tracers. |
Language support status @@ -5291,10 +5291,10 @@ Usages: > [!WARNING] > This type is [experimental](README.md#experimental-features). -| Property | Type | Required? | Constraints | Description | -|---|---|---|---|---| -| `config` | [`ExperimentalTracerConfig`](#experimentaltracerconfig) | `true` | No constraints. | The tracer config. | -| `name` | `string` | `true` | No constraints. | 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 | Type | Required? | Default and Null Behavior | Constraints | Description | +|---|---|---|---|---|---| +| `config` | [`ExperimentalTracerConfig`](#experimentaltracerconfig) | `true` | Property is required and must be non-null. | No constraints. | The tracer config. | +| `name` | `string` | `true` | Property is required and must be non-null. | No constraints. | 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.
|
Language support status diff --git a/schema/common.yaml b/schema/common.yaml index e55f3c72..746877d9 100644 --- a/schema/common.yaml +++ b/schema/common.yaml @@ -37,6 +37,7 @@ $defs: - string - "null" description: The value of the pair. + nullBehavior: TODO required: - name - value diff --git a/scripts/compile-schema.js b/scripts/compile-schema.js index 7f3285ea..238a61ee 100644 --- a/scripts/compile-schema.js +++ b/scripts/compile-schema.js @@ -27,14 +27,14 @@ sourceTypes.sort((a, b) => a.type.localeCompare(b.type)); const defs = {}; sourceTypes.filter(sourceSchemaType => sourceSchemaType.type !== rootTypeName) .forEach(sourceSchemaType => { - defs[sourceSchemaType.type] = prepareSchemaForOutput(sourceSchemaType.schema); + defs[sourceSchemaType.type] = prepareSchemaForOutput(sourceSchemaType); }); const rootType = sourceTypes.find(sourceSchemaType => sourceSchemaType.type === rootTypeName); if (!rootType) { throw new Error(`Root type ${rootTypeName} not found in source schema.`); } -const rootTypeSchema = prepareSchemaForOutput(rootType.schema); +const rootTypeSchema = prepareSchemaForOutput(rootType); const output = { "$id": "https://opentelemetry.io/otelconfig/opentelemetry_configuration.json", @@ -47,14 +47,16 @@ fs.writeFileSync(schemaPath, JSON.stringify(output, null, 2)); // Helper functions -function prepareSchemaForOutput(schema) { - const copy = JSON.parse(JSON.stringify(schema)); +function prepareSchemaForOutput(sourceSchemaType) { + const schema = JSON.parse(JSON.stringify(sourceSchemaType.schema)); - delete copy['$defs']; + delete schema['$defs']; - stripMetadata(copy); - replaceCrossFileRefs(copy); - return copy; + stripMetadata(schema); + replaceCrossFileRefs(schema); + enrichDescriptions(sourceSchemaType, schema); + + return schema; } function stripMetadata(schema) { @@ -67,6 +69,7 @@ function stripMetadata(schema) { } Object.values(properties).forEach(propertySchema => { delete propertySchema['defaultBehavior']; + delete propertySchema['nullBehavior']; }); } @@ -90,6 +93,25 @@ function replaceCrossFileRefs(schema) { }); } +function enrichDescriptions(sourceSchemaType, schema) { + const properties = schema.properties; + if (!properties) { + return; + } + Object.entries(properties).forEach(([propertyKey, propertySchema]) => { + const sourceProperty = sourceSchemaType.properties.find(property => property.property === propertyKey); + let description = propertySchema['description']; + if (!description.endsWith('\n')) { + description += '\n'; + } + description += sourceProperty.formatDefaultAndNullBehavior(); + if (!description.endsWith('\n')) { + description += '\n'; + } + propertySchema['description'] = description; + }); +} + // Validation functions function allPropertiesShouldHaveDescriptions(sourceSchemaType, messages) { @@ -164,18 +186,23 @@ function optionalPropertiesHaveDefaultBehavior(sourceSchemaType, messages) { return; } const required = sourceSchemaType.schema['required'] || []; + // Checks for optional properties sourceSchemaType.properties .filter(property => !required.includes(property.property) && !property.schema['defaultBehavior']) .forEach(property => { messages.push(`Please add 'defaultBehavior' to optional property ${sourceSchemaType.type}.${property.property}.`); }); + // Checks for required properties sourceSchemaType.properties .filter(property => required.includes(property.property)) .forEach(property => { if (property.schema['defaultBehavior']) { messages.push(`Please remove 'defaultBehavior' from required property ${sourceSchemaType.type}.${property.property}.`); } - if (property.schema['nullBehavior']) { + if (property.isNullable && !property.schema['nullBehavior']) { + messages.push(`Please add 'nullBehavior' to required nullable property ${sourceSchemaType.type}.${property.property}.`); + } + if (!property.isNullable && property.schema['nullBehavior']) { messages.push(`Please remove 'nullBehavior' from required property ${sourceSchemaType.type}.${property.property}.`); } }); diff --git a/scripts/generate-markdown.js b/scripts/generate-markdown.js index a4cd365c..218b1189 100644 --- a/scripts/generate-markdown.js +++ b/scripts/generate-markdown.js @@ -87,8 +87,8 @@ function writeType(sourceSchemaType) { output.push("No properties.\n\n"); } else { // Property type and description table - output.push(`| Property | Type | Required? | Constraints | Description |\n`); - output.push("|---|---|---|---|---|\n"); + output.push(`| Property | Type | Required? | Default and Null Behavior | Constraints | Description |\n`); + output.push("|---|---|---|---|---|---|\n"); properties.forEach(sourceSchemaProperty => { let formattedProperty = `\`${sourceSchemaProperty.property}\`` if (isExperimentalProperty(sourceSchemaProperty.property)) { @@ -96,13 +96,14 @@ function writeType(sourceSchemaType) { } const formattedPropertyType = formatPropertyType(sourceSchemaProperty, sourceTypesByType); const isRequired = required !== undefined && required.includes(sourceSchemaProperty.property); + const formattedDefaultAndNullBehavior = sourceSchemaProperty.formatDefaultAndNullBehavior(); let formattedConstraints = resolveAndFormatConstraints(sourceSchemaProperty.schema, '
'); if (formattedConstraints.length === 0) { formattedConstraints = 'No constraints.'; } const formattedDescription = sourceSchemaProperty.schema.description.split("\n").join("
"); - output.push(`| ${formattedProperty} | ${formattedPropertyType} | \`${isRequired}\` | ${formattedConstraints} | ${formattedDescription} |\n`); + output.push(`| ${formattedProperty} | ${formattedPropertyType} | \`${isRequired}\` | ${formattedDefaultAndNullBehavior} | ${formattedConstraints} | ${formattedDescription} |\n`); }); output.push('\n'); } diff --git a/scripts/source-schema.js b/scripts/source-schema.js index 9264fd0b..2586f6cf 100644 --- a/scripts/source-schema.js +++ b/scripts/source-schema.js @@ -142,6 +142,7 @@ export class SourceSchemaProperty { types; isSeq; isRequired; + isNullable; schema; constructor(property, types, isSeq, isRequired, schema) { @@ -149,8 +150,28 @@ export class SourceSchemaProperty { this.types = types; this.isSeq = isSeq; this.isRequired = isRequired; + this.isNullable = types.includes('null'); this.schema = schema; } + + formatDefaultAndNullBehavior() { + const defaultBehavior = this.schema['defaultBehavior']; + const nullBehavior = this.schema['nullBehavior']; + + if (this.isRequired) { + if (!this.isNullable) { + return 'Property is required and must be non-null.'; + } + return `Property must be present, but if null ${nullBehavior}.`; + } + if (!nullBehavior) { + if (this.isNullable) { + return `If omitted or null, ${defaultBehavior}.`; + } + return `If omitted, ${defaultBehavior}.`; + } + return `If omitted, ${defaultBehavior}. If present and null, ${nullBehavior}.`; + } } export class SourceSchemaType { From 140e3cdddcf718bba933d4f9b30c78850d4487f7 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Wed, 26 Nov 2025 17:07:14 -0600 Subject: [PATCH 5/5] Add all missing default behaviors --- opentelemetry_configuration.json | 230 +++++++++++------------ schema-docs.md | 231 ++++++++++++------------ schema/instrumentation.yaml | 43 ++--- schema/logger_provider.yaml | 20 +- schema/meter_provider.yaml | 90 +++++---- schema/opentelemetry_configuration.yaml | 4 +- schema/propagator.yaml | 18 +- schema/resource.yaml | 12 +- schema/tracer_provider.yaml | 72 ++++---- 9 files changed, 371 insertions(+), 349 deletions(-) diff --git a/opentelemetry_configuration.json b/opentelemetry_configuration.json index ec4fdd4d..091d9134 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", @@ -49,7 +49,7 @@ }, "instrumentation/development": { "$ref": "#/$defs/ExperimentalInstrumentation", - "description": "Configure instrumentation.\nIf omitted, TODO.\n" + "description": "Configure instrumentation.\nIf omitted, instrumentation defaults are used.\n" } }, "required": [ @@ -64,27 +64,27 @@ "properties": { "default": { "$ref": "#/$defs/DefaultAggregation", - "description": "TODO\nIf omitted, TODO.\n" + "description": "Configure aggregation to be the default aggregation for the instrument type.\nSee 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": "TODO\nIf omitted, TODO.\n" + "description": "Configure the aggregation to be drop.\nSee 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": "Configure aggregation to be explicit_bucket_histogram.\nIf omitted, TODO.\n" + "description": "Configure aggregation to be explicit_bucket_histogram.\nSee https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation for details.\nIf omitted, ignore. If present and null, default values as described in ExplicitBucketHistogramAggregation are used.\n" }, "base2_exponential_bucket_histogram": { "$ref": "#/$defs/Base2ExponentialBucketHistogramAggregation", - "description": "TODO\nIf omitted, TODO.\n" + "description": "Configure aggregation to be base2_exponential_bucket_histogram.\nSee https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation for details.\nIf omitted, ignore. If present and null, default values as described in Base2ExponentialBucketHistogramAggregation are used.\n" }, "last_value": { "$ref": "#/$defs/LastValueAggregation", - "description": "TODO\nIf omitted, TODO.\n" + "description": "Configure the aggregation to be last_value.\nSee 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": "TODO\nIf omitted, TODO.\n" + "description": "Configure the aggregation to be sum.\nSee https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details.\nIf omitted, ignore.\n" } } }, @@ -231,7 +231,7 @@ ], "minimum": -10, "maximum": 20, - "description": "TODO\nIf omitted or null, TODO.\n" + "description": "TODO\nIf omitted or null, 20 is used.\n" }, "max_size": { "type": [ @@ -239,14 +239,14 @@ "null" ], "minimum": 2, - "description": "TODO\nIf omitted or null, TODO.\n" + "description": "TODO\nIf omitted or null, 160 is used.\n" }, "record_min_max": { "type": [ "boolean", "null" ], - "description": "TODO\nIf omitted or null, TODO.\n" + "description": "TODO\nIf omitted or null, true is used.\n" } } }, @@ -482,23 +482,23 @@ "properties": { "root": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with no parent.\nIf omitted, TODO.\n" + "description": "Configures the sampler for spans with no parent.\nIf omitted, ignore.\n" }, "remote_parent_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a remote parent that is sampled.\nIf omitted, TODO.\n" + "description": "Configures the sampler for spans with a remote parent that is sampled.\nIf omitted, ignore.\n" }, "remote_parent_not_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a remote parent that is not sampled.\nIf omitted, TODO.\n" + "description": "Configures the sampler for spans with a remote parent that is not sampled.\nIf omitted, ignore.\n" }, "local_parent_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a local parent that is sampled.\nIf omitted, TODO.\n" + "description": "Configures the sampler for spans with a local parent that is sampled.\nIf omitted, ignore.\n" }, "local_parent_not_sampled": { "$ref": "#/$defs/ExperimentalComposableSampler", - "description": "Configures the sampler for spans with a local parent that is not sampled.\nIf omitted, TODO.\n" + "description": "Configures the sampler for spans with a local parent that is not sampled.\nIf omitted, ignore.\n" } } }, @@ -533,19 +533,19 @@ "properties": { "always_off": { "$ref": "#/$defs/ExperimentalComposableAlwaysOffSampler", - "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/ExperimentalComposableAlwaysOnSampler", - "description": "Configure sampler to be always_on.\nIf omitted, TODO.\n" + "description": "Configure sampler to be always_on.\nIf omitted, ignore.\n" }, "parent_based": { "$ref": "#/$defs/ExperimentalComposableParentBasedSampler", - "description": "Configure sampler to be parent_based.\nIf omitted, TODO.\n" + "description": "Configure sampler to be parent_based.\nIf omitted, ignore.\n" }, "probability": { "$ref": "#/$defs/ExperimentalComposableProbabilitySampler", - "description": "Configure sampler to be probability.\nIf omitted, TODO.\n" + "description": "Configure sampler to be probability.\nIf omitted, ignore.\n" } } }, @@ -562,11 +562,11 @@ "properties": { "peer": { "$ref": "#/$defs/ExperimentalPeerInstrumentation", - "description": "Configure instrumentations following the peer semantic conventions.\nSee peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/\nIf omitted, TODO.\n" + "description": "Configure instrumentations following the peer semantic conventions.\nSee peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/\nIf omitted, defaults as described in ExperimentalPeerInstrumentation are used.\n" }, "http": { "$ref": "#/$defs/ExperimentalHttpInstrumentation", - "description": "Configure instrumentations following the http semantic conventions.\nSee http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/\nIf omitted, TODO.\n" + "description": "Configure instrumentations following the http semantic conventions.\nSee http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/\nIf omitted, defaults as described in ExperimentalHttpInstrumentation are used.\n" } } }, @@ -587,14 +587,15 @@ "items": { "type": "string" }, - "description": "Configure headers to capture for outbound http requests.\nIf omitted, TODO.\n" + "description": "Configure headers to capture for outbound http requests.\nIf omitted, no outbound request headers are captured.\n" }, "response_captured_headers": { "type": "array", + "minItems": 1, "items": { "type": "string" }, - "description": "Configure headers to capture for inbound http responses.\nIf omitted, TODO.\n" + "description": "Configure headers to capture for inbound http responses.\nIf omitted, no inbound response headers are captured.\n" } } }, @@ -604,11 +605,11 @@ "properties": { "client": { "$ref": "#/$defs/ExperimentalHttpClientInstrumentation", - "description": "Configure instrumentations following the http client semantic conventions.\nIf omitted, TODO.\n" + "description": "Configure instrumentations following the http client semantic conventions.\nIf omitted, defaults as described in ExperimentalHttpClientInstrumentation are used.\n" }, "server": { "$ref": "#/$defs/ExperimentalHttpServerInstrumentation", - "description": "Configure instrumentations following the http server semantic conventions.\nIf omitted, TODO.\n" + "description": "Configure instrumentations following the http server semantic conventions.\nIf omitted, defaults as described in ExperimentalHttpServerInstrumentation are used.\n" } } }, @@ -622,7 +623,7 @@ "items": { "type": "string" }, - "description": "Configure headers to capture for inbound http requests.\nIf omitted, TODO.\n" + "description": "Configure headers to capture for inbound http requests.\nIf omitted, no request headers are captured.\n" }, "response_captured_headers": { "type": "array", @@ -630,7 +631,7 @@ "items": { "type": "string" }, - "description": "Configure headers to capture for outbound http responses.\nIf omitted, TODO.\n" + "description": "Configure headers to capture for outbound http responses.\nIf omitted, no response headers are captures.\n" } } }, @@ -640,51 +641,51 @@ "properties": { "general": { "$ref": "#/$defs/ExperimentalGeneralInstrumentation", - "description": "Configure general SemConv options that may apply to multiple languages and instrumentations.\nInstrumenation may merge general config options with the language specific configuration at .instrumentation..\nIf omitted, TODO.\n" + "description": "Configure general SemConv options that may apply to multiple languages and instrumentations.\nInstrumenation may merge general config options with the language specific configuration at .instrumentation..\nIf omitted, default values as described in ExperimentalGeneralInstrumentation are used.\n" }, "cpp": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure C++ language-specific instrumentation libraries.\nIf omitted, TODO.\n" + "description": "Configure C++ language-specific instrumentation libraries.\nIf omitted, instrumentation defaults are used.\n" }, "dotnet": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure .NET language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure .NET language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "erlang": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Erlang language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure Erlang language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "go": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Go language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure Go language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "java": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Java language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure Java language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "js": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure JavaScript language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure JavaScript language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "php": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure PHP language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure PHP language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "python": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Python language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure Python language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "ruby": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Ruby language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure Ruby language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "rust": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Rust language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure Rust language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" }, "swift": { "$ref": "#/$defs/ExperimentalLanguageSpecificInstrumentation", - "description": "Configure Swift language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, TODO.\n" + "description": "Configure Swift language-specific instrumentation libraries.\nEach entry's key identifies a particular instrumentation library. The corresponding value configures it.\nIf omitted, instrumentation defaults are used.\n" } } }, @@ -697,10 +698,9 @@ "properties": { "endpoint": { "type": [ - "string", - "null" + "string" ], - "description": "TODO\nIf omitted or null, TODO.\n" + "description": "Configure the endpoint of the jaeger remote sampling service.\nProperty is required and must be non-null.\n" }, "interval": { "type": [ @@ -708,13 +708,17 @@ "null" ], "minimum": 0, - "description": "TODO\nIf omitted or null, TODO.\n" + "description": "Configure the polling interval (in milliseconds) to fetch from the remote sampling service.\nIf omitted or null, 60000 is used.\n" }, "initial_sampler": { "$ref": "#/$defs/Sampler", - "description": "TODO\nIf omitted, TODO.\n" + "description": "Configure the initial sampler used before first configuration is fetched.\nProperty is required and must be non-null.\n" } - } + }, + "required": [ + "endpoint", + "initial_sampler" + ] }, "ExperimentalLanguageSpecificInstrumentation": { "type": "object", @@ -756,7 +760,7 @@ "properties": { "default_config": { "$ref": "#/$defs/ExperimentalLoggerConfig", - "description": "Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers.\nIf omitted, TODO.\n" + "description": "Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers.\nIf omitted, unmatched .loggers use default values as described in ExperimentalLoggerConfig.\n" }, "loggers": { "type": "array", @@ -764,7 +768,7 @@ "items": { "$ref": "#/$defs/ExperimentalLoggerMatcherAndConfig" }, - "description": "Configure loggers.\nIf omitted, TODO.\n" + "description": "Configure loggers.\nIf omitted, all loggers use .default_config.\n" } } }, @@ -800,7 +804,7 @@ "type": [ "boolean" ], - "description": "Configure if the meter is enabled or not.\nIf omitted, TODO.\n" + "description": "Configure if the meter is enabled or not.\nIf omitted, false is used.\n" } } }, @@ -812,7 +816,7 @@ "properties": { "default_config": { "$ref": "#/$defs/ExperimentalMeterConfig", - "description": "Configure the default meter config used there is no matching entry in .meter_configurator/development.meters.\nIf omitted, TODO.\n" + "description": "Configure the default meter config used there is no matching entry in .meter_configurator/development.meters.\nIf omitted, unmatched .meters use default values as described in ExperimentalMeterConfig.\n" }, "meters": { "type": "array", @@ -820,7 +824,7 @@ "items": { "$ref": "#/$defs/ExperimentalMeterMatcherAndConfig" }, - "description": "Configure meters.\nIf omitted, TODO.\n" + "description": "Configure meters.\nIf omitted, all meters used .default_config.\n" } } }, @@ -896,7 +900,7 @@ "items": { "$ref": "#/$defs/ExperimentalPeerServiceMapping" }, - "description": "Configure the service mapping for instrumentations following peer.service semantic conventions.\nSee peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes\nIf omitted, TODO.\n" + "description": "Configure the service mapping for instrumentations following peer.service semantic conventions.\nSee peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes\nIf omitted, no peer service mappings are used.\n" } } }, @@ -980,7 +984,7 @@ }, "with_resource_constant_labels": { "$ref": "#/$defs/IncludeExclude", - "description": "Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns.\nIf omitted, TODO.\n" + "description": "Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns.\nIf omitted, no resource attributes are added.\n" }, "translation_strategy": { "$ref": "#/$defs/ExperimentalPrometheusTranslationStrategy", @@ -1006,7 +1010,7 @@ "properties": { "attributes": { "$ref": "#/$defs/IncludeExclude", - "description": "Configure attributes provided by resource detectors.\nIf omitted, TODO.\n" + "description": "Configure attributes provided by resource detectors.\nIf omitted, all attributes from resource detectors are added.\n" }, "detectors": { "type": "array", @@ -1031,19 +1035,19 @@ "properties": { "container": { "$ref": "#/$defs/ExperimentalContainerResourceDetector", - "description": "Enable the container resource detector, which populates container.* attributes.\nIf omitted, TODO.\n" + "description": "Enable the container resource detector, which populates container.* attributes.\nIf omitted, ignore.\n" }, "host": { "$ref": "#/$defs/ExperimentalHostResourceDetector", - "description": "Enable the host resource detector, which populates host.* and os.* attributes.\nIf omitted, TODO.\n" + "description": "Enable the host resource detector, which populates host.* and os.* attributes.\nIf omitted, ignore.\n" }, "process": { "$ref": "#/$defs/ExperimentalProcessResourceDetector", - "description": "Enable the process resource detector, which populates process.* attributes.\nIf omitted, TODO.\n" + "description": "Enable the process resource detector, which populates process.* attributes.\nIf omitted, ignore.\n" }, "service": { "$ref": "#/$defs/ExperimentalServiceResourceDetector", - "description": "Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.\nIf omitted, TODO.\n" + "description": "Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.\nIf omitted, ignore.\n" } } }, @@ -1096,7 +1100,7 @@ "type": [ "boolean" ], - "description": "Configure if the tracer is enabled or not.\nIf omitted, TODO.\n" + "description": "Configure if the tracer is enabled or not.\nIf omitted, false is used.\n" } } }, @@ -1108,7 +1112,7 @@ "properties": { "default_config": { "$ref": "#/$defs/ExperimentalTracerConfig", - "description": "Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers.\nIf omitted, TODO.\n" + "description": "Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers.\nIf omitted, unmatched .tracers use default values as described in ExperimentalTracerConfig.\n" }, "tracers": { "type": "array", @@ -1116,7 +1120,7 @@ "items": { "$ref": "#/$defs/ExperimentalTracerMatcherAndConfig" }, - "description": "Configure tracers.\nIf omitted, TODO.\n" + "description": "Configure tracers.\nIf omitted, all tracers use .default_config.\n" } } }, @@ -1319,11 +1323,11 @@ }, "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", - "description": "Configure loggers.\nIf omitted, TODO.\n" + "description": "Configure loggers.\nIf omitted, all loggers use default values as described in ExperimentalLoggerConfig.\n" } }, "required": [ @@ -1343,19 +1347,19 @@ "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", - "description": "Configure exporter to be OTLP with file transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with file transport.\nIf omitted, ignore.\n" }, "console": { "$ref": "#/$defs/ConsoleExporter", - "description": "Configure exporter to be console.\nIf omitted, TODO.\n" + "description": "Configure exporter to be console.\nIf omitted, ignore.\n" } } }, @@ -1394,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" } } }, @@ -1420,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", @@ -1428,7 +1432,7 @@ }, "meter_configurator/development": { "$ref": "#/$defs/ExperimentalMeterConfigurator", - "description": "Configure meters.\nIf omitted, TODO.\n" + "description": "Configure meters.\nIf omitted, all meters use default values as described in ExperimentalMeterConfig.\n" } }, "required": [ @@ -1448,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" } } }, @@ -1460,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" } } }, @@ -1569,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", @@ -1577,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": [ @@ -1691,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", @@ -1699,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": [ @@ -1796,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": [ @@ -1817,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" } } }, @@ -1841,7 +1845,7 @@ "properties": { "prometheus/development": { "$ref": "#/$defs/ExperimentalPrometheusMetricExporter", - "description": "Configure exporter to be prometheus.\nIf omitted, TODO.\n" + "description": "Configure exporter to be prometheus.\nIf omitted, ignore.\n" } } }, @@ -1859,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": [ @@ -1883,19 +1887,19 @@ "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", - "description": "Configure exporter to be OTLP with file transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with file transport.\nIf omitted, ignore.\n" }, "console": { "$ref": "#/$defs/ConsoleMetricExporter", - "description": "Configure exporter to be console.\nIf omitted, TODO.\n" + "description": "Configure exporter to be console.\nIf omitted, ignore.\n" } } }, @@ -1909,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", @@ -1944,31 +1948,31 @@ "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", - "description": "Configure sampler to be composite.\nIf omitted, TODO.\n" + "description": "Configure sampler to be composite.\nIf omitted, v.\n" }, "jaeger_remote/development": { "$ref": "#/$defs/ExperimentalJaegerRemoteSampler", - "description": "TODO\nIf omitted, TODO.\n" + "description": "Configure sampler to be jaeger_remote.\nIf omitted, ignore.\n" }, "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", - "description": "Configure sampler to be probability.\nIf omitted, TODO.\n" + "description": "Configure sampler to be probability.\nIf omitted, ignore.\n" }, "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" } } }, @@ -2011,23 +2015,23 @@ "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", - "description": "Configure exporter to be OTLP with file transport.\nIf omitted, TODO.\n" + "description": "Configure exporter to be OTLP with file transport.\nIf omitted, ignore.\n" }, "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" } } }, @@ -2098,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" } } }, @@ -2126,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" } } }, @@ -2189,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", @@ -2197,7 +2201,7 @@ }, "tracer_configurator/development": { "$ref": "#/$defs/ExperimentalTracerConfigurator", - "description": "Configure tracers.\nIf omitted, TODO.\n" + "description": "Configure tracers.\nIf omitted, all tracers use default values as described in ExperimentalTracerConfig.\n" } }, "required": [ @@ -2299,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 07d09318..026c6e1c 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. | TODO | -| `default` | [`DefaultAggregation`](#defaultaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | -| `drop` | [`DropAggregation`](#dropaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | -| `explicit_bucket_histogram` | [`ExplicitBucketHistogramAggregation`](#explicitbuckethistogramaggregation) | `false` | If omitted, TODO. | No constraints. | Configure aggregation to be explicit_bucket_histogram. | -| `last_value` | [`LastValueAggregation`](#lastvalueaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | -| `sum` | [`SumAggregation`](#sumaggregation) | `false` | If omitted, TODO. | No constraints. | TODO | +| `base2_exponential_bucket_histogram` | [`Base2ExponentialBucketHistogramAggregation`](#base2exponentialbuckethistogramaggregation) | `false` | If omitted, ignore. If present and null, default values as described in Base2ExponentialBucketHistogramAggregation are used. | No constraints. | Configure aggregation to be base2_exponential_bucket_histogram.
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. | Configure aggregation to be the default aggregation for the instrument type.
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. | Configure the aggregation to be drop.
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. If present and null, default values as described in ExplicitBucketHistogramAggregation are used. | No constraints. | Configure aggregation to be explicit_bucket_histogram.
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. | Configure the aggregation to be last_value.
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. | Configure the aggregation to be sum.
See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details.
|
Language support status @@ -401,9 +401,9 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `max_scale` | one of:
* `integer`
* `null`
| `false` | If omitted or null, TODO. | * `minimum`: `-10`
* `maximum`: `20`
| TODO | -| `max_size` | one of:
* `integer`
* `null`
| `false` | If omitted or null, TODO. | * `minimum`: `2`
| TODO | -| `record_min_max` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, TODO. | No constraints. | TODO | +| `max_scale` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 20 is used. | * `minimum`: `-10`
* `maximum`: `20`
| TODO | +| `max_size` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 160 is used. | * `minimum`: `2`
| TODO | +| `record_min_max` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, true is used. | No constraints. | TODO |
Language support status @@ -1312,9 +1312,9 @@ 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, TODO. | No constraints. | Configure loggers.
| +| `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.
|
Language support status @@ -1369,10 +1369,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. | -| `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileExporter`](#experimentalotlpfileexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with file 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.
|
Language support status @@ -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,8 +1536,8 @@ 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).
| -| `meter_configurator/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalMeterConfigurator`](#experimentalmeterconfigurator) | `false` | If omitted, TODO. | No constraints. | Configure meters.
| +| `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.
|
Language support status @@ -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.
| @@ -1780,7 +1780,7 @@ Usages: | `propagator` | [`Propagator`](#propagator) | `false` | If omitted, a noop propagator is used. | No constraints. | Configure text map context propagators.
| | `resource` | [`Resource`](#resource) | `false` | If omitted, the default resource is used. | No constraints. | Configure resource for all signals.
| | `tracer_provider` | [`TracerProvider`](#tracerprovider) | `false` | If omitted, a noop tracer provider is used. | No constraints. | Configure tracer provider.
| -| `instrumentation/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalInstrumentation`](#experimentalinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentation.
| +| `instrumentation/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalInstrumentation`](#experimentalinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure instrumentation.
|
Language support status @@ -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 @@ -2474,7 +2474,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `prometheus/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be prometheus.
| +| `prometheus/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | `false` | If omitted, ignore. | No constraints. | Configure exporter to be prometheus.
|
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,10 +2577,10 @@ 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.
| -| `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileMetricExporter`](#experimentalotlpfilemetricexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with file 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.
|
Language support status @@ -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,13 +2702,13 @@ 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. | -| `composite/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be composite. | -| `jaeger_remote/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalJaegerRemoteSampler`](#experimentaljaegerremotesampler) | `false` | If omitted, TODO. | No constraints. | TODO | -| `probability/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be probability. | +| `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, v. | 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. |
Language support status @@ -2868,11 +2868,11 @@ 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. | -| `otlp_file/development`
**WARNING:** This property is [experimental](README.md#experimental-features). | [`ExperimentalOtlpFileExporter`](#experimentalotlpfileexporter) | `false` | If omitted, TODO. | No constraints. | Configure exporter to be OTLP with file 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. | +| `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.
|
Language support status @@ -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,10 +3242,10 @@ 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, TODO. | No constraints. | Configure tracers.
| +| `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.
|
Language support status @@ -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).
| @@ -3606,11 +3606,11 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `local_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a local parent that is not sampled. | -| `local_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a local parent that is sampled. | -| `remote_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a remote parent that is not sampled. | -| `remote_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with a remote parent that is sampled. | -| `root` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, TODO. | No constraints. | Configures the sampler for spans with no parent. | +| `local_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, ignore. | No constraints. | Configures the sampler for spans with a local parent that is not sampled. | +| `local_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, ignore. | No constraints. | Configures the sampler for spans with a local parent that is sampled. | +| `remote_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, ignore. | No constraints. | Configures the sampler for spans with a remote parent that is not sampled. | +| `remote_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, ignore. | No constraints. | Configures the sampler for spans with a remote parent that is sampled. | +| `root` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | If omitted, ignore. | No constraints. | Configures the sampler for spans with no parent. |
Language support status @@ -3717,10 +3717,10 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `always_off` | [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be always_off. | -| `always_on` | [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be always_on. | -| `parent_based` | [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be parent_based. | -| `probability` | [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | `false` | If omitted, TODO. | No constraints. | Configure sampler to be probability. | +| `always_off` | [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be always_off. | +| `always_on` | [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be always_on. | +| `parent_based` | [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be parent_based. | +| `probability` | [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | `false` | If omitted, ignore. | No constraints. | Configure sampler to be probability. |
Language support status @@ -3814,8 +3814,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `http` | [`ExperimentalHttpInstrumentation`](#experimentalhttpinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the http semantic conventions.
See http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/
| -| `peer` | [`ExperimentalPeerInstrumentation`](#experimentalpeerinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the peer semantic conventions.
See peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/
| +| `http` | [`ExperimentalHttpInstrumentation`](#experimentalhttpinstrumentation) | `false` | If omitted, defaults as described in ExperimentalHttpInstrumentation are used. | No constraints. | Configure instrumentations following the http semantic conventions.
See http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/
| +| `peer` | [`ExperimentalPeerInstrumentation`](#experimentalpeerinstrumentation) | `false` | If omitted, defaults as described in ExperimentalPeerInstrumentation are used. | No constraints. | Configure instrumentations following the peer semantic conventions.
See peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/
|
Language support status @@ -3887,8 +3887,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `request_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers to capture for outbound http requests.
| -| `response_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | No constraints. | Configure headers to capture for inbound http responses.
| +| `request_captured_headers` | `array` of `string` | `false` | If omitted, no outbound request headers are captured. | * `minItems`: `1`
| Configure headers to capture for outbound http requests.
| +| `response_captured_headers` | `array` of `string` | `false` | If omitted, no inbound response headers are captured. | * `minItems`: `1`
| Configure headers to capture for inbound http responses.
|
Language support status @@ -3924,6 +3924,7 @@ Usages: }, "response_captured_headers": { "type": "array", + "minItems": 1, "items": { "type": "string" } @@ -3939,8 +3940,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `client` | [`ExperimentalHttpClientInstrumentation`](#experimentalhttpclientinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the http client semantic conventions. | -| `server` | [`ExperimentalHttpServerInstrumentation`](#experimentalhttpserverinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure instrumentations following the http server semantic conventions. | +| `client` | [`ExperimentalHttpClientInstrumentation`](#experimentalhttpclientinstrumentation) | `false` | If omitted, defaults as described in ExperimentalHttpClientInstrumentation are used. | No constraints. | Configure instrumentations following the http client semantic conventions. | +| `server` | [`ExperimentalHttpServerInstrumentation`](#experimentalhttpserverinstrumentation) | `false` | If omitted, defaults as described in ExperimentalHttpServerInstrumentation are used. | No constraints. | Configure instrumentations following the http server semantic conventions. |
Language support status @@ -3984,8 +3985,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `request_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers to capture for inbound http requests.
| -| `response_captured_headers` | `array` of `string` | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure headers to capture for outbound http responses.
| +| `request_captured_headers` | `array` of `string` | `false` | If omitted, no request headers are captured. | * `minItems`: `1`
| Configure headers to capture for inbound http requests.
| +| `response_captured_headers` | `array` of `string` | `false` | If omitted, no response headers are captures. | * `minItems`: `1`
| Configure headers to capture for outbound http responses.
|
Language support status @@ -4037,18 +4038,18 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `cpp` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure C++ language-specific instrumentation libraries. | -| `dotnet` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure .NET language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `erlang` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Erlang language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `general` | [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure general SemConv options that may apply to multiple languages and instrumentations.
Instrumenation may merge general config options with the language specific configuration at .instrumentation..
| -| `go` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Go language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `java` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Java language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `js` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure JavaScript language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `php` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure PHP language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `python` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Python language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `ruby` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Ruby language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `rust` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Rust language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| -| `swift` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, TODO. | No constraints. | Configure Swift language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `cpp` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure C++ language-specific instrumentation libraries. | +| `dotnet` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure .NET language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `erlang` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure Erlang language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `general` | [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | `false` | If omitted, default values as described in ExperimentalGeneralInstrumentation are used. | No constraints. | Configure general SemConv options that may apply to multiple languages and instrumentations.
Instrumenation may merge general config options with the language specific configuration at .instrumentation..
| +| `go` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure Go language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `java` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure Java language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `js` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure JavaScript language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `php` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure PHP language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `python` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure Python language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `ruby` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure Ruby language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `rust` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure Rust language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
| +| `swift` | [`ExperimentalLanguageSpecificInstrumentation`](#experimentallanguagespecificinstrumentation) | `false` | If omitted, instrumentation defaults are used. | No constraints. | Configure Swift language-specific instrumentation libraries.
Each entry's key identifies a particular instrumentation library. The corresponding value configures it.
|
Language support status @@ -4132,9 +4133,9 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `endpoint` | one of:
* `string`
* `null`
| `false` | If omitted or null, TODO. | No constraints. | TODO | -| `initial_sampler` | [`Sampler`](#sampler) | `false` | If omitted, TODO. | No constraints. | TODO | -| `interval` | one of:
* `integer`
* `null`
| `false` | If omitted or null, TODO. | * `minimum`: `0`
| TODO | +| `endpoint` | `string` | `true` | Property is required and must be non-null. | No constraints. | Configure the endpoint of the jaeger remote sampling service. | +| `initial_sampler` | [`Sampler`](#sampler) | `true` | Property is required and must be non-null. | No constraints. | Configure the initial sampler used before first configuration is fetched. | +| `interval` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 60000 is used. | * `minimum`: `0`
| Configure the polling interval (in milliseconds) to fetch from the remote sampling service. |
Language support status @@ -4149,6 +4150,7 @@ Usages: Constraints: * `additionalProperties`: `false` +* `required`: `["endpoint","initial_sampler"]` Usages: @@ -4167,8 +4169,7 @@ Usages: "properties": { "endpoint": { "type": [ - "string", - "null" + "string" ] }, "interval": { @@ -4181,7 +4182,11 @@ Usages: "initial_sampler": { "$ref": "#/$defs/Sampler" } - } + }, + "required": [ + "endpoint", + "initial_sampler" + ] }
@@ -4288,8 +4293,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `default_config` | [`ExperimentalLoggerConfig`](#experimentalloggerconfig) | `false` | If omitted, TODO. | No constraints. | Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers. | -| `loggers` | `array` of [`ExperimentalLoggerMatcherAndConfig`](#experimentalloggermatcherandconfig) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure loggers. | +| `default_config` | [`ExperimentalLoggerConfig`](#experimentalloggerconfig) | `false` | If omitted, unmatched .loggers use default values as described in ExperimentalLoggerConfig. | No constraints. | Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers. | +| `loggers` | `array` of [`ExperimentalLoggerMatcherAndConfig`](#experimentalloggermatcherandconfig) | `false` | If omitted, all loggers use .default_config. | * `minItems`: `1`
| Configure loggers. |
Language support status @@ -4393,7 +4398,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `disabled` | `boolean` | `false` | If omitted, TODO. | No constraints. | Configure if the meter is enabled or not. | +| `disabled` | `boolean` | `false` | If omitted, false is used. | No constraints. | Configure if the meter is enabled or not. |
Language support status @@ -4438,8 +4443,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `default_config` | [`ExperimentalMeterConfig`](#experimentalmeterconfig) | `false` | If omitted, TODO. | No constraints. | Configure the default meter config used there is no matching entry in .meter_configurator/development.meters. | -| `meters` | `array` of [`ExperimentalMeterMatcherAndConfig`](#experimentalmetermatcherandconfig) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure meters. | +| `default_config` | [`ExperimentalMeterConfig`](#experimentalmeterconfig) | `false` | If omitted, unmatched .meters use default values as described in ExperimentalMeterConfig. | No constraints. | Configure the default meter config used there is no matching entry in .meter_configurator/development.meters. | +| `meters` | `array` of [`ExperimentalMeterMatcherAndConfig`](#experimentalmetermatcherandconfig) | `false` | If omitted, all meters used .default_config. | * `minItems`: `1`
| Configure meters. |
Language support status @@ -4646,7 +4651,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `service_mapping` | `array` of [`ExperimentalPeerServiceMapping`](#experimentalpeerservicemapping) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure the service mapping for instrumentations following peer.service semantic conventions.
See peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes
| +| `service_mapping` | `array` of [`ExperimentalPeerServiceMapping`](#experimentalpeerservicemapping) | `false` | If omitted, no peer service mappings are used. | * `minItems`: `1`
| Configure the service mapping for instrumentations following peer.service semantic conventions.
See peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes
|
Language support status @@ -4819,7 +4824,7 @@ Usages: | `host` | one of:
* `string`
* `null`
| `false` | If omitted or null, localhost is used. | No constraints. | Configure host.
| | `port` | one of:
* `integer`
* `null`
| `false` | If omitted or null, 9464 is used. | No constraints. | Configure port.
| | `translation_strategy` | [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | `false` | If omitted, UnderscoreEscapingWithSuffixes is used. | No constraints. | Configure how Prometheus metrics are exposed. Values include:

* UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.
* UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.
* NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.
* NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.
| -| `with_resource_constant_labels` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, TODO. | No constraints. | Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns. | +| `with_resource_constant_labels` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, no resource attributes are added. | No constraints. | Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns. | | `without_scope_info` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, false is used. | No constraints. | Configure Prometheus Exporter to produce metrics without a scope info metric.
| | `without_target_info` | one of:
* `boolean`
* `null`
| `false` | If omitted or null, false is used. | No constraints. | Configure Prometheus Exporter to produce metrics without a target info metric for the resource.
| @@ -4945,7 +4950,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `attributes` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, TODO. | No constraints. | Configure attributes provided by resource detectors. | +| `attributes` | [`IncludeExclude`](#includeexclude) | `false` | If omitted, all attributes from resource detectors are added. | No constraints. | Configure attributes provided by resource detectors. | | `detectors` | `array` of [`ExperimentalResourceDetector`](#experimentalresourcedetector) | `false` | If omitted, no resource detectors are enabled. | * `minItems`: `1`
| Configure resource detectors.
Resource detector names are dependent on the SDK language ecosystem. Please consult documentation for each respective language.
|
@@ -4996,10 +5001,10 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `container` | [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the container resource detector, which populates container.* attributes.
| -| `host` | [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the host resource detector, which populates host.* and os.* attributes.
| -| `process` | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the process resource detector, which populates process.* attributes.
| -| `service` | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | `false` | If omitted, TODO. | No constraints. | Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.
| +| `container` | [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | `false` | If omitted, ignore. | No constraints. | Enable the container resource detector, which populates container.* attributes.
| +| `host` | [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | `false` | If omitted, ignore. | No constraints. | Enable the host resource detector, which populates host.* and os.* attributes.
| +| `process` | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | `false` | If omitted, ignore. | No constraints. | Enable the process resource detector, which populates process.* attributes.
| +| `service` | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | `false` | If omitted, ignore. | No constraints. | Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id.
|
Language support status @@ -5197,7 +5202,7 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `disabled` | `boolean` | `false` | If omitted, TODO. | No constraints. | Configure if the tracer is enabled or not. | +| `disabled` | `boolean` | `false` | If omitted, false is used. | No constraints. | Configure if the tracer is enabled or not. |
Language support status @@ -5242,8 +5247,8 @@ Usages: | Property | Type | Required? | Default and Null Behavior | Constraints | Description | |---|---|---|---|---|---| -| `default_config` | [`ExperimentalTracerConfig`](#experimentaltracerconfig) | `false` | If omitted, TODO. | No constraints. | Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers. | -| `tracers` | `array` of [`ExperimentalTracerMatcherAndConfig`](#experimentaltracermatcherandconfig) | `false` | If omitted, TODO. | * `minItems`: `1`
| Configure tracers. | +| `default_config` | [`ExperimentalTracerConfig`](#experimentaltracerconfig) | `false` | If omitted, unmatched .tracers use default values as described in ExperimentalTracerConfig. | No constraints. | Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers. | +| `tracers` | `array` of [`ExperimentalTracerMatcherAndConfig`](#experimentaltracermatcherandconfig) | `false` | If omitted, all tracers use .default_config. | * `minItems`: `1`
| Configure tracers. |
Language support status diff --git a/schema/instrumentation.yaml b/schema/instrumentation.yaml index 812ad5d3..30bddcdc 100644 --- a/schema/instrumentation.yaml +++ b/schema/instrumentation.yaml @@ -6,71 +6,71 @@ properties: description: | Configure general SemConv options that may apply to multiple languages and instrumentations. Instrumenation may merge general config options with the language specific configuration at .instrumentation.. - defaultBehavior: TODO + defaultBehavior: default values as described in ExperimentalGeneralInstrumentation are used cpp: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: Configure C++ language-specific instrumentation libraries. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used dotnet: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure .NET language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used erlang: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Erlang language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used go: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Go language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used java: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Java language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used js: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure JavaScript language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used php: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure PHP language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used python: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Python language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used ruby: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Ruby language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used rust: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Rust language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used swift: $ref: "#/$defs/ExperimentalLanguageSpecificInstrumentation" description: | Configure Swift language-specific instrumentation libraries. Each entry's key identifies a particular instrumentation library. The corresponding value configures it. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used $defs: ExperimentalGeneralInstrumentation: type: object @@ -81,13 +81,13 @@ $defs: description: | Configure instrumentations following the peer semantic conventions. See peer semantic conventions: https://opentelemetry.io/docs/specs/semconv/attributes-registry/peer/ - defaultBehavior: TODO + defaultBehavior: defaults as described in ExperimentalPeerInstrumentation are used http: $ref: "#/$defs/ExperimentalHttpInstrumentation" description: | Configure instrumentations following the http semantic conventions. See http semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/ - defaultBehavior: TODO + defaultBehavior: defaults as described in ExperimentalHttpInstrumentation are used ExperimentalPeerInstrumentation: type: object additionalProperties: false @@ -100,7 +100,7 @@ $defs: description: | Configure the service mapping for instrumentations following peer.service semantic conventions. See peer.service semantic conventions: https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes - defaultBehavior: TODO + defaultBehavior: no peer service mappings are used ExperimentalPeerServiceMapping: type: object additionalProperties: false @@ -127,14 +127,15 @@ $defs: type: string description: | Configure headers to capture for outbound http requests. - defaultBehavior: TODO + defaultBehavior: no outbound request headers are captured response_captured_headers: type: array + minItems: 1 items: type: string description: | Configure headers to capture for inbound http responses. - defaultBehavior: TODO + defaultBehavior: no inbound response headers are captured ExperimentalHttpServerInstrumentation: type: object additionalProperties: false @@ -146,7 +147,7 @@ $defs: type: string description: | Configure headers to capture for inbound http requests. - defaultBehavior: TODO + defaultBehavior: no request headers are captured response_captured_headers: type: array minItems: 1 @@ -154,7 +155,7 @@ $defs: type: string description: | Configure headers to capture for outbound http responses. - defaultBehavior: TODO + defaultBehavior: no response headers are captures ExperimentalHttpInstrumentation: type: object additionalProperties: false @@ -162,11 +163,11 @@ $defs: client: $ref: "#/$defs/ExperimentalHttpClientInstrumentation" description: Configure instrumentations following the http client semantic conventions. - defaultBehavior: TODO + defaultBehavior: defaults as described in ExperimentalHttpClientInstrumentation are used server: $ref: "#/$defs/ExperimentalHttpServerInstrumentation" description: Configure instrumentations following the http server semantic conventions. - defaultBehavior: TODO + defaultBehavior: defaults as described in ExperimentalHttpServerInstrumentation are used ExperimentalLanguageSpecificInstrumentation: type: object additionalProperties: diff --git a/schema/logger_provider.yaml b/schema/logger_provider.yaml index 8123b2e0..4f375a5f 100644 --- a/schema/logger_provider.yaml +++ b/schema/logger_provider.yaml @@ -10,12 +10,12 @@ 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: | Configure loggers. - defaultBehavior: TODO + defaultBehavior: all loggers use default values as described in ExperimentalLoggerConfig required: - processors $defs: @@ -83,20 +83,20 @@ $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: | Configure exporter to be OTLP with file transport. - defaultBehavior: TODO + defaultBehavior: ignore 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: @@ -146,14 +146,14 @@ $defs: default_config: $ref: "#/$defs/ExperimentalLoggerConfig" description: Configure the default logger config used there is no matching entry in .logger_configurator/development.loggers. - defaultBehavior: TODO + defaultBehavior: unmatched .loggers use default values as described in ExperimentalLoggerConfig loggers: type: array minItems: 1 items: $ref: "#/$defs/ExperimentalLoggerMatcherAndConfig" description: Configure loggers. - defaultBehavior: TODO + defaultBehavior: all loggers use .default_config ExperimentalLoggerMatcherAndConfig: type: - object diff --git a/schema/meter_provider.yaml b/schema/meter_provider.yaml index b56f4f99..e17e2c9f 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: | @@ -26,7 +26,7 @@ properties: $ref: "#/$defs/ExperimentalMeterConfigurator" description: | Configure meters. - defaultBehavior: TODO + defaultBehavior: all meters use default values as described in ExperimentalMeterConfig required: - readers $defs: @@ -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,22 +182,22 @@ $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: | Configure exporter to be OTLP with file transport. - defaultBehavior: TODO + defaultBehavior: ignore console: $ref: "#/$defs/ConsoleMetricExporter" description: | Configure exporter to be console. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true PullMetricExporter: type: object @@ -212,7 +212,7 @@ $defs: $ref: "#/$defs/ExperimentalPrometheusMetricExporter" description: | Configure exporter to be prometheus. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true MetricProducer: 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: @@ -270,7 +270,7 @@ $defs: with_resource_constant_labels: $ref: common.yaml#/$defs/IncludeExclude description: Configure Prometheus Exporter to add resource attributes as metrics attributes, where the resource attribute keys match the patterns. - defaultBehavior: TODO + defaultBehavior: no resource attributes are added translation_strategy: $ref: "#/$defs/ExperimentalPrometheusTranslationStrategy" description: | @@ -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 @@ -633,28 +633,42 @@ $defs: properties: default: $ref: "#/$defs/DefaultAggregation" - description: TODO - defaultBehavior: TODO + description: | + Configure aggregation to be the default aggregation for the instrument type. + See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#default-aggregation for details. + defaultBehavior: ignore drop: $ref: "#/$defs/DropAggregation" - description: TODO - defaultBehavior: TODO + description: | + Configure the aggregation to be drop. + See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation for details. + defaultBehavior: ignore explicit_bucket_histogram: $ref: "#/$defs/ExplicitBucketHistogramAggregation" - description: Configure aggregation to be explicit_bucket_histogram. - defaultBehavior: TODO + description: | + Configure aggregation to be explicit_bucket_histogram. + See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation for details. + defaultBehavior: ignore + nullBehavior: default values as described in ExplicitBucketHistogramAggregation are used base2_exponential_bucket_histogram: $ref: "#/$defs/Base2ExponentialBucketHistogramAggregation" - description: TODO - defaultBehavior: TODO + description: | + Configure aggregation to be base2_exponential_bucket_histogram. + See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation for details. + defaultBehavior: ignore + nullBehavior: default values as described in Base2ExponentialBucketHistogramAggregation are used last_value: $ref: "#/$defs/LastValueAggregation" - description: TODO - defaultBehavior: TODO + description: | + Configure the aggregation to be last_value. + See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#last-value-aggregation for details. + defaultBehavior: ignore sum: $ref: "#/$defs/SumAggregation" - description: TODO - defaultBehavior: TODO + description: | + Configure the aggregation to be sum. + See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation for details. + defaultBehavior: ignore DefaultAggregation: type: - object @@ -699,20 +713,20 @@ $defs: minimum: -10 maximum: 20 description: TODO - defaultBehavior: TODO + defaultBehavior: 20 is used max_size: type: - integer - "null" minimum: 2 description: TODO - defaultBehavior: TODO + defaultBehavior: 160 is used record_min_max: type: - boolean - "null" description: TODO - defaultBehavior: TODO + defaultBehavior: true is used LastValueAggregation: type: - object @@ -731,14 +745,14 @@ $defs: default_config: $ref: "#/$defs/ExperimentalMeterConfig" description: Configure the default meter config used there is no matching entry in .meter_configurator/development.meters. - defaultBehavior: TODO + defaultBehavior: unmatched .meters use default values as described in ExperimentalMeterConfig meters: type: array minItems: 1 items: $ref: "#/$defs/ExperimentalMeterMatcherAndConfig" description: Configure meters. - defaultBehavior: TODO + defaultBehavior: all meters used .default_config ExperimentalMeterMatcherAndConfig: type: - object @@ -767,4 +781,4 @@ $defs: type: - boolean description: Configure if the meter is enabled or not. - defaultBehavior: TODO + defaultBehavior: false is used diff --git a/schema/opentelemetry_configuration.yaml b/schema/opentelemetry_configuration.yaml index 290e88c6..fd2fc297 100644 --- a/schema/opentelemetry_configuration.yaml +++ b/schema/opentelemetry_configuration.yaml @@ -26,7 +26,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: | @@ -56,7 +56,7 @@ properties: $ref: "#/$defs/ExperimentalInstrumentation" description: | Configure instrumentation. - defaultBehavior: TODO + defaultBehavior: instrumentation defaults are used required: - file_format $defs: 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 7216256f..5f97a678 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: | @@ -97,7 +97,7 @@ $defs: attributes: $ref: common.yaml#/$defs/IncludeExclude description: Configure attributes provided by resource detectors. - defaultBehavior: TODO + defaultBehavior: all attributes from resource detectors are added detectors: type: array minItems: 1 @@ -120,22 +120,22 @@ $defs: $ref: "#/$defs/ExperimentalContainerResourceDetector" description: | Enable the container resource detector, which populates container.* attributes. - defaultBehavior: TODO + defaultBehavior: ignore host: $ref: "#/$defs/ExperimentalHostResourceDetector" description: | Enable the host resource detector, which populates host.* and os.* attributes. - defaultBehavior: TODO + defaultBehavior: ignore process: $ref: "#/$defs/ExperimentalProcessResourceDetector" description: | Enable the process resource detector, which populates process.* attributes. - defaultBehavior: TODO + defaultBehavior: ignore service: $ref: "#/$defs/ExperimentalServiceResourceDetector" description: | Enable the service detector, which populates service.name based on the OTEL_SERVICE_NAME environment variable and service.instance.id. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true ExperimentalContainerResourceDetector: type: diff --git a/schema/tracer_provider.yaml b/schema/tracer_provider.yaml index 042bd06a..289f54c0 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: | @@ -20,7 +20,7 @@ properties: $ref: "#/$defs/ExperimentalTracerConfigurator" description: | Configure tracers. - defaultBehavior: TODO + defaultBehavior: all tracers use default values as described in ExperimentalTracerConfig required: - processors $defs: @@ -79,31 +79,31 @@ $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. - defaultBehavior: TODO + defaultBehavior: v jaeger_remote/development: $ref: "#/$defs/ExperimentalJaegerRemoteSampler" - description: TODO - defaultBehavior: TODO + description: Configure sampler to be jaeger_remote. + defaultBehavior: ignore 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. - defaultBehavior: TODO + defaultBehavior: ignore trace_id_ratio_based: $ref: "#/$defs/TraceIdRatioBasedSampler" description: Configure sampler to be trace_id_ratio_based. - defaultBehavior: TODO + defaultBehavior: ignore isSdkExtensionPlugin: true AlwaysOffSampler: type: @@ -124,20 +124,20 @@ $defs: endpoint: type: - string - - "null" - description: TODO - defaultBehavior: TODO + description: Configure the endpoint of the jaeger remote sampling service. interval: type: - integer - "null" minimum: 0 - description: TODO - defaultBehavior: TODO + description: Configure the polling interval (in milliseconds) to fetch from the remote sampling service. + defaultBehavior: 60000 is used initial_sampler: $ref: "#/$defs/Sampler" - description: TODO - defaultBehavior: TODO + description: Configure the initial sampler used before first configuration is fetched. + required: + - endpoint + - initial_sampler ParentBasedSampler: type: - object @@ -218,23 +218,23 @@ $defs: root: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with no parent. - defaultBehavior: TODO + defaultBehavior: ignore remote_parent_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a remote parent that is sampled. - defaultBehavior: TODO + defaultBehavior: ignore remote_parent_not_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a remote parent that is not sampled. - defaultBehavior: TODO + defaultBehavior: ignore local_parent_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a local parent that is sampled. - defaultBehavior: TODO + defaultBehavior: ignore local_parent_not_sampled: $ref: "#/$defs/ExperimentalComposableSampler" description: Configures the sampler for spans with a local parent that is not sampled. - defaultBehavior: TODO + defaultBehavior: ignore ExperimentalComposableProbabilitySampler: type: - object @@ -262,19 +262,19 @@ $defs: always_off: $ref: "#/$defs/ExperimentalComposableAlwaysOffSampler" description: Configure sampler to be always_off. - defaultBehavior: TODO + defaultBehavior: ignore always_on: $ref: "#/$defs/ExperimentalComposableAlwaysOnSampler" description: Configure sampler to be always_on. - defaultBehavior: TODO + defaultBehavior: ignore parent_based: $ref: "#/$defs/ExperimentalComposableParentBasedSampler" description: Configure sampler to be parent_based. - defaultBehavior: TODO + defaultBehavior: ignore probability: $ref: "#/$defs/ExperimentalComposableProbabilitySampler" description: Configure sampler to be probability. - defaultBehavior: TODO + defaultBehavior: ignore SimpleSpanProcessor: type: object additionalProperties: false @@ -296,24 +296,24 @@ $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: | Configure exporter to be OTLP with file transport. - defaultBehavior: TODO + defaultBehavior: ignore 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: @@ -421,14 +421,14 @@ $defs: default_config: $ref: "#/$defs/ExperimentalTracerConfig" description: Configure the default tracer config used there is no matching entry in .tracer_configurator/development.tracers. - defaultBehavior: TODO + defaultBehavior: unmatched .tracers use default values as described in ExperimentalTracerConfig tracers: type: array minItems: 1 items: $ref: "#/$defs/ExperimentalTracerMatcherAndConfig" description: Configure tracers. - defaultBehavior: TODO + defaultBehavior: all tracers use .default_config ExperimentalTracerMatcherAndConfig: type: - object @@ -457,4 +457,4 @@ $defs: type: - boolean description: Configure if the tracer is enabled or not. - defaultBehavior: TODO + defaultBehavior: false is used