Skip to content

Commit 9c04d73

Browse files
authored
Update wal doc (#1917)
* Docs changes. * Clean up tables * True up the documentation with the code.
1 parent df34fdb commit 9c04d73

File tree

1 file changed

+27
-24
lines changed

1 file changed

+27
-24
lines changed

docs/sources/reference/components/prometheus/prometheus.write.queue.md

+27-24
Original file line numberDiff line numberDiff line change
@@ -39,20 +39,20 @@ prometheus.write.queue "LABEL" {
3939

4040
The following arguments are supported:
4141

42-
Name | Type | Description | Default | Required
43-
---- | ---- | ----------- | ------- | --------
44-
`ttl` | `time` | `duration` | How long the samples can be queued for before they are discarded. | `2h` | no
42+
Name | Type | Description | Default | Required
43+
-------|--------|-------------|-------------------------------------------------------------------|----------
44+
`ttl` | `time` | `duration` | How long the samples can be queued for before they are discarded. | `2h` | no
4545

4646
## Blocks
4747

4848
The following blocks are supported inside the definition of
4949
`prometheus.write.queue`:
5050

51-
Hierarchy | Block | Description | Required
52-
--------- | ----- | ----------- | --------
53-
persistence | [persistence][] | Configuration for persistence | no
54-
endpoint | [endpoint][] | Location to send metrics to. | no
55-
endpoint > basic_auth | [basic_auth][] | Configure basic_auth for authenticating to the endpoint. | no
51+
Hierarchy | Block | Description | Required
52+
-----------------------|-----------------|----------------------------------------------------------|----------
53+
persistence | [persistence][] | Configuration for persistence | no
54+
endpoint | [endpoint][] | Location to send metrics to. | no
55+
endpoint > basic_auth | [basic_auth][] | Configure basic_auth for authenticating to the endpoint. | no
5656

5757
The `>` symbol indicates deeper levels of nesting. For example, `endpoint >
5858
basic_auth` refers to a `basic_auth` block defined inside an
@@ -69,10 +69,10 @@ are shared for each `endpoint`.
6969

7070
The following arguments are supported:
7171

72-
Name | Type | Description | Default | Required
73-
---- | ---- |-------------------------------------------------------------------------------|---------| --------
74-
`max_signals_to_batch` | `uint` | The maximum number of signals before they are batched to disk. | `10000` | no
75-
`batch_interval` | `duration` | How often to batch signals to disk if `max_signals_to_batch` is not reached. | `5s` | no
72+
Name | Type | Description | Default | Required
73+
------------------------|------------|------------------------------------------------------------------------------|---------|----------
74+
`max_signals_to_batch` | `uint` | The maximum number of signals before they are batched to disk. | `10000` | no
75+
`batch_interval` | `duration` | How often to batch signals to disk if `max_signals_to_batch` is not reached. | `5s` | no
7676

7777

7878
### endpoint block
@@ -83,21 +83,24 @@ The `endpoint` block describes a single location to send metrics to. Multiple
8383

8484
The following arguments are supported:
8585

86-
Name | Type | Description | Default | Required
87-
---- | ---- |--------------------------------------------------------------------| ------ | --------
88-
`url` | `string` | Full URL to send metrics to. | | yes
89-
`bearer_token` | `secret` | Bearer token to authenticate with. | | no
90-
`write_timeout` | `duration` | Timeout for requests made to the URL. | `"30s"` | no
91-
`retry_backoff` | `duration` | How often to wait between retries. | `1s` | no
92-
`max_retry_attempts` | Maximum number of retries before dropping the batch. | `0` | no
93-
`batch_count` | `uint` | How many series to queue in each queue. | `1000` | no
94-
`flush_interval` | `duration` | How often to wait until sending if `batch_count` is not triggered. | `1s` | no
95-
`parallelism` | `uint` | How many parallel batches to write. | 10 | no
96-
`external_labels` | `map(string)` | Labels to add to metrics sent over the network. | | no
86+
Name | Type | Description | Default | Required
87+
----------------------|---------------|-----------------------------------------------------------------|---------|----------
88+
`url` | `string` | Full URL to send metrics to. | | yes
89+
`bearer_token` | `secret` | Bearer token to authenticate with. | | no
90+
`write_timeout` | `duration` | Timeout for requests made to the URL. | `"30s"` | no
91+
`retry_backoff` | `duration` | How long to wait between retries. | `1s` | no
92+
`max_retry_attempts` | `uint` | Maximum number of retries before dropping the batch. | `0` | no
93+
`batch_count` | `uint` | How many series to queue in each queue. | `1000` | no
94+
`flush_interval` | `duration` | How long to wait until sending if `batch_count` is not trigger. | `1s` | no
95+
`parallelism` | `uint` | How many parallel batches to write. | 10 | no
96+
`external_labels` | `map(string)` | Labels to add to metrics sent over the network. | | no
9797

9898
### basic_auth block
9999

100-
{{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
100+
Name | Type | Description | Default | Required
101+
----------------|----------|------------------------------------------|---------|---------
102+
`password` | `secret` | Basic auth password. | | no
103+
`username` | `string` | Basic auth username. | | no
101104

102105

103106
## Exported fields

0 commit comments

Comments
 (0)