Skip to content

Commit c24d3f4

Browse files
committed
Update docs
1 parent 8d37bda commit c24d3f4

File tree

4 files changed

+22
-0
lines changed

4 files changed

+22
-0
lines changed

cmd/mimir/config-descriptor.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5703,6 +5703,17 @@
57035703
"fieldType": "boolean",
57045704
"fieldCategory": "experimental"
57055705
},
5706+
{
5707+
"kind": "field",
5708+
"name": "otel_native_delta_ingestion",
5709+
"required": false,
5710+
"desc": "Whether to enable native ingestion of delta OTLP metrics, which will store the raw delta sample values without conversion. If disabled, delta metrics will be rejected. Delta support is in an early stage of development. The ingestion and querying process is likely to change over time.",
5711+
"fieldValue": null,
5712+
"fieldDefaultValue": false,
5713+
"fieldFlag": "distributor.otel-native-delta-ingestion",
5714+
"fieldType": "boolean",
5715+
"fieldCategory": "experimental"
5716+
},
57065717
{
57075718
"kind": "field",
57085719
"name": "ingest_storage_read_consistency",

cmd/mimir/help-all.txt.tmpl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,6 +1425,8 @@ Usage of ./cmd/mimir/mimir:
14251425
[experimental] Whether to keep identifying OTel resource attributes in the target_info metric on top of converting to job and instance labels.
14261426
-distributor.otel-metric-suffixes-enabled
14271427
Whether to enable automatic suffixes to names of metrics ingested through OTLP.
1428+
-distributor.otel-native-delta-ingestion
1429+
[experimental] Whether to enable native ingestion of delta OTLP metrics, which will store the raw delta sample values without conversion. If disabled, delta metrics will be rejected. Delta support is in an early stage of development. The ingestion and querying process is likely to change over time.
14281430
-distributor.otel-promote-resource-attributes comma-separated-list-of-strings
14291431
[experimental] Optionally specify OTel resource attributes to promote to labels.
14301432
-distributor.remote-timeout duration

docs/sources/mimir/configure/about-versioning.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ The following features are currently experimental:
112112
- `-distributor.otel-keep-identifying-resource-attributes`
113113
- Enable conversion of OTel explicit bucket histograms into native histograms with custom buckets.
114114
- `-distributor.otel-convert-histograms-to-nhcb`
115+
- Whether to enable native ingestion of delta OTLP metrics. Currently, this means storing the raw delta sample values without converting them to cumulative and having the metric type set to "Unknown". Delta support is in an early stage of development. The ingestion and querying process is likely to change over time. Considerations around querying and gotchas can be found in the [corresponding Prometheus documentation](https://prometheus.io/docs/prometheus/3.4/feature_flags/#otlp-native-delta-support).
116+
- `distributor.otel-native-delta-ingestion`
115117
- Hash ring
116118
- Disabling ring heartbeat timeouts
117119
- `-distributor.ring.heartbeat-timeout=0`

docs/sources/mimir/configure/configuration-parameters/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4114,6 +4114,13 @@ ruler_alertmanager_client_config:
41144114
# CLI flag: -distributor.otel-convert-histograms-to-nhcb
41154115
[otel_convert_histograms_to_nhcb: <boolean> | default = false]
41164116

4117+
# (experimental) Whether to enable native ingestion of delta OTLP metrics, which
4118+
# will store the raw delta sample values without conversion. If disabled, delta
4119+
# metrics will be rejected. Delta support is in an early stage of development.
4120+
# The ingestion and querying process is likely to change over time.
4121+
# CLI flag: -distributor.otel-native-delta-ingestion
4122+
[otel_native_delta_ingestion: <boolean> | default = false]
4123+
41174124
# (experimental) The default consistency level to enforce for queries when using
41184125
# the ingest storage. Supports values: strong, eventual.
41194126
# CLI flag: -ingest-storage.read-consistency

0 commit comments

Comments
 (0)