Skip to content

General updates and corrections to the Alloy Component docs part 2 #3668

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

Merged
merged 6 commits into from
Jun 2, 2025
Merged

General updates and corrections to the Alloy Component docs part 2 #3668

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
689f246
General updates and fixing small typos
clayton-cornell May 22, 2025
87b17f4
Add more basic typo corrections
clayton-cornell May 22, 2025
8b27c88
Fix quoting on duration data type
clayton-cornell May 23, 2025
9f80706
Restore number data type
clayton-cornell May 26, 2025
dcaf73f
One more pass for consistency
clayton-cornell May 26, 2025
2799a25
Update docs/sources/reference/components/loki/loki.relabel.md
clayton-cornell Jun 2, 2025
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
4 changes: 2 additions & 2 deletions docs/sources/reference/components/discovery/discovery.linode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ You can use the following arguments with `discovery.linode`:
| `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no |
| `proxy_url` | `string` | HTTP proxy to send requests through. | | no |
| `refresh_interval` | `duration` | The time to wait between polling update requests. | `"60s"` | no |
| `region` | `string` | A region to filter on. | `""` | no |
| `tag_separator` | `string` | The string by which Linode Instance tags are joined into the tag label. | `,` | no |
| `region` | `string` | A region to filter on. | | no |
| `tag_separator` | `string` | The string by which Linode Instance tags are joined into the tag label. | `","` | no |

At most, one of the following can be provided:

Expand Down
34 changes: 17 additions & 17 deletions docs/sources/reference/components/discovery/discovery.nomad.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,23 @@ discovery.nomad "<LABEL>" {

You can use the following arguments with `discovery.nomad`:

| Name | Type | Description | Default | Required |
| ------------------------ | ------------------- | ------------------------------------------------------------------------------------------------ | ----------------------- | -------- |
| `allow_stale` | `bool` | Allow reading from non-leader nomad instances. | `true` | no |
| `bearer_token_file` | `string` | File containing a bearer token to authenticate with. | | no |
| `bearer_token` | `secret` | Bearer token to authenticate with. | | no |
| `enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no |
| `follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no |
| `http_headers` | `map(list(secret))` | Custom HTTP headers to be sent along with each request. The map key is the header name. | | no |
| `namespace` | `string` | Nomad namespace to use. | `default` | no |
| `no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no |
| `proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no |
| `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no |
| `proxy_url` | `string` | HTTP proxy to send requests through. | | no |
| `refresh_interval` | `duration` | Frequency to refresh list of containers. | `"30s"` | no |
| `region` | `string` | Nomad region to use. | `global` | no |
| `server` | `string` | Address of nomad server. | `http://localhost:4646` | no |
| `tag_separator` | `string` | Separator to join nomad tags into Prometheus labels. | `,` | no |
| Name | Type | Description | Default | Required |
| ------------------------ | ------------------- | ------------------------------------------------------------------------------------------------ | ------------------------- | -------- |
| `allow_stale` | `bool` | Allow reading from non-leader nomad instances. | `true` | no |
| `bearer_token_file` | `string` | File containing a bearer token to authenticate with. | | no |
| `bearer_token` | `secret` | Bearer token to authenticate with. | | no |
| `enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no |
| `follow_redirects` | `bool` | Whether redirects returned by the server should be followed. | `true` | no |
| `http_headers` | `map(list(secret))` | Custom HTTP headers to be sent along with each request. The map key is the header name. | | no |
| `namespace` | `string` | Nomad namespace to use. | `default` | no |
| `no_proxy` | `string` | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. | | no |
| `proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no |
| `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no |
| `proxy_url` | `string` | HTTP proxy to send requests through. | | no |
| `refresh_interval` | `duration` | Frequency to refresh list of containers. | `"30s"` | no |
| `region` | `string` | Nomad region to use. | `global` | no |
| `server` | `string` | Address of nomad server. | `"http://localhost:4646"` | no |
| `tag_separator` | `string` | Separator to join nomad tags into Prometheus labels. | `","` | no |

At most, one of the following can be provided:

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery/discovery.openstack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ You can use the following arguments with `discovery.openstack`:
| `port` | `int` | The port to scrape metrics from. | `80` | no |
| `project_id` | `string` | OpenStack project ID for the Identity V2 and V3 APIs. | | no |
| `project_name` | `string` | OpenStack project name for the Identity V2 and V3 APIs. | | no |
| `refresh_interval` | `duration` | Refresh interval to re-read the instance list. | `60s` | no |
| `refresh_interval` | `duration` | Refresh interval to re-read the instance list. | `"60s"` | no |
| `userid` | `string` | OpenStack user ID for the Identity V2 and V3 APIs. | | no |
| `username` | `string` | OpenStack username for the Identity V2 and V3 APIs. | | no |

Expand Down
16 changes: 8 additions & 8 deletions docs/sources/reference/components/discovery/discovery.ovhcloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ discovery.ovhcloud "<LABEL>" {

You can use the following arguments with `discovery.ovhcloud`:

| Name | Type | Description | Default | Required |
| -------------------- | ---------- | ----------------------------------------------- | -------- | -------- |
| `application_key` | `string` | [API][] application key. | | yes |
| `application_secret` | `secret` | [API][] application secret. | | yes |
| `consumer_key` | `secret` | [API][] consumer key. | | yes |
| `service` | `string` | Service of the targets to retrieve. | | yes |
| `endpoint` | `string` | [API][] endpoint. | "ovh-eu" | no |
| `refresh_interval` | `duration` | Refresh interval to re-read the resources list. | "60s" | no |
| Name | Type | Description | Default | Required |
| -------------------- | ---------- | ----------------------------------------------- | ---------- | -------- |
| `application_key` | `string` | [API][] application key. | | yes |
| `application_secret` | `secret` | [API][] application secret. | | yes |
| `consumer_key` | `secret` | [API][] consumer key. | | yes |
| `service` | `string` | Service of the targets to retrieve. | | yes |
| `endpoint` | `string` | [API][] endpoint. | `"ovh-eu"` | no |
| `refresh_interval` | `duration` | Refresh interval to re-read the resources list. | `"60s"` | no |

`service` must be either `vps` or `dedicated_server`.

Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/components/discovery/discovery.process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can use the following arguments with `discovery.process`:
| Name | Type | Description | Default | Required |
| ------------------ | ------------------- | ---------------------------------------------------------------------------------------- | ------- | -------- |
| `join` | `list(map(string))` | Join external targets to discovered processes targets based on `__container_id__` label. | | no |
| `refresh_interval` | `duration` | How often to sync targets. | "60s" | no |
| `refresh_interval` | `duration` | How often to sync targets. | `"60s"` | no |

### Targets joining

Expand Down Expand Up @@ -112,8 +112,8 @@ The following arguments are supported:
| `exe` | `bool` | A flag to enable discovering `__meta_process_exe` label. | `true` | no |
| `cwd` | `bool` | A flag to enable discovering `__meta_process_cwd` label. | `true` | no |
| `commandline` | `bool` | A flag to enable discovering `__meta_process_commandline` label. | `true` | no |
| `uid` | `bool` | A flag to enable discovering `__meta_process_uid`: label. | `true` | no |
| `username` | `bool` | A flag to enable discovering `__meta_process_username`: label. | `true` | no |
| `uid` | `bool` | A flag to enable discovering `__meta_process_uid` label. | `true` | no |
| `username` | `bool` | A flag to enable discovering `__meta_process_username` label. | `true` | no |
| `cgroup_path` | `bool` | A flag to enable discovering `__meta_cgroup_path__` label. | `false` | no |
| `container_id` | `bool` | A flag to enable discovering `__container_id__` label. | `true` | no |

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery/discovery.puppetdb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The `basic_auth` block configures basic authentication to the endpoint.

### `oauth2`

The `oauth` block configures OAuth 2.0 authentication to the endpoint.
The `oauth2` block configures OAuth 2.0 authentication to the endpoint.

{{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery/discovery.serverset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ You can use the following arguments with `discovery.serverset`:
| --------- | -------------- | ------------------------------------------------ | ------- | -------- |
| `paths` | `list(string)` | The Zookeeper paths to discover Serversets from. | | yes |
| `servers` | `list(string)` | The Zookeeper servers to connect to. | | yes |
| `timeout` | `duration` | The Zookeeper session timeout | `10s` | no |
| `timeout` | `duration` | The Zookeeper session timeout | `"10s"` | no |

## Blocks

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/discovery/discovery.triton.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can use the following arguments with `discovery.triton`:
| `endpoint` | `string` | The Triton discovery endpoint. | | yes |
| `groups` | `list(string)` | A list of groups to retrieve targets from. | | no |
| `port` | `int` | The port to use for discovery and metrics scraping. | `9163` | no |
| `refresh_interval` | `duration` | The refresh interval for the list of targets. | `60s` | no |
| `refresh_interval` | `duration` | The refresh interval for the list of targets. | `"60s"` | no |
| `role` | `string` | The type of targets to discover. | `"container"` | no |
| `version` | `int` | The Triton discovery API version. | `1` | no |

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/reference/components/discovery/discovery.uyuni.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can use the following arguments with `discovery.uyuni`:

| Name | Type | Description | Default | Required |
| ------------------------ | ------------------- | ------------------------------------------------------------------------------------------------ | ----------------------- | -------- |
| `password` | `Secret` | The password to use for authentication to the Uyuni API. | | yes |
| `password` | `secret` | The password to use for authentication to the Uyuni API. | | yes |
| `server` | `string` | The primary Uyuni Server. | | yes |
| `username` | `string` | The username to use for authentication to the Uyuni API. | | yes |
| `enable_http2` | `bool` | Whether HTTP2 is supported for requests. | `true` | no |
Expand All @@ -43,7 +43,7 @@ You can use the following arguments with `discovery.uyuni`:
| `proxy_connect_header` | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests. | | no |
| `proxy_from_environment` | `bool` | Use the proxy URL indicated by environment variables. | `false` | no |
| `proxy_url` | `string` | HTTP proxy to send requests through. | | no |
| `refresh_interval` | `duration` | Interval at which to refresh the list of targets. | `1m` | no |
| `refresh_interval` | `duration` | Interval at which to refresh the list of targets. | `"1m"` | no |
| `separator` | `string` | The separator to use when building the `__meta_uyuni_groups` label. | `","` | no |

{{< docs/shared lookup="reference/components/http-client-proxy-config-description.md" source="alloy" version="<ALLOY_VERSION>" >}}
Expand Down
Loading
Loading