Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 68 additions & 21 deletions schema-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2037,19 +2037,22 @@ Usages:
"$ref": "common.json#/$defs/IncludeExclude"
},
"translation_strategy": {
"type": [
"string",
"null"
],
"enum": [
"UnderscoreEscapingWithSuffixes",
"UnderscoreEscapingWithoutSuffixes",
"NoUTF8EscapingWithSuffixes",
"NoTranslation"
]
"$ref": "#/$defs/ExperimentalPrometheusTranslationStrategy"
}
}
},
"ExperimentalPrometheusTranslationStrategy": {
"type": [
"string",
"null"
],
"enum": [
"UnderscoreEscapingWithSuffixes",
"UnderscoreEscapingWithoutSuffixes",
"NoUTF8EscapingWithSuffixes",
"NoTranslation"
]
},
"MetricReader": {
"type": "object",
"additionalProperties": false,
Expand Down Expand Up @@ -6508,7 +6511,7 @@ Usages:
|---|---|---|---|---|
| `host` | one of:<br>* `string`<br>* `null`<br> | `false` | No constraints. | Configure host.<br>If omitted or null, localhost is used.<br> |
| `port` | one of:<br>* `integer`<br>* `null`<br> | `false` | No constraints. | Configure port.<br>If omitted or null, 9464 is used.<br> |
| `translation_strategy` | one of:<br>* `string`<br>* `null`<br> | `false` | No constraints. | Configure how Prometheus metrics are exposed. Values include:<br><br> * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.<br> * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.<br> * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.<br> * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.<br><br>If omitted or null, UnderscoreEscapingWithSuffixes is used.<br> |
| `translation_strategy` | [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | `false` | No constraints. | Configure how Prometheus metrics are exposed. Values include:<br><br> * UnderscoreEscapingWithSuffixes, the default. This fully escapes metric names for classic Prometheus metric name compatibility, and includes appending type and unit suffixes.<br> * UnderscoreEscapingWithoutSuffixes, metric names will continue to escape special characters to _, but suffixes won't be attached.<br> * NoUTF8EscapingWithSuffixes will disable changing special characters to _. Special suffixes like units and _total for counters will be attached.<br> * NoTranslation. This strategy bypasses all metric and label name translation, passing them through unaltered.<br><br>If omitted or null, UnderscoreEscapingWithSuffixes is used.<br> |
| `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:<br>* `boolean`<br>* `null`<br> | `false` | No constraints. | Configure Prometheus Exporter to produce metrics without a scope info metric.<br>If omitted or null, false is used.<br> |
| `without_target_info` | one of:<br>* `boolean`<br>* `null`<br> | `false` | No constraints. | Configure Prometheus Exporter to produce metrics without a target info metric for the resource.<br>If omitted or null, false is used.<br> |
Expand Down Expand Up @@ -6573,21 +6576,61 @@ Usages:
"$ref": "common.json#/$defs/IncludeExclude"
},
"translation_strategy": {
"type": [
"string",
"null"
],
"enum": [
"UnderscoreEscapingWithSuffixes",
"UnderscoreEscapingWithoutSuffixes",
"NoUTF8EscapingWithSuffixes",
"NoTranslation"
]
"$ref": "#/$defs/ExperimentalPrometheusTranslationStrategy"
}
}
}</pre>
</details>

## ExperimentalPrometheusTranslationStrategy <a id="experimentalprometheustranslationstrategy"></a>

> [!WARNING]
> This type is [experimental](README.md#experimental-features).

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. |

<details>
<summary>Language support status</summary>

| 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 |
</details>

No constraints.

Usages:

* [`ExperimentalPrometheusMetricExporter.translation_strategy`](#experimentalprometheusmetricexporter)

<details>
<summary>JSON Schema</summary>

[JSON Schema Source File](./schema/meter_provider.json)
<pre>{
"type": [
"string",
"null"
],
"enum": [
"UnderscoreEscapingWithSuffixes",
"UnderscoreEscapingWithoutSuffixes",
"NoUTF8EscapingWithSuffixes",
"NoTranslation"
]
}</pre>
</details>

## ExperimentalResourceDetection <a id="experimentalresourcedetection"></a>

> [!WARNING]
Expand Down Expand Up @@ -7090,6 +7133,7 @@ Latest supported file format: `1.0.0-rc.2`
| [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | not_implemented | | * `ratio`: not_implemented<br> |
| [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | not_implemented | | |
| [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | supported | | * `host`: supported<br>* `port`: supported<br>* `translation_strategy`: supported<br>* `with_resource_constant_labels`: supported<br>* `without_scope_info`: unknown<br>* `without_target_info`: unknown<br> |
| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown<br>* `NoUTF8EscapingWithSuffixes`: unknown<br>* `UnderscoreEscapingWithoutSuffixes`: unknown<br>* `UnderscoreEscapingWithSuffixes`: unknown<br> |
| [`ExperimentalResourceDetection`](#experimentalresourcedetection) | not_implemented | | * `attributes`: not_implemented<br>* `detectors`: not_implemented<br> |
| [`ExperimentalResourceDetector`](#experimentalresourcedetector) | not_implemented | | * `container`: not_implemented<br>* `host`: not_implemented<br>* `process`: not_implemented<br>* `service`: not_implemented<br> |
| [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | not_implemented | | |
Expand Down Expand Up @@ -7197,6 +7241,7 @@ Latest supported file format: `0.3.0`
| [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | unknown | | * `ratio`: unknown<br> |
| [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | unknown | | |
| [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | unknown | | * `host`: unknown<br>* `port`: unknown<br>* `translation_strategy`: unknown<br>* `with_resource_constant_labels`: unknown<br>* `without_scope_info`: unknown<br>* `without_target_info`: unknown<br> |
| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown<br>* `NoUTF8EscapingWithSuffixes`: unknown<br>* `UnderscoreEscapingWithoutSuffixes`: unknown<br>* `UnderscoreEscapingWithSuffixes`: unknown<br> |
| [`ExperimentalResourceDetection`](#experimentalresourcedetection) | unknown | | * `attributes`: unknown<br>* `detectors`: unknown<br> |
| [`ExperimentalResourceDetector`](#experimentalresourcedetector) | unknown | | * `container`: unknown<br>* `host`: unknown<br>* `process`: unknown<br>* `service`: unknown<br> |
| [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | unknown | | |
Expand Down Expand Up @@ -7304,6 +7349,7 @@ Latest supported file format: `1.0.0-rc.1`
| [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | ignored | | * `ratio`: ignored<br> |
| [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | supported | | |
| [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | supported | | * `host`: supported<br>* `port`: supported<br>* `translation_strategy`: not_implemented<br>* `with_resource_constant_labels`: supported<br>* `without_scope_info`: ignored<br>* `without_target_info`: ignored<br> |
| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown<br>* `NoUTF8EscapingWithSuffixes`: unknown<br>* `UnderscoreEscapingWithoutSuffixes`: unknown<br>* `UnderscoreEscapingWithSuffixes`: unknown<br> |
| [`ExperimentalResourceDetection`](#experimentalresourcedetection) | supported | | * `attributes`: supported<br>* `detectors`: supported<br> |
| [`ExperimentalResourceDetector`](#experimentalresourcedetector) | supported | | * `container`: supported<br>* `host`: supported<br>* `process`: supported<br>* `service`: supported<br> |
| [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | supported | | |
Expand Down Expand Up @@ -7411,6 +7457,7 @@ Latest supported file format: `1.0.0-rc.2`
| [`ExperimentalProbabilitySampler`](#experimentalprobabilitysampler) | unknown | | * `ratio`: unknown<br> |
| [`ExperimentalProcessResourceDetector`](#experimentalprocessresourcedetector) | unknown | | |
| [`ExperimentalPrometheusMetricExporter`](#experimentalprometheusmetricexporter) | unknown | | * `host`: unknown<br>* `port`: unknown<br>* `translation_strategy`: unknown<br>* `with_resource_constant_labels`: unknown<br>* `without_scope_info`: unknown<br>* `without_target_info`: unknown<br> |
| [`ExperimentalPrometheusTranslationStrategy`](#experimentalprometheustranslationstrategy) | unknown | | * `NoTranslation`: unknown<br>* `NoUTF8EscapingWithSuffixes`: unknown<br>* `UnderscoreEscapingWithoutSuffixes`: unknown<br>* `UnderscoreEscapingWithSuffixes`: unknown<br> |
| [`ExperimentalResourceDetection`](#experimentalresourcedetection) | unknown | | * `attributes`: unknown<br>* `detectors`: unknown<br> |
| [`ExperimentalResourceDetector`](#experimentalresourcedetector) | unknown | | * `container`: unknown<br>* `host`: unknown<br>* `process`: unknown<br>* `service`: unknown<br> |
| [`ExperimentalServiceResourceDetector`](#experimentalserviceresourcedetector) | unknown | | |
Expand Down
3 changes: 3 additions & 0 deletions schema/meta_schema_language_cpp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,9 @@ typeSupportStatuses:
status: unknown
- property: without_target_info
status: unknown
- type: ExperimentalPrometheusTranslationStrategy
status: unknown
enumOverrides: []
- type: ExperimentalResourceDetection
status: not_implemented
propertyOverrides: []
Expand Down
3 changes: 3 additions & 0 deletions schema/meta_schema_language_go.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,9 @@ typeSupportStatuses:
- type: ExperimentalPrometheusMetricExporter
status: unknown
propertyOverrides: []
- type: ExperimentalPrometheusTranslationStrategy
status: unknown
enumOverrides: []
- type: ExperimentalResourceDetection
status: unknown
propertyOverrides: []
Expand Down
3 changes: 3 additions & 0 deletions schema/meta_schema_language_java.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,9 @@ typeSupportStatuses:
status: ignored
- property: without_target_info
status: ignored
- type: ExperimentalPrometheusTranslationStrategy
status: unknown
enumOverrides: []
- type: ExperimentalResourceDetection
status: supported
propertyOverrides: []
Expand Down
3 changes: 3 additions & 0 deletions schema/meta_schema_language_js.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,9 @@ typeSupportStatuses:
- type: ExperimentalPrometheusMetricExporter
status: unknown
propertyOverrides: []
- type: ExperimentalPrometheusTranslationStrategy
status: unknown
enumOverrides: []
- type: ExperimentalResourceDetection
status: unknown
propertyOverrides: []
Expand Down
11 changes: 11 additions & 0 deletions schema/meta_schema_types.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1166,6 +1166,17 @@
Configure Prometheus Exporter to produce metrics without a target info metric for the resource.
If omitted or null, false is used.
isSdkExtensionPlugin: false
- type: ExperimentalPrometheusTranslationStrategy
enumValues:
- enumValue: NoTranslation
description: Special character escaping is disabled. Type and unit suffixes are disabled. Metric names are unaltered.
- enumValue: NoUTF8EscapingWithSuffixes
description: Special character escaping is disabled. Type and unit suffixes are enabled.
- enumValue: UnderscoreEscapingWithoutSuffixes
description: Special character escaping is enabled. Type and unit suffixes are disabled. This represents classic Prometheus metric name compatibility.
- enumValue: UnderscoreEscapingWithSuffixes
description: Special character escaping is enabled. Type and unit suffixes are enabled.
isSdkExtensionPlugin: false
- type: ExperimentalResourceDetection
properties:
- property: attributes
Expand Down
17 changes: 10 additions & 7 deletions schema/meter_provider.json
Original file line number Diff line number Diff line change
Expand Up @@ -199,16 +199,19 @@
"$ref": "common.json#/$defs/IncludeExclude"
},
"translation_strategy": {
"type": ["string", "null"],
"enum": [
"UnderscoreEscapingWithSuffixes",
"UnderscoreEscapingWithoutSuffixes",
"NoUTF8EscapingWithSuffixes",
"NoTranslation"
]
"$ref": "#/$defs/ExperimentalPrometheusTranslationStrategy"
}
}
},
"ExperimentalPrometheusTranslationStrategy": {
"type": ["string", "null"],
"enum": [
"UnderscoreEscapingWithSuffixes",
"UnderscoreEscapingWithoutSuffixes",
"NoUTF8EscapingWithSuffixes",
"NoTranslation"
]
},
"MetricReader": {
"type": "object",
"additionalProperties": false,
Expand Down
Loading