Small improvements to out-of-order ingestion docs (#11366)

Signed-off-by: Julius Volz <julius.volz@gmail.com>

Signed-off-by: Julius Volz <julius.volz@gmail.com>
This commit is contained in:
Julius Volz 2022-09-30 09:13:32 +02:00 committed by GitHub
parent 8dbb2eaf0b
commit fbec3bfc90
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -458,7 +458,7 @@ subscription_id: <string>
# Optional client secret. Only required with authentication_method OAuth. # Optional client secret. Only required with authentication_method OAuth.
[ client_secret: <secret> ] [ client_secret: <secret> ]
# Optional resource group name. Limits discovery to this resource group. # Optional resource group name. Limits discovery to this resource group.
[ resource_group: <string> ] [ resource_group: <string> ]
# Refresh interval to re-read the instance list. # Refresh interval to re-read the instance list.
@ -1505,8 +1505,8 @@ Example response body:
``` ```
The endpoint is queried periodically at the specified refresh interval. The endpoint is queried periodically at the specified refresh interval.
The `prometheus_sd_http_failures_total` counter metric tracks the number of The `prometheus_sd_http_failures_total` counter metric tracks the number of
refresh failures. refresh failures.
Each target has a meta label `__meta_url` during the Each target has a meta label `__meta_url` during the
[relabeling phase](#relabel_config). Its value is set to the [relabeling phase](#relabel_config). Its value is set to the
@ -1568,7 +1568,7 @@ following meta labels are available on all targets during
[relabeling](#relabel_config): [relabeling](#relabel_config):
* `__meta_ionos_server_availability_zone`: the availability zone of the server * `__meta_ionos_server_availability_zone`: the availability zone of the server
* `__meta_ionos_server_boot_cdrom_id`: the ID of the CD-ROM the server is booted * `__meta_ionos_server_boot_cdrom_id`: the ID of the CD-ROM the server is booted
from from
* `__meta_ionos_server_boot_image_id`: the ID of the boot image or snapshot the * `__meta_ionos_server_boot_image_id`: the ID of the boot image or snapshot the
server is booted from server is booted from
@ -1871,8 +1871,8 @@ namespaces:
# Optional metadata to attach to discovered targets. If omitted, no additional metadata is attached. # Optional metadata to attach to discovered targets. If omitted, no additional metadata is attached.
attach_metadata: attach_metadata:
# Attaches node metadata to discovered targets. Valid for roles: pod, endpoints, endpointslice. # Attaches node metadata to discovered targets. Valid for roles: pod, endpoints, endpointslice.
# When set to true, Prometheus must have permissions to get Nodes. # When set to true, Prometheus must have permissions to get Nodes.
[ node: <boolean> | default = false ] [ node: <boolean> | default = false ]
``` ```
@ -3198,18 +3198,18 @@ with this feature.
### `<tsdb>` ### `<tsdb>`
`tsdb` lets you config the runtime reloadable configuration of the TSDB. `tsdb` lets you configure the runtime-reloadable configuration settings of the TSDB.
NOTE: Out of order ingestion is an experimental feature, but you do not need any additional flag to enable it. Setting `out_of_order_time_window` to a positive duration enables it. NOTE: Out-of-order ingestion is an experimental feature, but you do not need any additional flag to enable it. Setting `out_of_order_time_window` to a positive duration enables it.
```yaml ```yaml
# Configures how old an out-of-order/out-of-bounds sample can be w.r.t. the TSDB max time. # Configures how old an out-of-order/out-of-bounds sample can be w.r.t. the TSDB max time.
# An out-of-order/out-of-bounds sample is ingested into TSDB as long as the timestamp # An out-of-order/out-of-bounds sample is ingested into the TSDB as long as the timestamp
# of the sample is >= TSDB.MaxTime-out_of_order_time_window. # of the sample is >= TSDB.MaxTime-out_of_order_time_window.
# #
# When out_of_order_time_window is >0, the errors out-of-order and out-of-bounds are # When out_of_order_time_window is >0, the errors out-of-order and out-of-bounds are
# combined into a single error called 'too-old'; a sample is either (a) ingestible # combined into a single error called 'too-old'; a sample is either (a) ingestible
# into TSDB, i.e. it is an in-order sample or an out-of-order/out-of-bound sample # into the TSDB, i.e. it is an in-order sample or an out-of-order/out-of-bounds sample
# that is within the out-of-order window, or (b) too-old, i.e. not in-order # that is within the out-of-order window, or (b) too-old, i.e. not in-order
# and before the out-of-order window. # and before the out-of-order window.
[ out_of_order_time_window: <duration> | default = 0s ] [ out_of_order_time_window: <duration> | default = 0s ]