@@ -39,20 +39,20 @@ prometheus.write.queue "LABEL" {
39
39
40
40
The following arguments are supported:
41
41
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
45
45
46
46
## Blocks
47
47
48
48
The following blocks are supported inside the definition of
49
49
` prometheus.write.queue ` :
50
50
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
56
56
57
57
The ` > ` symbol indicates deeper levels of nesting. For example, `endpoint >
58
58
basic_auth` refers to a ` basic_auth` block defined inside an
@@ -69,10 +69,10 @@ are shared for each `endpoint`.
69
69
70
70
The following arguments are supported:
71
71
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
76
76
77
77
78
78
### endpoint block
@@ -83,21 +83,24 @@ The `endpoint` block describes a single location to send metrics to. Multiple
83
83
84
84
The following arguments are supported:
85
85
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
97
97
98
98
### basic_auth block
99
99
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
101
104
102
105
103
106
## Exported fields
0 commit comments