Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update wal doc #1917

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update wal doc #1917

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d290ad1
Docs changes.
mattdurham Oct 17, 2024
ce021ff
Clean up tables
mattdurham Oct 17, 2024
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
49 changes: 26 additions & 23 deletions docs/sources/reference/components/prometheus/prometheus.write.queue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,20 @@ prometheus.write.queue "LABEL" {

The following arguments are supported:

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

## Blocks

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

Hierarchy | Block | Description | Required
--------- | ----- | ----------- | --------
persistence | [persistence][] | Configuration for persistence | no
endpoint | [endpoint][] | Location to send metrics to. | no
endpoint > basic_auth | [basic_auth][] | Configure basic_auth for authenticating to the endpoint. | no
Hierarchy | Block | Description | Required
-----------------------|-----------------|----------------------------------------------------------|----------
persistence | [persistence][] | Configuration for persistence | no
endpoint | [endpoint][] | Location to send metrics to. | no
endpoint > basic_auth | [basic_auth][] | Configure basic_auth for authenticating to the endpoint. | no

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

The following arguments are supported:

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


### endpoint block
Expand All @@ -83,20 +83,23 @@ The `endpoint` block describes a single location to send metrics to. Multiple

The following arguments are supported:

Name | Type | Description | Default | Required
---- | ---- |------------------------------------------------------------------| ------ | --------
`url` | `string` | Full URL to send metrics to. | | yes
`write_timeout` | `duration` | Timeout for requests made to the URL. | `"30s"` | no
`retry_backoff` | `duration` | How often to wait between retries. | `1s` | no
`max_retry_attempts` | Maximum number of retries before dropping the batch. | `0` | no
`batch_count` | `uint` | How many series to queue in each queue. | `1000` | no
`flush_interval` | `duration` | How often to wait until sending if `batch_count` is not trigger. | `1s` | no
`parallelism` | `uint` | How many parallel batches to write. | 10 | no
`external_labels` | `map(string)` | Labels to add to metrics sent over the network. | | no
Name | Type | Description | Default | Required
----------------------|------------------------------------------------------|-----------------------------------------------------------------|---------|----------
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Functional change here is using the word long in retry_backoff and flush_interval

`url` | `string` | Full URL to send metrics to. | | yes
`write_timeout` | `duration` | Timeout for requests made to the URL. | `"30s"` | no
`retry_backoff` | `duration` | How long to wait between retries. | `1s` | no
`max_retry_attempts` | Maximum number of retries before dropping the batch. | `0` | no
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the type here.

`batch_count` | `uint` | How many series to queue in each queue. | `1000` | no
`flush_interval` | `duration` | How long to wait until sending if `batch_count` is not trigger. | `1s` | no
`parallelism` | `uint` | How many parallel batches to write. | 10 | no
`external_labels` | `map(string)` | Labels to add to metrics sent over the network. | | no

### basic_auth block

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


## Exported fields
Expand Down
Loading