Skip to content

Commit 7d32f2a

Browse files
Update using code format in headings and tables (#2519)
* Upidate using code format, and catch a few typos * Fix reference to exclude_services
1 parent 3f4588b commit 7d32f2a

32 files changed

+312
-316
lines changed

docs/sources/reference/components/beyla/beyla.ebpf.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
title: beyla.ebpf
99
---
1010

11-
# beyla.ebpf
11+
# `beyla.ebpf`
1212

1313
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
1414

@@ -50,24 +50,24 @@ If the executable matches only one of the ports in the list, it's considered to
5050

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

53-
Block | Description | Required
54-
-----------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------
55-
[output][] | Configures where to send received telemetry data. | yes
56-
[attributes][] | Configures the Beyla attributes for the component. | no
57-
attributes > [kubernetes][kubernetes attributes] | Configures decorating of the metrics and traces with Kubernetes metadata of the instrumented Pods. | no
58-
[discovery][] | Configures the discovery for instrumentable processes matching a given criteria. | no
59-
discovery > [exclude services][services] | Configures the services to exclude for the component. | no
60-
discovery > exclude_services > [kubernetes][kubernetes services] | Configures the Kubernetes services to exclude for the component. | no
61-
discovery > [services][] | Configures the services to discover for the component. | no
62-
discovery > services > [kubernetes][kubernetes services] | Configures the Kubernetes services to discover for the component. | no
63-
[metrics][] | Configures which metrics Beyla exposes. | no
64-
metrics > [network][] | Configures network metrics options for Beyla. | no
65-
[routes][] | Configures the routes to match HTTP paths into user-provided HTTP routes. | no
53+
Block | Description | Required
54+
-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------
55+
[`output`][output] | Configures where to send received telemetry data. | yes
56+
[`attributes`][attributes] | Configures the Beyla attributes for the component. | no
57+
`attributes` > [`kubernetes`][kubernetes attributes] | Configures decorating of the metrics and traces with Kubernetes metadata of the instrumented Pods. | no
58+
[`discovery`][discovery] | Configures the discovery for instrumentable processes matching a given criteria. | no
59+
`discovery` > [`exclude_services`][services] | Configures the services to exclude for the component. | no
60+
`discovery` > `exclude_services` > [`kubernetes`][kubernetes services] | Configures the Kubernetes services to exclude for the component. | no
61+
`discovery` > [`services`][services] | Configures the services to discover for the component. | no
62+
`discovery` > `services` > [`kubernetes`][kubernetes services] | Configures the Kubernetes services to discover for the component. | no
63+
[`metrics`][metrics] | Configures which metrics Beyla exposes. | no
64+
`metrics` > [`network`][network] | Configures network metrics options for Beyla. | no
65+
[`routes`][routes] | Configures the routes to match HTTP paths into user-provided HTTP routes. | no
6666

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

70-
### output
70+
### `output`
7171

7272
<span class="badge docs-labels__stage docs-labels__item">Required</span>
7373

@@ -83,13 +83,13 @@ You must specify the `output` block, but all its arguments are optional.
8383
By default, telemetry data is dropped.
8484
Configure the `traces` argument to send traces data to other components.
8585

86-
### attributes
86+
### `attributes`
8787

8888
The `attributes` block configures how some attributes for metrics and traces are decorated.
8989

9090
It contains the following block:
9191

92-
#### kubernetes attributes
92+
#### `kubernetes` attributes
9393

9494
This `kubernetes` block configures the decorating of the metrics and traces with Kubernetes metadata from the instrumented Pods.
9595

@@ -116,13 +116,13 @@ If `enable` is set to `false`, the Kubernetes metadata decorator is disabled.
116116

117117
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.
118118

119-
### discovery
119+
### `discovery`
120120

121121
The `discovery` block configures the discovery for instrumentable processes matching a given criteria.
122122

123123
It contains the following blocks:
124124

125-
#### services
125+
#### `services`
126126

127127
In some scenarios, Beyla instruments a wide variety of services, such as a Kubernetes DaemonSet that instruments all the services in a node.
128128
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
143143
`open_port` accepts a comma-separated list of ports (for example, `80,443`), and port ranges (for example, `8000-8999`).
144144
If the executable matches only one of the ports in the list, it's considered to match the selection criteria.
145145

146-
#### kubernetes services
146+
#### `kubernetes` services
147147

148148
This `kubernetes` block filters the services to instrument based on their Kubernetes metadata. If you specify other selectors in the same services entry,
149149
the instrumented processes need to match all the selector properties.
@@ -159,7 +159,7 @@ Name | Type | Description
159159
`replicaset_name` | `string` | Regular expression of Kubernetes ReplicaSets to match. | `""` | no
160160
`statefulset_name` | `string` | Regular expression of Kubernetes StatefulSets to match. | `""` | no
161161

162-
### metrics
162+
### `metrics`
163163

164164
The `metrics` block configures which metrics Beyla collects.
165165

@@ -185,15 +185,15 @@ Name | Type | Description
185185
* `redis` enables the collection of Redis client/server database metrics.
186186
* `sql` enables the collection of SQL database client call metrics.
187187

188-
#### network
188+
#### `network`
189189

190190
The `network` block configures network metrics options for Beyla. You must append `network` to the `features` list in the `metrics` block to enable network metrics.
191191

192192
Name | Type | Description | Default | Required
193193
----------|--------|------------------------------------|---------|---------
194194
`enabled` | `bool` | Enable network metrics collection. | `false` | no
195195

196-
### routes
196+
### `routes`
197197

198198
The `routes` block configures the routes to match HTTP paths into user-provided HTTP routes.
199199

docs/sources/reference/components/discovery/discovery.azure.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
title: discovery.azure
99
---
1010

11-
# discovery.azure
11+
# `discovery.azure`
1212

1313
`discovery.azure` discovers [Azure][] Virtual Machines and exposes them as targets.
1414

@@ -44,27 +44,27 @@ Name | Type | Description
4444

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

47-
Block | Description | Required
48-
---------------------|--------------------------------------------------|---------
49-
[managed_identity][] | Managed Identity configuration for Azure API. | no
50-
[oauth][] | OAuth 2.0 configuration for Azure API. | no
51-
[tls_config][] | TLS configuration for requests to the Azure API. | no
47+
Block | Description | Required
48+
---------------------------------------|--------------------------------------------------|---------
49+
[`managed_identity`][managed_identity] | Managed Identity configuration for Azure API. | no
50+
[`oauth`][oauth] | OAuth 2.0 configuration for Azure API. | no
51+
[`tls_config`][tls_config] | TLS configuration for requests to the Azure API. | no
5252

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

5555
[managed_identity]: #managed_identity
5656
[oauth]: #oauth
5757
[tls_config]: #tls_config
5858

59-
### managed_identity
59+
### `managed_identity`
6060

6161
The `managed_identity` block configures Managed Identity authentication for the Azure API.
6262

6363
Name | Type | Description | Default | Required
6464
------------|----------|-----------------------------|---------|---------
6565
`client_id` | `string` | Managed Identity client ID. | | yes
6666

67-
### oauth
67+
### `oauth`
6868

6969
The `oauth` block configures OAuth 2.0 authentication for the Azure API.
7070

@@ -74,7 +74,7 @@ Name | Type | Description | Default | Required
7474
`client_secret` | `string` | OAuth 2.0 client secret. | | yes
7575
`tenant_id` | `string` | OAuth 2.0 tenant ID. | | yes
7676

77-
### tls_config
77+
### `tls_config`
7878

7979
The `tls_config` block configures TLS settings for requests to the Azure API.
8080

docs/sources/reference/components/discovery/discovery.consul.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
title: discovery.consul
99
---
1010

11-
# discovery.consul
11+
# `discovery.consul`
1212

1313
`discovery.consul` allows you to retrieve scrape targets from [Consul's Catalog API][].
1414

@@ -68,13 +68,13 @@ Name | Type | Description
6868

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

71-
Block | Description | Required
72-
------------------------|------------------------------------------------------------|---------
73-
[authorization][] | Configure generic authorization to the endpoint. | no
74-
[basic_auth][] | Configure `basic_auth` for authenticating to the endpoint. | no
75-
[oauth2][] | Configure OAuth 2.0 for authenticating to the endpoint. | no
76-
oauth2 > [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
77-
[tls_config][] | Configure TLS settings for connecting to the endpoint. | no
71+
Block | Description | Required
72+
--------------------------------------|------------------------------------------------------------|---------
73+
[`authorization`][authorization] | Configure generic authorization to the endpoint. | no
74+
[`basic_auth`][basic_auth] | Configure `basic_auth` for authenticating to the endpoint. | no
75+
[`oauth2`][oauth2] | Configure OAuth 2.0 for authenticating to the endpoint. | no
76+
`oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
77+
[`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
7878

7979
The > symbol indicates deeper levels of nesting.
8080
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
8484
[oauth2]: #oauth2
8585
[tls_config]: #tls_config
8686

87-
### authorization
87+
### `authorization`
8888

8989
The `authorization` block configures generic authorization to the endpoint.
9090

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

93-
### basic_auth
93+
### `basic_auth`
9494

9595
The `basic_auth` block configures basic authentication to the endpoint.
9696

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

99-
### oauth2
99+
### `oauth2`
100100

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

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

105-
### tls_config
105+
### `tls_config`
106106

107107
The `tls_config` block configures TLS settings for connecting to the endpoint.
108108

docs/sources/reference/components/discovery/discovery.consulagent.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
title: discovery.consulagent
99
---
1010

11-
# discovery.consulagent
11+
# `discovery.consulagent`
1212

1313
`discovery.consulagent` allows you to retrieve scrape targets from [Consul's Agent API][].
1414
Only the services registered with the local agent running on the same host are watched.
@@ -45,13 +45,13 @@ Name | Type | Description
4545

4646
You can use the following blocks with `discovery.consulagent`:
4747

48-
Block | Description | Required
49-
---------------|--------------------------------------------------------|---------
50-
[tls_config][] | Configure TLS settings for connecting to the endpoint. | no
48+
Block | Description | Required
49+
---------------------------|--------------------------------------------------------|---------
50+
[`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
5151

5252
[tls_config]: #tls_config
5353

54-
### tls_config
54+
### `tls_config`
5555

5656
The `tls_config` block configures TLS settings for connecting to the endpoint.
5757

docs/sources/reference/components/discovery/discovery.digitalocean.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
title: discovery.digitalocean
99
---
1010

11-
# discovery.digitalocean
11+
# `discovery.digitalocean`
1212

1313
`discovery.digitalocean` discovers [DigitalOcean][] Droplets and exposes them as targets.
1414

docs/sources/reference/components/discovery/discovery.dns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
title: discovery.dns
99
---
1010

11-
# discovery.dns
11+
# `discovery.dns`
1212

1313
`discovery.dns` discovers scrape targets from DNS records.
1414

docs/sources/reference/components/discovery/discovery.docker.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
title: discovery.docker
99
---
1010

11-
# discovery.docker
11+
# `discovery.docker`
1212

1313
`discovery.docker` discovers [Docker Engine][] containers and exposes them as targets.
1414

@@ -57,14 +57,14 @@ Name | Type | Description
5757

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

60-
Block | Description | Required
61-
------------------------|------------------------------------------------------------|---------
62-
[authorization][] | Configure generic authorization to the endpoint. | no
63-
[basic_auth][] | Configure `basic_auth` for authenticating to the endpoint. | no
64-
[filter][] | Filters discoverable resources. | no
65-
[oauth2][] | Configure OAuth 2.0 for authenticating to the endpoint. | no
66-
oauth2 > [tls_config][] | Configure TLS settings for connecting to the endpoint. | no
67-
[tls_config][] | Configure TLS settings for connecting to the endpoint. | no
60+
Block | Description | Required
61+
--------------------------------------|------------------------------------------------------------|---------
62+
[`authorization`][authorization] | Configure generic authorization to the endpoint. | no
63+
[`basic_auth`][basic_auth] | Configure `basic_auth` for authenticating to the endpoint. | no
64+
[`filter`][filter] | Filters discoverable resources. | no
65+
[`oauth2`][oauth2] | Configure OAuth 2.0 for authenticating to the endpoint. | no
66+
`oauth2` > [`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
67+
[`tls_config`][tls_config] | Configure TLS settings for connecting to the endpoint. | no
6868

6969
The `>` symbol indicates deeper levels of nesting.
7070
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
7575
[oauth2]: #oauth2
7676
[tls_config]: #tls_config
7777

78-
### authorization
78+
### `authorization`
7979

8080
The `authorization` block configures generic authorization to the endpoint.
8181

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

84-
### basic_auth
84+
### `basic_auth`
8585

8686
The `basic_auth` block configures basic authentication to the endpoint.
8787

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

90-
### filter
90+
### `filter`
9191

9292
The `filter` block configures a filter to pass to the Docker Engine to limit the number of containers returned.
9393
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
101101

102102
[List containers]: https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerList
103103

104-
### oauth2
104+
### `oauth2`
105105

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

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

110-
### tls_config
110+
### `tls_config`
111111

112112
The `tls_config` block configures TLS settings for connecting to the endpoint.
113113

0 commit comments

Comments
 (0)