diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52f22c07..65d2aa23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,6 +52,10 @@ To remove redundant information from the configuration file, prefixes for data p Properties defined in the schema should be lower [snake case](https://en.wikipedia.org/wiki/Snake_case). +### Enum value case + +[enum](https://json-schema.org/understanding-json-schema/reference/enum) values should be lower [snake case](https://en.wikipedia.org/wiki/Snake_case). + ### Properties requiring pattern matching When a property requires pattern matching, use wildcard `*` (match any number of any character, including none) and `?` (match any single character) instead of regex. If a single property with wildcards is likely to be insufficient to model the configuration requirements, accept `included` and `excluded` properties, each with an array of strings with wildcard entries. The wildcard entries should be joined with a logical OR. If `included` is not specified, assume that all entries are included. Apply `excluded` after applying `included`. Examples: diff --git a/examples/kitchen-sink.yaml b/examples/kitchen-sink.yaml index 6e53ee1d..3ed951b3 100644 --- a/examples/kitchen-sink.yaml +++ b/examples/kitchen-sink.yaml @@ -9,7 +9,7 @@ # see: https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema-docs.md file_format: "1.0-rc.2" disabled: false -log_level: INFO +log_level: info attribute_limits: attribute_value_length_limit: 4096 attribute_count_limit: 128 @@ -70,7 +70,7 @@ logger_provider: - name: io.opentelemetry.contrib.* config: disabled: false - minimum_severity: INFO + minimum_severity: info trace_based: true meter_provider: readers: @@ -86,7 +86,7 @@ meter_provider: - "service*" excluded: - "service.attr1" - translation_strategy: UnderscoreEscapingWithSuffixes + translation_strategy: underscore_escaping_with_suffixes producers: - opencensus: cardinality_limits: diff --git a/examples/sdk-config.yaml b/examples/sdk-config.yaml index f5d89086..3c8beebb 100644 --- a/examples/sdk-config.yaml +++ b/examples/sdk-config.yaml @@ -9,7 +9,7 @@ # see: https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema-docs.md file_format: "1.0-rc.2" disabled: false -log_level: INFO +log_level: info resource: attributes: - name: service.name diff --git a/examples/sdk-migration-config.yaml b/examples/sdk-migration-config.yaml index a4e8c931..e9ae2e75 100644 --- a/examples/sdk-migration-config.yaml +++ b/examples/sdk-migration-config.yaml @@ -37,7 +37,7 @@ # see: https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema-docs.md file_format: "1.0-rc.2" disabled: ${OTEL_SDK_DISABLED:-false} -log_level: INFO +log_level: info resource: attributes: - name: service.name diff --git a/opentelemetry_configuration.json b/opentelemetry_configuration.json index 8587cad9..c1b18c9b 100644 --- a/opentelemetry_configuration.json +++ b/opentelemetry_configuration.json @@ -18,7 +18,7 @@ }, "log_level": { "$ref": "#/$defs/SeverityNumber", - "description": "Configure the log level of the internal logger used by the SDK.\nValues include:\n* DEBUG: DEBUG, severity number 5.\n* DEBUG2: DEBUG2, severity number 6.\n* DEBUG3: DEBUG3, severity number 7.\n* DEBUG4: DEBUG4, severity number 8.\n* ERROR: ERROR, severity number 17.\n* ERROR2: ERROR2, severity number 18.\n* ERROR3: ERROR3, severity number 19.\n* ERROR4: ERROR4, severity number 20.\n* FATAL: FATAL, severity number 21.\n* FATAL2: FATAL2, severity number 22.\n* FATAL3: FATAL3, severity number 23.\n* FATAL4: FATAL4, severity number 24.\n* INFO: INFO, severity number 9.\n* INFO2: INFO2, severity number 10.\n* INFO3: INFO3, severity number 11.\n* INFO4: INFO4, severity number 12.\n* TRACE: TRACE, severity number 1.\n* TRACE2: TRACE2, severity number 2.\n* TRACE3: TRACE3, severity number 3.\n* TRACE4: TRACE4, severity number 4.\n* WARN: WARN, severity number 13.\n* WARN2: WARN2, severity number 14.\n* WARN3: WARN3, severity number 15.\n* WARN4: WARN4, severity number 16.\nIf omitted, INFO is used.\n" + "description": "Configure the log level of the internal logger used by the SDK.\nValues include:\n* debug: debug, severity number 5.\n* debug2: debug2, severity number 6.\n* debug3: debug3, severity number 7.\n* debug4: debug4, severity number 8.\n* error: error, severity number 17.\n* error2: error2, severity number 18.\n* error3: error3, severity number 19.\n* error4: error4, severity number 20.\n* fatal: fatal, severity number 21.\n* fatal2: fatal2, severity number 22.\n* fatal3: fatal3, severity number 23.\n* fatal4: fatal4, severity number 24.\n* info: info, severity number 9.\n* info2: info2, severity number 10.\n* info3: info3, severity number 11.\n* info4: info4, severity number 12.\n* trace: trace, severity number 1.\n* trace2: trace2, severity number 2.\n* trace3: trace3, severity number 3.\n* trace4: trace4, severity number 4.\n* warn: warn, severity number 13.\n* warn2: warn2, severity number 14.\n* warn3: warn3, severity number 15.\n* warn4: warn4, severity number 16.\nIf omitted, INFO is used.\n" }, "attribute_limits": { "$ref": "#/$defs/AttributeLimits", @@ -427,7 +427,7 @@ }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: TODO\n* explicit_bucket_histogram: TODO\nIf omitted, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: Use base2 exponential histogram as the default aggregation for histogram instruments.\n* explicit_bucket_histogram: Use explicit bucket histogram as the default aggregation for histogram instruments.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -541,7 +541,7 @@ "items": { "$ref": "#/$defs/SpanKind" }, - "description": "The span kinds to match. If the span's kind matches any of these, it matches.\nIf omitted, ignore.\n" + "description": "The span kinds to match. If the span's kind matches any of these, it matches.\nValues include:\n* client: client, a client span.\n* consumer: consumer, a consumer span.\n* internal: internal, an internal span.\n* producer: producer, a producer span.\n* server: server, a server span.\nIf omitted, ignore.\n" }, "parent": { "type": "array", @@ -549,7 +549,7 @@ "items": { "$ref": "#/$defs/ExperimentalSpanParent" }, - "description": "The parent span types to match.\nIf omitted, ignore.\n" + "description": "The parent span types to match.\nValues include:\n* local: local, a local parent.\n* none: none, no parent, i.e., the trace root.\n* remote: remote, a remote parent.\nIf omitted, ignore.\n" }, "sampler": { "$ref": "#/$defs/ExperimentalComposableSampler", @@ -836,7 +836,7 @@ }, "minimum_severity": { "$ref": "#/$defs/SeverityNumber", - "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:\n* DEBUG: DEBUG, severity number 5.\n* DEBUG2: DEBUG2, severity number 6.\n* DEBUG3: DEBUG3, severity number 7.\n* DEBUG4: DEBUG4, severity number 8.\n* ERROR: ERROR, severity number 17.\n* ERROR2: ERROR2, severity number 18.\n* ERROR3: ERROR3, severity number 19.\n* ERROR4: ERROR4, severity number 20.\n* FATAL: FATAL, severity number 21.\n* FATAL2: FATAL2, severity number 22.\n* FATAL3: FATAL3, severity number 23.\n* FATAL4: FATAL4, severity number 24.\n* INFO: INFO, severity number 9.\n* INFO2: INFO2, severity number 10.\n* INFO3: INFO3, severity number 11.\n* INFO4: INFO4, severity number 12.\n* TRACE: TRACE, severity number 1.\n* TRACE2: TRACE2, severity number 2.\n* TRACE3: TRACE3, severity number 3.\n* TRACE4: TRACE4, severity number 4.\n* WARN: WARN, severity number 13.\n* WARN2: WARN2, severity number 14.\n* WARN3: WARN3, severity number 15.\n* WARN4: WARN4, severity number 16.\nIf omitted, 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:\n* debug: debug, severity number 5.\n* debug2: debug2, severity number 6.\n* debug3: debug3, severity number 7.\n* debug4: debug4, severity number 8.\n* error: error, severity number 17.\n* error2: error2, severity number 18.\n* error3: error3, severity number 19.\n* error4: error4, severity number 20.\n* fatal: fatal, severity number 21.\n* fatal2: fatal2, severity number 22.\n* fatal3: fatal3, severity number 23.\n* fatal4: fatal4, severity number 24.\n* info: info, severity number 9.\n* info2: info2, severity number 10.\n* info3: info3, severity number 11.\n* info4: info4, severity number 12.\n* trace: trace, severity number 1.\n* trace2: trace2, severity number 2.\n* trace3: trace3, severity number 3.\n* trace4: trace4, severity number 4.\n* warn: warn, severity number 13.\n* warn2: warn2, severity number 14.\n* warn3: warn3, severity number 15.\n* warn4: warn4, severity number 16.\nIf omitted, severity filtering is not applied.\n" }, "trace_based": { "type": [ @@ -981,7 +981,7 @@ }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: TODO\n* explicit_bucket_histogram: TODO\nIf omitted, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: Use base2 exponential histogram as the default aggregation for histogram instruments.\n* explicit_bucket_histogram: Use explicit bucket histogram as the default aggregation for histogram instruments.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -1083,7 +1083,7 @@ }, "translation_strategy": { "$ref": "#/$defs/ExperimentalPrometheusTranslationStrategy", - "description": "Configure how Prometheus metrics are exposed.\nValues include:\n* NoTranslation: Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered.\n* NoUTF8EscapingWithSuffixes: Special character escaping is disabled. Type and unit suffixes are enabled.\n* UnderscoreEscapingWithoutSuffixes: Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility.\n* UnderscoreEscapingWithSuffixes: Special character escaping is enabled. Type and unit suffixes are enabled.\nIf omitted, UnderscoreEscapingWithSuffixes is used.\n" + "description": "Configure how metric names are translated to Prometheus metric names.\nValues include:\n* no_translation: Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered.\n* no_utf8_escaping_with_suffixes: Special character escaping is disabled. Type and unit suffixes are enabled.\n* underscore_escaping_with_suffixes: Special character escaping is enabled. Type and unit suffixes are enabled.\n* underscore_escaping_without_suffixes: Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility.\nIf omitted, underscore_escaping_with_suffixes is used.\n" } } }, @@ -1093,10 +1093,10 @@ "null" ], "enum": [ - "UnderscoreEscapingWithSuffixes", - "UnderscoreEscapingWithoutSuffixes", - "NoUTF8EscapingWithSuffixes", - "NoTranslation" + "underscore_escaping_with_suffixes", + "underscore_escaping_without_suffixes", + "no_utf8_escaping_with_suffixes", + "no_translation" ] }, "ExperimentalResourceDetection": { @@ -1685,7 +1685,7 @@ }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: TODO\n* explicit_bucket_histogram: TODO\nIf omitted, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: Use base2 exponential histogram as the default aggregation for histogram instruments.\n* explicit_bucket_histogram: Use explicit bucket histogram as the default aggregation for histogram instruments.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -1811,7 +1811,7 @@ }, "default_histogram_aggregation": { "$ref": "#/$defs/ExporterDefaultHistogramAggregation", - "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: TODO\n* explicit_bucket_histogram: TODO\nIf omitted, explicit_bucket_histogram is used.\n" + "description": "Configure default histogram aggregation.\nValues include:\n* base2_exponential_bucket_histogram: Use base2 exponential histogram as the default aggregation for histogram instruments.\n* explicit_bucket_histogram: Use explicit bucket histogram as the default aggregation for histogram instruments.\nIf omitted, explicit_bucket_histogram is used.\n" } } }, @@ -2056,30 +2056,30 @@ "null" ], "enum": [ - "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", + "trace2", + "trace3", + "trace4", + "debug", + "debug2", + "debug3", + "debug4", + "info", + "info2", + "info3", + "info4", + "warn", + "warn2", + "warn3", + "warn4", + "error", + "error2", + "error3", + "error4", + "fatal", + "fatal2", + "fatal3", + "fatal4" ] }, "SimpleLogRecordProcessor": { diff --git a/schema-docs.md b/schema-docs.md index 6bda6cbe..d7e6283e 100644 --- a/schema-docs.md +++ b/schema-docs.md @@ -2783,60 +2783,60 @@ This is a enum type. | Value | Description | |---|---| -| `DEBUG` | DEBUG, severity number 5. | -| `DEBUG2` | DEBUG2, severity number 6. | -| `DEBUG3` | DEBUG3, severity number 7. | -| `DEBUG4` | DEBUG4, severity number 8. | -| `ERROR` | ERROR, severity number 17. | -| `ERROR2` | ERROR2, severity number 18. | -| `ERROR3` | ERROR3, severity number 19. | -| `ERROR4` | ERROR4, severity number 20. | -| `FATAL` | FATAL, severity number 21. | -| `FATAL2` | FATAL2, severity number 22. | -| `FATAL3` | FATAL3, severity number 23. | -| `FATAL4` | FATAL4, severity number 24. | -| `INFO` | INFO, severity number 9. | -| `INFO2` | INFO2, severity number 10. | -| `INFO3` | INFO3, severity number 11. | -| `INFO4` | INFO4, severity number 12. | -| `TRACE` | TRACE, severity number 1. | -| `TRACE2` | TRACE2, severity number 2. | -| `TRACE3` | TRACE3, severity number 3. | -| `TRACE4` | TRACE4, severity number 4. | -| `WARN` | WARN, severity number 13. | -| `WARN2` | WARN2, severity number 14. | -| `WARN3` | WARN3, severity number 15. | -| `WARN4` | WARN4, severity number 16. | +| `debug` | debug, severity number 5. | +| `debug2` | debug2, severity number 6. | +| `debug3` | debug3, severity number 7. | +| `debug4` | debug4, severity number 8. | +| `error` | error, severity number 17. | +| `error2` | error2, severity number 18. | +| `error3` | error3, severity number 19. | +| `error4` | error4, severity number 20. | +| `fatal` | fatal, severity number 21. | +| `fatal2` | fatal2, severity number 22. | +| `fatal3` | fatal3, severity number 23. | +| `fatal4` | fatal4, severity number 24. | +| `info` | info, severity number 9. | +| `info2` | info2, severity number 10. | +| `info3` | info3, severity number 11. | +| `info4` | info4, severity number 12. | +| `trace` | trace, severity number 1. | +| `trace2` | trace2, severity number 2. | +| `trace3` | trace3, severity number 3. | +| `trace4` | trace4, severity number 4. | +| `warn` | warn, severity number 13. | +| `warn2` | warn2, severity number 14. | +| `warn3` | warn3, severity number 15. | +| `warn4` | warn4, severity number 16. |
Language support status | Value | [cpp](#cpp) | [go](#go) | [java](#java) | [js](#js) | |---|---|---|---|---| -| `DEBUG` | unknown | unknown | unknown | unknown | -| `DEBUG2` | unknown | unknown | unknown | unknown | -| `DEBUG3` | unknown | unknown | unknown | unknown | -| `DEBUG4` | unknown | unknown | unknown | unknown | -| `ERROR` | unknown | unknown | unknown | unknown | -| `ERROR2` | unknown | unknown | unknown | unknown | -| `ERROR3` | unknown | unknown | unknown | unknown | -| `ERROR4` | unknown | unknown | unknown | unknown | -| `FATAL` | unknown | unknown | unknown | unknown | -| `FATAL2` | unknown | unknown | unknown | unknown | -| `FATAL3` | unknown | unknown | unknown | unknown | -| `FATAL4` | unknown | unknown | unknown | unknown | -| `INFO` | unknown | unknown | unknown | unknown | -| `INFO2` | unknown | unknown | unknown | unknown | -| `INFO3` | unknown | unknown | unknown | unknown | -| `INFO4` | unknown | unknown | unknown | unknown | -| `TRACE` | unknown | unknown | unknown | unknown | -| `TRACE2` | unknown | unknown | unknown | unknown | -| `TRACE3` | unknown | unknown | unknown | unknown | -| `TRACE4` | unknown | unknown | unknown | unknown | -| `WARN` | unknown | unknown | unknown | unknown | -| `WARN2` | unknown | unknown | unknown | unknown | -| `WARN3` | unknown | unknown | unknown | unknown | -| `WARN4` | unknown | unknown | unknown | unknown | +| `debug` | unknown | unknown | unknown | unknown | +| `debug2` | unknown | unknown | unknown | unknown | +| `debug3` | unknown | unknown | unknown | unknown | +| `debug4` | unknown | unknown | unknown | unknown | +| `error` | unknown | unknown | unknown | unknown | +| `error2` | unknown | unknown | unknown | unknown | +| `error3` | unknown | unknown | unknown | unknown | +| `error4` | unknown | unknown | unknown | unknown | +| `fatal` | unknown | unknown | unknown | unknown | +| `fatal2` | unknown | unknown | unknown | unknown | +| `fatal3` | unknown | unknown | unknown | unknown | +| `fatal4` | unknown | unknown | unknown | unknown | +| `info` | unknown | unknown | unknown | unknown | +| `info2` | unknown | unknown | unknown | unknown | +| `info3` | unknown | unknown | unknown | unknown | +| `info4` | unknown | unknown | unknown | unknown | +| `trace` | unknown | unknown | unknown | unknown | +| `trace2` | unknown | unknown | unknown | unknown | +| `trace3` | unknown | unknown | unknown | unknown | +| `trace4` | unknown | unknown | unknown | unknown | +| `warn` | unknown | unknown | unknown | unknown | +| `warn2` | unknown | unknown | unknown | unknown | +| `warn3` | unknown | unknown | unknown | unknown | +| `warn4` | unknown | unknown | unknown | unknown |
No constraints. @@ -2856,30 +2856,30 @@ Usages: "null" ], "enum": [ - "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", + "trace2", + "trace3", + "trace4", + "debug", + "debug2", + "debug3", + "debug4", + "info", + "info2", + "info3", + "info4", + "warn", + "warn2", + "warn3", + "warn4", + "error", + "error2", + "error3", + "error4", + "fatal", + "fatal2", + "fatal3", + "fatal4" ] } @@ -5140,7 +5140,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. | +| `translation_strategy` | [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | `false` | If omitted, underscore_escaping_with_suffixes is used. | No constraints. | Configure how metric names are translated to Prometheus metric names. | | `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.
| @@ -5220,20 +5220,20 @@ This is a enum type. | Value | Description | |---|---| -| `NoTranslation` | Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered. | -| `NoUTF8EscapingWithSuffixes` | Special character escaping is disabled. Type and unit suffixes are enabled. | -| `UnderscoreEscapingWithoutSuffixes` | Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility. | -| `UnderscoreEscapingWithSuffixes` | Special character escaping is enabled. Type and unit suffixes are enabled. | +| `no_translation` | Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered. | +| `no_utf8_escaping_with_suffixes` | Special character escaping is disabled. Type and unit suffixes are enabled. | +| `underscore_escaping_with_suffixes` | Special character escaping is enabled. Type and unit suffixes are enabled. | +| `underscore_escaping_without_suffixes` | Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility. |
Language support status | Value | [cpp](#cpp) | [go](#go) | [java](#java) | [js](#js) | |---|---|---|---|---| -| `NoTranslation` | unknown | unknown | unknown | unknown | -| `NoUTF8EscapingWithSuffixes` | unknown | unknown | unknown | unknown | -| `UnderscoreEscapingWithoutSuffixes` | unknown | unknown | unknown | unknown | -| `UnderscoreEscapingWithSuffixes` | unknown | unknown | unknown | unknown | +| `no_translation` | unknown | unknown | unknown | unknown | +| `no_utf8_escaping_with_suffixes` | unknown | unknown | unknown | unknown | +| `underscore_escaping_with_suffixes` | unknown | unknown | unknown | unknown | +| `underscore_escaping_without_suffixes` | unknown | unknown | unknown | unknown |
No constraints. @@ -5252,10 +5252,10 @@ Usages: "null" ], "enum": [ - "UnderscoreEscapingWithSuffixes", - "UnderscoreEscapingWithoutSuffixes", - "NoUTF8EscapingWithSuffixes", - "NoTranslation" + "underscore_escaping_with_suffixes", + "underscore_escaping_without_suffixes", + "no_utf8_escaping_with_suffixes", + "no_translation" ] } @@ -5658,7 +5658,7 @@ Latest supported file format: `1.0.0-rc.2` | [`PushMetricExporter`](#pushmetricexporter) | supported | | * `console`: supported
* `otlp_grpc`: supported
* `otlp_http`: supported
* `otlp_file/development`: supported
| | [`Resource`](#resource) | supported | | * `attributes`: supported
* `attributes_list`: supported
* `schema_url`: supported
* `detection/development`: supported
| | [`Sampler`](#sampler) | supported | | * `always_off`: supported
* `always_on`: supported
* `parent_based`: supported
* `trace_id_ratio_based`: supported
* `composite/development`: supported
* `jaeger_remote/development`: supported
* `probability/development`: supported
| -| [`SeverityNumber`](#severitynumber) | unknown | | * `DEBUG`: unknown
* `DEBUG2`: unknown
* `DEBUG3`: unknown
* `DEBUG4`: unknown
* `ERROR`: unknown
* `ERROR2`: unknown
* `ERROR3`: unknown
* `ERROR4`: unknown
* `FATAL`: unknown
* `FATAL2`: unknown
* `FATAL3`: unknown
* `FATAL4`: unknown
* `INFO`: unknown
* `INFO2`: unknown
* `INFO3`: unknown
* `INFO4`: unknown
* `TRACE`: unknown
* `TRACE2`: unknown
* `TRACE3`: unknown
* `TRACE4`: unknown
* `WARN`: unknown
* `WARN2`: unknown
* `WARN3`: unknown
* `WARN4`: unknown
| +| [`SeverityNumber`](#severitynumber) | unknown | | * `debug`: unknown
* `debug2`: unknown
* `debug3`: unknown
* `debug4`: unknown
* `error`: unknown
* `error2`: unknown
* `error3`: unknown
* `error4`: unknown
* `fatal`: unknown
* `fatal2`: unknown
* `fatal3`: unknown
* `fatal4`: unknown
* `info`: unknown
* `info2`: unknown
* `info3`: unknown
* `info4`: unknown
* `trace`: unknown
* `trace2`: unknown
* `trace3`: unknown
* `trace4`: unknown
* `warn`: unknown
* `warn2`: unknown
* `warn3`: unknown
* `warn4`: unknown
| | [`SimpleLogRecordProcessor`](#simplelogrecordprocessor) | supported | | * `exporter`: supported
| | [`SimpleSpanProcessor`](#simplespanprocessor) | supported | | * `exporter`: supported
| | [`SpanExporter`](#spanexporter) | supported | | * `console`: supported
* `otlp_grpc`: supported
* `otlp_http`: supported
* `otlp_file/development`: supported
| @@ -5704,7 +5704,7 @@ Latest supported file format: `1.0.0-rc.2` | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | not_implemented | | * `ratio`: not_implemented
| | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | not_implemented | | | | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | supported | | * `host`: supported
* `port`: supported
* `translation_strategy`: supported
* `with_resource_constant_labels`: supported
* `without_scope_info`: unknown
* `without_target_info`: unknown
| -| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown
* `NoUTF8EscapingWithSuffixes`: unknown
* `UnderscoreEscapingWithoutSuffixes`: unknown
* `UnderscoreEscapingWithSuffixes`: unknown
| +| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `no_translation`: unknown
* `no_utf8_escaping_with_suffixes`: unknown
* `underscore_escaping_with_suffixes`: unknown
* `underscore_escaping_without_suffixes`: unknown
| | [`ExperimentalResourceDetection`](#experimentalresourcedetection) | not_implemented | | * `attributes`: not_implemented
* `detectors`: not_implemented
| | [`ExperimentalResourceDetector`](#experimentalresourcedetector) | not_implemented | | * `container`: not_implemented
* `host`: not_implemented
* `process`: not_implemented
* `service`: not_implemented
| | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | not_implemented | | | @@ -5771,7 +5771,7 @@ Latest supported file format: `0.3.0` | [`PushMetricExporter`](#pushmetricexporter) | unknown | | * `console`: unknown
* `otlp_grpc`: unknown
* `otlp_http`: unknown
* `otlp_file/development`: unknown
| | [`Resource`](#resource) | unknown | | * `attributes`: unknown
* `attributes_list`: unknown
* `schema_url`: unknown
* `detection/development`: unknown
| | [`Sampler`](#sampler) | unknown | | * `always_off`: unknown
* `always_on`: unknown
* `parent_based`: unknown
* `trace_id_ratio_based`: unknown
* `composite/development`: unknown
* `jaeger_remote/development`: unknown
* `probability/development`: unknown
| -| [`SeverityNumber`](#severitynumber) | unknown | | * `DEBUG`: unknown
* `DEBUG2`: unknown
* `DEBUG3`: unknown
* `DEBUG4`: unknown
* `ERROR`: unknown
* `ERROR2`: unknown
* `ERROR3`: unknown
* `ERROR4`: unknown
* `FATAL`: unknown
* `FATAL2`: unknown
* `FATAL3`: unknown
* `FATAL4`: unknown
* `INFO`: unknown
* `INFO2`: unknown
* `INFO3`: unknown
* `INFO4`: unknown
* `TRACE`: unknown
* `TRACE2`: unknown
* `TRACE3`: unknown
* `TRACE4`: unknown
* `WARN`: unknown
* `WARN2`: unknown
* `WARN3`: unknown
* `WARN4`: unknown
| +| [`SeverityNumber`](#severitynumber) | unknown | | * `debug`: unknown
* `debug2`: unknown
* `debug3`: unknown
* `debug4`: unknown
* `error`: unknown
* `error2`: unknown
* `error3`: unknown
* `error4`: unknown
* `fatal`: unknown
* `fatal2`: unknown
* `fatal3`: unknown
* `fatal4`: unknown
* `info`: unknown
* `info2`: unknown
* `info3`: unknown
* `info4`: unknown
* `trace`: unknown
* `trace2`: unknown
* `trace3`: unknown
* `trace4`: unknown
* `warn`: unknown
* `warn2`: unknown
* `warn3`: unknown
* `warn4`: unknown
| | [`SimpleLogRecordProcessor`](#simplelogrecordprocessor) | unknown | | * `exporter`: unknown
| | [`SimpleSpanProcessor`](#simplespanprocessor) | unknown | | * `exporter`: unknown
| | [`SpanExporter`](#spanexporter) | unknown | | * `console`: unknown
* `otlp_grpc`: unknown
* `otlp_http`: unknown
* `otlp_file/development`: unknown
| @@ -5817,7 +5817,7 @@ Latest supported file format: `0.3.0` | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | unknown | | * `ratio`: unknown
| | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | unknown | | | | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | unknown | | * `host`: unknown
* `port`: unknown
* `translation_strategy`: unknown
* `with_resource_constant_labels`: unknown
* `without_scope_info`: unknown
* `without_target_info`: unknown
| -| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown
* `NoUTF8EscapingWithSuffixes`: unknown
* `UnderscoreEscapingWithoutSuffixes`: unknown
* `UnderscoreEscapingWithSuffixes`: unknown
| +| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `no_translation`: unknown
* `no_utf8_escaping_with_suffixes`: unknown
* `underscore_escaping_with_suffixes`: unknown
* `underscore_escaping_without_suffixes`: unknown
| | [`ExperimentalResourceDetection`](#experimentalresourcedetection) | unknown | | * `attributes`: unknown
* `detectors`: unknown
| | [`ExperimentalResourceDetector`](#experimentalresourcedetector) | unknown | | * `container`: unknown
* `host`: unknown
* `process`: unknown
* `service`: unknown
| | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | unknown | | | @@ -5884,7 +5884,7 @@ Latest supported file format: `1.0.0-rc.1` | [`PushMetricExporter`](#pushmetricexporter) | supported | | * `console`: supported
* `otlp_grpc`: supported
* `otlp_http`: supported
* `otlp_file/development`: supported
| | [`Resource`](#resource) | supported | | * `attributes`: supported
* `attributes_list`: supported
* `schema_url`: ignored
* `detection/development`: supported
| | [`Sampler`](#sampler) | supported | | * `always_off`: supported
* `always_on`: supported
* `parent_based`: supported
* `trace_id_ratio_based`: supported
* `composite/development`: supported
* `jaeger_remote/development`: supported
* `probability/development`: ignored
| -| [`SeverityNumber`](#severitynumber) | unknown | | * `DEBUG`: unknown
* `DEBUG2`: unknown
* `DEBUG3`: unknown
* `DEBUG4`: unknown
* `ERROR`: unknown
* `ERROR2`: unknown
* `ERROR3`: unknown
* `ERROR4`: unknown
* `FATAL`: unknown
* `FATAL2`: unknown
* `FATAL3`: unknown
* `FATAL4`: unknown
* `INFO`: unknown
* `INFO2`: unknown
* `INFO3`: unknown
* `INFO4`: unknown
* `TRACE`: unknown
* `TRACE2`: unknown
* `TRACE3`: unknown
* `TRACE4`: unknown
* `WARN`: unknown
* `WARN2`: unknown
* `WARN3`: unknown
* `WARN4`: unknown
| +| [`SeverityNumber`](#severitynumber) | unknown | | * `debug`: unknown
* `debug2`: unknown
* `debug3`: unknown
* `debug4`: unknown
* `error`: unknown
* `error2`: unknown
* `error3`: unknown
* `error4`: unknown
* `fatal`: unknown
* `fatal2`: unknown
* `fatal3`: unknown
* `fatal4`: unknown
* `info`: unknown
* `info2`: unknown
* `info3`: unknown
* `info4`: unknown
* `trace`: unknown
* `trace2`: unknown
* `trace3`: unknown
* `trace4`: unknown
* `warn`: unknown
* `warn2`: unknown
* `warn3`: unknown
* `warn4`: unknown
| | [`SimpleLogRecordProcessor`](#simplelogrecordprocessor) | supported | | * `exporter`: supported
| | [`SimpleSpanProcessor`](#simplespanprocessor) | supported | | * `exporter`: supported
| | [`SpanExporter`](#spanexporter) | supported | | * `console`: supported
* `otlp_grpc`: supported
* `otlp_http`: supported
* `otlp_file/development`: supported
| @@ -5930,7 +5930,7 @@ Latest supported file format: `1.0.0-rc.1` | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | ignored | | * `ratio`: ignored
| | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | supported | | | | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | supported | | * `host`: supported
* `port`: supported
* `translation_strategy`: not_implemented
* `with_resource_constant_labels`: supported
* `without_scope_info`: ignored
* `without_target_info`: ignored
| -| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown
* `NoUTF8EscapingWithSuffixes`: unknown
* `UnderscoreEscapingWithoutSuffixes`: unknown
* `UnderscoreEscapingWithSuffixes`: unknown
| +| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `no_translation`: unknown
* `no_utf8_escaping_with_suffixes`: unknown
* `underscore_escaping_with_suffixes`: unknown
* `underscore_escaping_without_suffixes`: unknown
| | [`ExperimentalResourceDetection`](#experimentalresourcedetection) | supported | | * `attributes`: supported
* `detectors`: supported
| | [`ExperimentalResourceDetector`](#experimentalresourcedetector) | supported | | * `container`: supported
* `host`: supported
* `process`: supported
* `service`: supported
| | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | supported | | | @@ -5997,7 +5997,7 @@ Latest supported file format: `1.0.0-rc.2` | [`PushMetricExporter`](#pushmetricexporter) | unknown | | * `console`: unknown
* `otlp_grpc`: unknown
* `otlp_http`: unknown
* `otlp_file/development`: unknown
| | [`Resource`](#resource) | unknown | | * `attributes`: unknown
* `attributes_list`: unknown
* `schema_url`: unknown
* `detection/development`: unknown
| | [`Sampler`](#sampler) | unknown | | * `always_off`: unknown
* `always_on`: unknown
* `parent_based`: unknown
* `trace_id_ratio_based`: unknown
* `composite/development`: unknown
* `jaeger_remote/development`: unknown
* `probability/development`: unknown
| -| [`SeverityNumber`](#severitynumber) | unknown | | * `DEBUG`: unknown
* `DEBUG2`: unknown
* `DEBUG3`: unknown
* `DEBUG4`: unknown
* `ERROR`: unknown
* `ERROR2`: unknown
* `ERROR3`: unknown
* `ERROR4`: unknown
* `FATAL`: unknown
* `FATAL2`: unknown
* `FATAL3`: unknown
* `FATAL4`: unknown
* `INFO`: unknown
* `INFO2`: unknown
* `INFO3`: unknown
* `INFO4`: unknown
* `TRACE`: unknown
* `TRACE2`: unknown
* `TRACE3`: unknown
* `TRACE4`: unknown
* `WARN`: unknown
* `WARN2`: unknown
* `WARN3`: unknown
* `WARN4`: unknown
| +| [`SeverityNumber`](#severitynumber) | unknown | | * `debug`: unknown
* `debug2`: unknown
* `debug3`: unknown
* `debug4`: unknown
* `error`: unknown
* `error2`: unknown
* `error3`: unknown
* `error4`: unknown
* `fatal`: unknown
* `fatal2`: unknown
* `fatal3`: unknown
* `fatal4`: unknown
* `info`: unknown
* `info2`: unknown
* `info3`: unknown
* `info4`: unknown
* `trace`: unknown
* `trace2`: unknown
* `trace3`: unknown
* `trace4`: unknown
* `warn`: unknown
* `warn2`: unknown
* `warn3`: unknown
* `warn4`: unknown
| | [`SimpleLogRecordProcessor`](#simplelogrecordprocessor) | unknown | | * `exporter`: unknown
| | [`SimpleSpanProcessor`](#simplespanprocessor) | unknown | | * `exporter`: unknown
| | [`SpanExporter`](#spanexporter) | unknown | | * `console`: unknown
* `otlp_grpc`: unknown
* `otlp_http`: unknown
* `otlp_file/development`: unknown
| @@ -6043,7 +6043,7 @@ Latest supported file format: `1.0.0-rc.2` | [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | unknown | | * `ratio`: unknown
| | [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | unknown | | | | [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | unknown | | * `host`: unknown
* `port`: unknown
* `translation_strategy`: unknown
* `with_resource_constant_labels`: unknown
* `without_scope_info`: unknown
* `without_target_info`: unknown
| -| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown
* `NoUTF8EscapingWithSuffixes`: unknown
* `UnderscoreEscapingWithoutSuffixes`: unknown
* `UnderscoreEscapingWithSuffixes`: unknown
| +| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `no_translation`: unknown
* `no_utf8_escaping_with_suffixes`: unknown
* `underscore_escaping_with_suffixes`: unknown
* `underscore_escaping_without_suffixes`: unknown
| | [`ExperimentalResourceDetection`](#experimentalresourcedetection) | unknown | | * `attributes`: unknown
* `detectors`: unknown
| | [`ExperimentalResourceDetector`](#experimentalresourcedetector) | unknown | | * `container`: unknown
* `host`: unknown
* `process`: unknown
* `service`: unknown
| | [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | unknown | | | diff --git a/schema/common.yaml b/schema/common.yaml index cf052450..ddf85390 100644 --- a/schema/common.yaml +++ b/schema/common.yaml @@ -251,52 +251,52 @@ $defs: - string - "null" enum: - - 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 + - trace2 + - trace3 + - trace4 + - debug + - debug2 + - debug3 + - debug4 + - info + - info2 + - info3 + - info4 + - warn + - warn2 + - warn3 + - warn4 + - error + - error2 + - error3 + - error4 + - fatal + - fatal2 + - fatal3 + - fatal4 enumDescriptions: - DEBUG: DEBUG, severity number 5. - DEBUG2: DEBUG2, severity number 6. - DEBUG3: DEBUG3, severity number 7. - DEBUG4: DEBUG4, severity number 8. - ERROR: ERROR, severity number 17. - ERROR2: ERROR2, severity number 18. - ERROR3: ERROR3, severity number 19. - ERROR4: ERROR4, severity number 20. - FATAL: FATAL, severity number 21. - FATAL2: FATAL2, severity number 22. - FATAL3: FATAL3, severity number 23. - FATAL4: FATAL4, severity number 24. - INFO: INFO, severity number 9. - INFO2: INFO2, severity number 10. - INFO3: INFO3, severity number 11. - INFO4: INFO4, severity number 12. - TRACE: TRACE, severity number 1. - TRACE2: TRACE2, severity number 2. - TRACE3: TRACE3, severity number 3. - TRACE4: TRACE4, severity number 4. - WARN: WARN, severity number 13. - WARN2: WARN2, severity number 14. - WARN3: WARN3, severity number 15. - WARN4: WARN4, severity number 16. + debug: debug, severity number 5. + debug2: debug2, severity number 6. + debug3: debug3, severity number 7. + debug4: debug4, severity number 8. + error: error, severity number 17. + error2: error2, severity number 18. + error3: error3, severity number 19. + error4: error4, severity number 20. + fatal: fatal, severity number 21. + fatal2: fatal2, severity number 22. + fatal3: fatal3, severity number 23. + fatal4: fatal4, severity number 24. + info: info, severity number 9. + info2: info2, severity number 10. + info3: info3, severity number 11. + info4: info4, severity number 12. + trace: trace, severity number 1. + trace2: trace2, severity number 2. + trace3: trace3, severity number 3. + trace4: trace4, severity number 4. + warn: warn, severity number 13. + warn2: warn2, severity number 14. + warn3: warn3, severity number 15. + warn4: warn4, severity number 16. diff --git a/schema/meter_provider.yaml b/schema/meter_provider.yaml index b2f3e2b8..1b380f39 100644 --- a/schema/meter_provider.yaml +++ b/schema/meter_provider.yaml @@ -272,22 +272,22 @@ $defs: defaultBehavior: no resource attributes are added translation_strategy: $ref: "#/$defs/ExperimentalPrometheusTranslationStrategy" - description: Configure how Prometheus metrics are exposed. - defaultBehavior: UnderscoreEscapingWithSuffixes is used + description: Configure how metric names are translated to Prometheus metric names. + defaultBehavior: underscore_escaping_with_suffixes is used ExperimentalPrometheusTranslationStrategy: type: - string - "null" enum: - - UnderscoreEscapingWithSuffixes - - UnderscoreEscapingWithoutSuffixes - - NoUTF8EscapingWithSuffixes - - NoTranslation + - underscore_escaping_with_suffixes + - underscore_escaping_without_suffixes + - no_utf8_escaping_with_suffixes + - no_translation enumDescriptions: - NoTranslation: Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered. - NoUTF8EscapingWithSuffixes: Special character escaping is disabled. Type and unit suffixes are enabled. - UnderscoreEscapingWithoutSuffixes: Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility. - UnderscoreEscapingWithSuffixes: Special character escaping is enabled. Type and unit suffixes are enabled. + no_translation: Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered. + no_utf8_escaping_with_suffixes: Special character escaping is disabled. Type and unit suffixes are enabled. + underscore_escaping_without_suffixes: Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility. + underscore_escaping_with_suffixes: Special character escaping is enabled. Type and unit suffixes are enabled. MetricReader: type: object additionalProperties: false