Update using code format in headings and tables (#2519)

* Upidate using code format, and catch a few typos * Fix reference to exclude_services (cherry picked from commit 7d32f2a)
grafana · Jan 29, 2025 · 30f196f · 30f196f
1 parent dff5ea4
commit 30f196f
Show file tree

Hide file tree

Showing 32 changed files with 312 additions and 316 deletions.
diff --git a/docs/sources/reference/components/beyla/beyla.ebpf.md b/docs/sources/reference/components/beyla/beyla.ebpf.md
@@ -8,7 +8,7 @@ labels:
 title: beyla.ebpf
 ---
 
-# beyla.ebpf
+# `beyla.ebpf`
 
 {{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
@@ -50,24 +50,24 @@ If the executable matches only one of the ports in the list, it's considered to
 
 You can use the following blocks with `beyla.ebpf`:
 
-Block                                                            | Description                                                                                        | Required
------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------
-[output][]                                                       | Configures where to send received telemetry data.                                                  | yes
-[attributes][]                                                   | Configures the Beyla attributes for the component.                                                 | no
-attributes > [kubernetes][kubernetes attributes]                 | Configures decorating of the metrics and traces with Kubernetes metadata of the instrumented Pods. | no
-[discovery][]                                                    | Configures the discovery for instrumentable processes matching a given criteria.                   | no
-discovery > [exclude services][services]                         | Configures the services to exclude for the component.                                              | no
-discovery > exclude_services > [kubernetes][kubernetes services] | Configures the Kubernetes services to exclude for the component.                                   | no
-discovery > [services][]                                         | Configures the services to discover for the component.                                             | no
-discovery > services > [kubernetes][kubernetes services]         | Configures the Kubernetes services to discover for the component.                                  | no
-[metrics][]                                                      | Configures which metrics Beyla exposes.                                                            | no
-metrics > [network][]                                            | Configures network metrics options for Beyla.                                                      | no
-[routes][]                                                       | Configures the routes to match HTTP paths into user-provided HTTP routes.                          | no
+Block                                                                  | Description                                                                                        | Required
+-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------
+[`output`][output]                                                     | Configures where to send received telemetry data.                                                  | yes
+[`attributes`][attributes]                                             | Configures the Beyla attributes for the component.                                                 | no
+`attributes` > [`kubernetes`][kubernetes attributes]                   | Configures decorating of the metrics and traces with Kubernetes metadata of the instrumented Pods. | no
+[`discovery`][discovery]                                               | Configures the discovery for instrumentable processes matching a given criteria.                   | no
+`discovery` > [`exclude_services`][services]                           | Configures the services to exclude for the component.                                              | no
+`discovery` > `exclude_services` > [`kubernetes`][kubernetes services] | Configures the Kubernetes services to exclude for the component.                                   | no
+`discovery` > [`services`][services]                                   | Configures the services to discover for the component.                                             | no
+`discovery` > `services` > [`kubernetes`][kubernetes services]         | Configures the Kubernetes services to discover for the component.                                  | no
+[`metrics`][metrics]                                                   | Configures which metrics Beyla exposes.                                                            | no
+`metrics` > [`network`][network]                                       | Configures network metrics options for Beyla.                                                      | 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.
 
-### output
+### `output`
 
 <span class="badge docs-labels__stage docs-labels__item">Required</span>
 
@@ -83,13 +83,13 @@ You must specify the `output` block, but all its arguments are optional.
 By default, telemetry data is dropped.
 Configure the `traces` argument to send traces data to other components.
 
-### attributes
+### `attributes`
 
 The `attributes` block configures how some attributes for metrics and traces are decorated.
 
 It contains the following block:
 
-#### kubernetes attributes
+#### `kubernetes` attributes
 
 This `kubernetes` block configures the decorating of the metrics and traces with Kubernetes metadata from the instrumented Pods.
 
@@ -116,13 +116,13 @@ If `enable` is set to `false`, the Kubernetes metadata decorator is disabled.
 
 If `enable` is set to `autodetect`, Beyla tries to detect if it's running inside Kubernetes, and enables the metadata decoration if that's the case.
 
-### discovery
+### `discovery`
 
 The `discovery` block configures the discovery for instrumentable processes matching a given criteria.
 
 It contains the following blocks:
 
-#### services
+#### `services`
 
 In some scenarios, Beyla instruments a wide variety of services, such as a Kubernetes DaemonSet that instruments all the services in a node.
 The `services` block allows you to filter the services to instrument based on their metadata. If you specify other selectors in the same services entry,
@@ -143,7 +143,7 @@ It's used to populate the `service.name` OTel property or the `service_name` Pro
 `open_port` accepts a comma-separated list of ports (for example, `80,443`), and port ranges (for example, `8000-8999`).
 If the executable matches only one of the ports in the list, it's considered to match the selection criteria.
 
-#### kubernetes services
+#### `kubernetes` services
 
 This `kubernetes` block filters the services to instrument based on their Kubernetes metadata. If you specify other selectors in the same services entry,
 the instrumented processes need to match all the selector properties.
@@ -159,7 +159,7 @@ Name               | Type          | Description
 `replicaset_name`  | `string`      | Regular expression of Kubernetes ReplicaSets to match.                                                      | `""`    | no
 `statefulset_name` | `string`      | Regular expression of Kubernetes StatefulSets to match.                                                     | `""`    | no
 
-### metrics
+### `metrics`
 
 The `metrics` block configures which metrics Beyla collects.
 
@@ -185,15 +185,15 @@ Name               | Type           | Description
 * `redis` enables the collection of Redis client/server database metrics.
 * `sql` enables the collection of SQL database client call metrics.
 
-#### network
+#### `network`
 
 The `network` block configures network metrics options for Beyla.
 
 Name      | Type   | Description                        | Default | Required
 ----------|--------|------------------------------------|---------|---------
 `enabled` | `bool` | Enable network metrics collection. | `false` | no
 
-### routes
+### `routes`
 
 The `routes` block configures the routes to match HTTP paths into user-provided HTTP routes.
 

diff --git a/docs/sources/reference/components/discovery/discovery.azure.md b/docs/sources/reference/components/discovery/discovery.azure.md
@@ -8,7 +8,7 @@ labels:
 title: discovery.azure
 ---
 
-# discovery.azure
+# `discovery.azure`
 
 `discovery.azure` discovers [Azure][] Virtual Machines and exposes them as targets.
 
@@ -44,27 +44,27 @@ Name                     | Type                | Description
 
 You can use the following blocks with `discovery.azure`:
 
-Block                | Description                                      | Required
----------------------|--------------------------------------------------|---------
-[managed_identity][] | Managed Identity configuration for Azure API.    | no
-[oauth][]            | OAuth 2.0 configuration for Azure API.           | no
-[tls_config][]       | TLS configuration for requests to the Azure API. | no
+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
 
-### managed_identity
+### `managed_identity`
 
 The `managed_identity` block configures Managed Identity authentication for the Azure API.
 
 Name        | Type     | Description                 | Default | Required
 ------------|----------|-----------------------------|---------|---------
 `client_id` | `string` | Managed Identity client ID. |         | yes
 
-### oauth
+### `oauth`
 
 The `oauth` block configures OAuth 2.0 authentication for the Azure API.
 
@@ -74,7 +74,7 @@ Name            | Type     | Description              | Default | Required
 `client_secret` | `string` | OAuth 2.0 client secret. |         | yes
 `tenant_id`     | `string` | OAuth 2.0 tenant ID.     |         | yes
 
-### tls_config
+### `tls_config`
 
 The `tls_config` block configures TLS settings for requests to the Azure API.
 

diff --git a/docs/sources/reference/components/discovery/discovery.consul.md b/docs/sources/reference/components/discovery/discovery.consul.md
@@ -8,7 +8,7 @@ labels:
 title: discovery.consul
 ---
 
-# discovery.consul
+# `discovery.consul`
 
 `discovery.consul` allows you to retrieve scrape targets from [Consul's Catalog API][].
 
@@ -68,13 +68,13 @@ Name                     | Type                | Description
 
 You can use the following blocks with `discovery.consul`:
 
-Block                   | Description                                                | Required
-------------------------|------------------------------------------------------------|---------
-[authorization][]       | Configure generic authorization to the endpoint.           | no
-[basic_auth][]          | Configure `basic_auth` for authenticating to the endpoint. | no
-[oauth2][]              | Configure OAuth 2.0 for authenticating to the endpoint.    | no
-oauth2 > [tls_config][] | Configure TLS settings for connecting to the endpoint.     | no
-[tls_config][]          | Configure TLS settings for connecting to the endpoint.     | no
+Block                                 | Description                                                | Required
+--------------------------------------|------------------------------------------------------------|---------
+[`authorization`][authorization]      | Configure generic authorization to the endpoint.           | no
+[`basic_auth`][basic_auth]            | Configure `basic_auth` for authenticating to the endpoint. | no
+[`oauth2`][oauth2]                    | Configure OAuth 2.0 for authenticating to the endpoint.    | no
+`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.
@@ -84,25 +84,25 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside
 [oauth2]: #oauth2
 [tls_config]: #tls_config
 
-### authorization
+### `authorization`
 
 The `authorization` block configures generic authorization to the endpoint.
 
 {{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### basic_auth
+### `basic_auth`
 
 The `basic_auth` block configures basic authentication to the endpoint.
 
 {{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### oauth2
+### `oauth2`
 
 The `oauth` block configures OAuth 2.0 authentication to the endpoint.
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config
+### `tls_config`
 
 The `tls_config` block configures TLS settings for connecting to the endpoint.
 

diff --git a/docs/sources/reference/components/discovery/discovery.consulagent.md b/docs/sources/reference/components/discovery/discovery.consulagent.md
@@ -8,7 +8,7 @@ labels:
 title: discovery.consulagent
 ---
 
-# discovery.consulagent
+# `discovery.consulagent`
 
 `discovery.consulagent` allows you to retrieve scrape targets from [Consul's Agent API][].
 Only the services registered with the local agent running on the same host are watched.
@@ -45,13 +45,13 @@ Name               | Type           | Description
 
 You can use the following blocks with `discovery.consulagent`:
 
-Block          | Description                                            | Required
----------------|--------------------------------------------------------|---------
-[tls_config][] | Configure TLS settings for connecting to the endpoint. | no
+Block                      | Description                                            | Required
+---------------------------|--------------------------------------------------------|---------
+[`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
 
 [tls_config]: #tls_config
 
-### tls_config
+### `tls_config`
 
 The `tls_config` block configures TLS settings for connecting to the endpoint.
 

diff --git a/docs/sources/reference/components/discovery/discovery.digitalocean.md b/docs/sources/reference/components/discovery/discovery.digitalocean.md
@@ -8,7 +8,7 @@ labels:
 title: discovery.digitalocean
 ---
 
-# discovery.digitalocean
+# `discovery.digitalocean`
 
 `discovery.digitalocean` discovers [DigitalOcean][] Droplets and exposes them as targets.
 

diff --git a/docs/sources/reference/components/discovery/discovery.dns.md b/docs/sources/reference/components/discovery/discovery.dns.md
@@ -8,7 +8,7 @@ labels:
 title: discovery.dns
 ---
 
-# discovery.dns
+# `discovery.dns`
 
 `discovery.dns` discovers scrape targets from DNS records.
 

diff --git a/docs/sources/reference/components/discovery/discovery.docker.md b/docs/sources/reference/components/discovery/discovery.docker.md
@@ -8,7 +8,7 @@ labels:
 title: discovery.docker
 ---
 
-# discovery.docker
+# `discovery.docker`
 
 `discovery.docker` discovers [Docker Engine][] containers and exposes them as targets.
 
@@ -57,14 +57,14 @@ Name                     | Type                | Description
 
 You can use the following blocks with `discovery.docker`:
 
-Block                   | Description                                                | Required
-------------------------|------------------------------------------------------------|---------
-[authorization][]       | Configure generic authorization to the endpoint.           | no
-[basic_auth][]          | Configure `basic_auth` for authenticating to the endpoint. | no
-[filter][]              | Filters discoverable resources.                            | no
-[oauth2][]              | Configure OAuth 2.0 for authenticating to the endpoint.    | no
-oauth2 > [tls_config][] | Configure TLS settings for connecting to the endpoint.     | no
-[tls_config][]          | Configure TLS settings for connecting to the endpoint.     | no
+Block                                 | Description                                                | Required
+--------------------------------------|------------------------------------------------------------|---------
+[`authorization`][authorization]      | Configure generic authorization to the endpoint.           | no
+[`basic_auth`][basic_auth]            | Configure `basic_auth` for authenticating to the endpoint. | no
+[`filter`][filter]                    | Filters discoverable resources.                            | no
+[`oauth2`][oauth2]                    | Configure OAuth 2.0 for authenticating to the endpoint.    | no
+`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.
@@ -75,19 +75,19 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside
 [oauth2]: #oauth2
 [tls_config]: #tls_config
 
-### authorization
+### `authorization`
 
 The `authorization` block configures generic authorization to the endpoint.
 
 {{< docs/shared lookup="reference/components/authorization-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### basic_auth
+### `basic_auth`
 
 The `basic_auth` block configures basic authentication to the endpoint.
 
 {{< docs/shared lookup="reference/components/basic-auth-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### filter
+### `filter`
 
 The `filter` block configures a filter to pass to the Docker Engine to limit the number of containers returned.
 You can specify the `filter` block multiple times to provide more than one filter.
@@ -101,13 +101,13 @@ Refer to [List containers][List containers] from the Docker Engine API documenta
 
 [List containers]: https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerList
 
-### oauth2
+### `oauth2`
 
 The `oauth` block configures OAuth 2.0 authentication to the endpoint.
 
 {{< docs/shared lookup="reference/components/oauth2-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-### tls_config
+### `tls_config`
 
 The `tls_config` block configures TLS settings for connecting to the endpoint.