Skip to content

docs: Add block shortcode to component topics (#5719) #5958

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

Open
clayton-cornell wants to merge 2 commits into
base: release/v1.14
Choose a base branch
from
Open

docs: Add block shortcode to component topics (#5719) #5958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c74ac05
docs: Add block shortcode to component topics (#5719)
clayton-cornell Mar 31, 2026
756ca4e
Merge branch 'release/v1.14' into backport/pr-5719-to-v1.14
clayton-cornell Apr 13, 2026
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
7 changes: 4 additions & 3 deletions docs/sources/reference/components/beyla/beyla.ebpf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ The following formats are supported:

You can use the following blocks with `beyla.ebpf`:

{{< docs/alloy-config >}}

| Block | Description | Required |
|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|----------|
| [`output`][output] | Configures where to send received telemetry data. | yes |
Expand Down Expand Up @@ -92,9 +94,6 @@ You can use the following blocks with `beyla.ebpf`:
| `traces` > [`sampler`][sampler] | Configures global trace sampling settings | no |
| [`routes`][routes] | Configures the routes to match HTTP paths into user-provided HTTP routes. | no |

The > symbol indicates deeper levels of nesting.
For example, `attributes` > `kubernetes` refers to a `kubernetes` block defined inside an `attributes` block.

[routes]: #routes
[traces]: #traces
[attributes]: #attributes
Expand All @@ -113,6 +112,8 @@ For example, `attributes` > `kubernetes` refers to a `kubernetes` block defined
[network filters]: #network-filters
[output]: #output

{{< /docs/alloy-config >}}

### `output`

{{< badge text="Required" >}}
Expand Down
7 changes: 4 additions & 3 deletions ...ces/reference/components/database_observability/database_observability.mysql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ The following collectors are configurable:

You can use the following blocks with `database_observability.mysql`:

{{< docs/alloy-config >}}

| Block | Description | Required |
|--------------------------------------|---------------------------------------------------|----------|
| [`cloud_provider`][cloud_provider] | Provide Cloud Provider information. | no |
Expand All @@ -66,9 +68,6 @@ You can use the following blocks with `database_observability.mysql`:
| [`query_samples`][query_samples] | Configure the query samples collector. | no |
| [`health_check`][health_check] | Configure the health check collector. | no |

The > symbol indicates deeper levels of nesting.
For example, `cloud_provider` > `aws` refers to a `aws` block defined inside an `cloud_provider` block.

[cloud_provider]: #cloud_provider
[aws]: #aws
[azure]: #azure
Expand All @@ -81,6 +80,8 @@ For example, `cloud_provider` > `aws` refers to a `aws` block defined inside an
[setup_actors]: #setup_actors
[health_check]: #health_check

{{< /docs/alloy-config >}}

### `cloud_provider`

The `cloud_provider` block has no attributes.
Expand Down
7 changes: 4 additions & 3 deletions .../reference/components/database_observability/database_observability.postgres.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ The following collectors are configurable:

You can use the following blocks with `database_observability.postgres`:

{{< docs/alloy-config >}}

| Block | Description | Required |
|------------------------------------|---------------------------------------------------|----------|
| [`cloud_provider`][cloud_provider] | Provide Cloud Provider information. | no |
Expand All @@ -72,9 +74,6 @@ You can use the following blocks with `database_observability.postgres`:
| [`explain_plans`][explain_plans] | Configure the explain plans collector. | no |
| [`health_check`][health_check] | Configure the health check collector. | no |

The > symbol indicates deeper levels of nesting.
For example, `cloud_provider` > `aws` refers to a `aws` block defined inside an `cloud_provider` block.

[cloud_provider]: #cloud_provider
[aws]: #aws
[azure]: #azure
Expand All @@ -84,6 +83,8 @@ For example, `cloud_provider` > `aws` refers to a `aws` block defined inside an
[explain_plans]: #explain_plans
[health_check]: #health_check

{{< /docs/alloy-config >}}

### `cloud_provider`

The `cloud_provider` block has no attributes.
Expand Down
8 changes: 6 additions & 2 deletions docs/sources/reference/components/discovery/discovery.azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,22 @@ You can use the following arguments with `discovery.azure`:

You can use the following blocks with `discovery.azure`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| -------------------------------------- | ------------------------------------------------ | -------- |
| [`managed_identity`][managed_identity] | Managed Identity configuration for Azure API. | no |
| [`oauth`][oauth] | OAuth 2.0 configuration for Azure API. | no |
| [`tls_config`][tls_config] | TLS configuration for requests to the Azure API. | no |

You must specify exactly one of the `oauth` or `managed_identity` blocks.

[managed_identity]: #managed_identity
[oauth]: #oauth
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

You must specify exactly one of the `oauth` or `managed_identity` blocks.

### `managed_identity`

The `managed_identity` block configures Managed Identity authentication for the Azure API.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.consul.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ At most, one of the following can be provided:

You can use the following blocks with `discovery.consul`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -79,14 +81,13 @@ You can use the following blocks with `discovery.consul`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
4 changes: 4 additions & 0 deletions docs/sources/reference/components/discovery/discovery.consulagent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,16 @@ You can use the following arguments with `discovery.consulagent`:

You can use the following block with `discovery.consulagent`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| -------------------------- | ------------------------------------------------------ | -------- |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `tls_config`

The `tls_config` block configures TLS settings for connecting to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ At most, one of the following can be provided:

You can use the following blocks with `discovery.docker`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -70,15 +72,14 @@ You can use the following blocks with `discovery.docker`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[filter]: #filter
[basic_auth]: #basic_auth
[authorization]: #authorization
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.dockerswarm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ At most, one of the following can be provided:

You can use the following blocks with `discovery.dockerswarm`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -68,15 +70,14 @@ You can use the following blocks with `discovery.dockerswarm`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The `>` symbol indicates deeper levels of nesting.
For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[filter]: #filter
[basic_auth]: #basic_auth
[authorization]: #authorization
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.ec2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ At most, one of the following can be provided:

You can use the following blocks with `discovery.ec2`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -71,15 +73,14 @@ You can use the following blocks with `discovery.ec2`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
[filter]: #filter
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.eureka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ At most, one of the following can be provided:

You can use the following blocks with `discovery.eureka`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -66,14 +68,13 @@ You can use the following blocks with `discovery.eureka`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.hetzner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ You can use the following arguments with `discovery.hetzner`:

You can use the following blocks with `discovery.hetzner`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -71,14 +73,13 @@ You can use the following blocks with `discovery.hetzner`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ At most, one of the following can be provided:

You can use the following blocks with `discovery.http`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -133,14 +135,13 @@ You can use the following blocks with `discovery.http`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.ionos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ At most, one of the following can be provided:

You can use the following blocks with `discovery.ionos`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -67,14 +69,13 @@ You can use the following blocks with `discovery.ionos`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.kubelet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ For example, if `url` is `https://kubernetes.default.svc.cluster.local:443/api/v

You can use the following blocks with `discovery.kubelet`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`authorization`][authorization] | Configure generic authorization to the endpoint. | no |
Expand All @@ -78,14 +80,13 @@ You can use the following blocks with `discovery.kubelet`:
| `oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The `>` symbol indicates deeper levels of nesting.
For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[authorization]: #authorization
[basic_auth]: #basic_auth
[oauth2]: #oauth2
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `authorization`

The `authorization` block configures generic authorization to the endpoint.
Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/discovery/discovery.kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,8 @@ Discovered ingress objects include the following labels:

You can use the following blocks with `discovery.kubernetes`:

{{< docs/alloy-config >}}

| Block | Description | Required |
| ------------------------------------- | ---------------------------------------------------------- | -------- |
| [`attach_metadata`][attach_metadata] | Optional metadata to attach to discovered targets. | no |
Expand All @@ -242,9 +244,6 @@ You can use the following blocks with `discovery.kubernetes`:
| [`selectors`][selectors] | Selectors to filter discovered Kubernetes resources. | no |
| [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no |

The > symbol indicates deeper levels of nesting.
For example, `oauth2` > `tls_config` refers to a `tls_config` block defined inside an `oauth2` block.

[attach_metadata]: #attach_metadata
[authorization]: #authorization
[basic_auth]: #basic_auth
Expand All @@ -253,6 +252,8 @@ For example, `oauth2` > `tls_config` refers to a `tls_config` block defined insi
[selectors]: #selectors
[tls_config]: #tls_config

{{< /docs/alloy-config >}}

### `attach_metadata`

The `attach_metadata` block allows you to attach node metadata to discovered targets.
Expand Down
Loading
Loading