Skip to content

Commit 5101137

Browse files
clayton-cornellclayton-cornell
authored
Update Alloy docs to use new badge shortcode (#4076)
* Update with badge and prettier * Prettier on tables * Fix typo * update syntax * testing heading ids * Fix heading id * Change location of badge * Put badge on its own line * Update badge for required blocks * Test community badge * Roll back badge and use span
1 parent 9714e02 commit 5101137

File tree

52 files changed

+467
-461
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+467
-461
lines changed

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

Lines changed: 39 additions & 39 deletions
Large diffs are not rendered by default.

‎docs/sources/reference/components/faro/faro.receiver.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ faro.receiver "<LABEL>" {
4040
You can use the following arguments with `faro.receiver`:
4141

4242
| Name | Type | Description | Default | Required |
43-
| ------------------ | ------------- | -------------------------------------------- | ---------- | -------- |
43+
|--------------------|---------------|----------------------------------------------|------------|----------|
4444
| `extra_log_labels` | `map(string)` | Extra labels to attach to emitted log lines. | `{}` | no |
4545
| `log_format` | `string` | Export format for the logs. | `"logfmt"` | no |
4646

@@ -56,7 +56,7 @@ The following strings are valid log line formats:
5656
You can use the following blocks with `faro.receiver`:
5757

5858
| Block | Description | Required |
59-
| -------------------------------------------- | ---------------------------------------------------- | -------- |
59+
|----------------------------------------------|------------------------------------------------------|----------|
6060
| [`output`][output] | Configures where to send collected telemetry data. | yes |
6161
| [`server`][server] | Configures the HTTP server. | no |
6262
| `server` > [`rate_limiting`][rate_limiting] | Configures rate limiting for the HTTP server. | no |
@@ -74,10 +74,12 @@ For example, `sourcemaps` > `location` refers to a `location` block defined insi
7474

7575
### `output`
7676

77+
{{< badge text="Required" >}}
78+
7779
The `output` block specifies where to forward collected logs and traces.
7880

7981
| Name | Type | Description | Default | Required |
80-
| -------- | ------------------------ | ---------------------------------------------------- | ------- | -------- |
82+
|----------|--------------------------|------------------------------------------------------|---------|----------|
8183
| `logs` | `list(LogsReceiver)` | A list of `loki` components to forward logs to. | `[]` | no |
8284
| `traces` | `list(otelcol.Consumer)` | A list of `otelcol` components to forward traces to. | `[]` | no |
8385

@@ -87,7 +89,7 @@ The `server` block configures the HTTP server managed by the `faro.receiver` com
8789
Clients using the [Grafana Faro Web SDK][faro-sdk] forward telemetry data to this HTTP server for processing.
8890

8991
| Name | Type | Description | Default | Required |
90-
| -------------------------- | -------------- | --------------------------------------------------------------- | ------------- | -------- |
92+
|----------------------------|----------------|-----------------------------------------------------------------|---------------|----------|
9193
| `listen_address` | `string` | Address to listen for HTTP traffic on. | `"127.0.0.1"` | no |
9294
| `listen_port` | `number` | Port to listen for HTTP traffic on. | `12347` | no |
9395
| `cors_allowed_origins` | `list(string)` | Origins for which cross-origin requests are permitted. | `[]` | no |
@@ -112,7 +114,7 @@ If the `api_key` argument is empty, no authentication checks are performed, and
112114
The `rate_limiting` block configures rate limiting for client requests.
113115

114116
| Name | Type | Description | Default | Required |
115-
| ------------ | -------- | ------------------------------------ | ------- | -------- |
117+
|--------------|----------|--------------------------------------|---------|----------|
116118
| `enabled` | `bool` | Whether to enable rate limiting. | `true` | no |
117119
| `rate` | `number` | Rate of allowed requests per second. | `50` | no |
118120
| `burst_size` | `number` | Allowed burst size of requests. | `100` | no |
@@ -131,7 +133,7 @@ The `sourcemaps` block configures how to retrieve sourcemaps.
131133
Sourcemaps are then used to transform file and line information from minified code into the file and line information from the original source code.
132134

133135
| Name | Type | Description | Default | Required |
134-
| ----------------------- | -------------- | ------------------------------------------ | ------- | -------- |
136+
|-------------------------|----------------|--------------------------------------------|---------|----------|
135137
| `download` | `bool` | Whether to download sourcemaps. | `true` | no |
136138
| `download_from_origins` | `list(string)` | Which origins to download sourcemaps from. | `["*"]` | no |
137139
| `download_timeout` | `duration` | Timeout when downloading sourcemaps. | `"1s"` | no |
@@ -156,7 +158,7 @@ The `location` block declares a location where sourcemaps are stored on the file
156158
You can specify the `location` block multiple times to declare multiple locations where sourcemaps are stored.
157159

158160
| Name | Type | Description | Default | Required |
159-
| ---------------------- | -------- | --------------------------------------------------- | ------- | -------- |
161+
|------------------------|----------|-----------------------------------------------------|---------|----------|
160162
| `minified_path_prefix` | `string` | The prefix of the minified path sent from browsers. | | yes |
161163
| `path` | `string` | The path on disk where sourcemaps are stored. | | yes |
162164

‎docs/sources/reference/components/loki/loki.source.azure_event_hubs.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ loki.source.azure_event_hubs "<LABEL>" {
4343
You can use the following arguments with `loki.source.azure_event_hubs`:
4444

4545
| Name | Type | Description | Default | Required |
46-
| --------------------------- | -------------------- | ----------------------------------------------------------------------------------- | -------------------------------- | -------- |
46+
|-----------------------------|----------------------|-------------------------------------------------------------------------------------|----------------------------------|----------|
4747
| `event_hubs` | `list(string)` | Event Hubs to consume. | | yes |
4848
| `forward_to` | `list(LogsReceiver)` | List of receivers to send log entries to. | | yes |
4949
| `fully_qualified_namespace` | `string` | Event hub namespace. | | yes |
@@ -81,19 +81,19 @@ The following internal labels prefixed with `__` are available but are discarded
8181
You can use the following block with `loki.source.azure_event_hubs`:
8282

8383
| Name | Description | Required |
84-
| ---------------------------------- | -------------------------------------------------- | -------- |
84+
|------------------------------------|----------------------------------------------------|----------|
8585
| [`authentication`][authentication] | Authentication configuration with Azure Event Hub. | yes |
8686

8787
[authentication]: #authentication
8888

8989
### `authentication`
9090

91-
<span class="badge docs-labels__stage docs-labels__item">Required</span>
91+
{{< badge text="Required" >}}
9292

9393
The `authentication` block defines the authentication method when communicating with Azure Event Hub.
9494

9595
| Name | Type | Description | Default | Required |
96-
| ------------------- | -------------- | ------------------------------------------------------------------------- | ------- | -------- |
96+
|---------------------|----------------|---------------------------------------------------------------------------|---------|----------|
9797
| `mechanism` | `string` | Authentication mechanism. | | yes |
9898
| `connection_string` | `secret` | Event Hubs ConnectionString for authentication on Azure Cloud. | | no |
9999
| `scopes` | `list(string)` | Access token scopes. Default is `fully_qualified_namespace` without port. | | no |

‎docs/sources/reference/components/otelcol/otelcol.auth.headers.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The `otelcol.auth.headers` component doesn't support any arguments. You can conf
4545
You can use the following blocks with `otelcol.auth.headers`:
4646

4747
| Block | Description | Required |
48-
| -------------------------------- | -------------------------------------------------------------------------- | -------- |
48+
|----------------------------------|----------------------------------------------------------------------------|----------|
4949
| [`header`][header] | Custom header to attach to requests. | yes |
5050
| [`debug_metrics`][debug_metrics] | Configures the metrics that this component generates to monitor its state. | no |
5151

@@ -54,11 +54,13 @@ You can use the following blocks with `otelcol.auth.headers`:
5454

5555
### `header`
5656

57+
{{< badge text="Required" >}}
58+
5759
The `header` block defines a custom header to attach to requests.
5860
It's valid to provide multiple `header` blocks to set more than one header.
5961

6062
| Name | Type | Description | Default | Required |
61-
| ---------------- | -------------------- | ------------------------------------------------------------ | ---------- | -------- |
63+
|------------------|----------------------|--------------------------------------------------------------|------------|----------|
6264
| `key` | `string` | Name of the header to set. | | yes |
6365
| `action` | `string` | An action to perform on the header. | `"upsert"` | no |
6466
| `from_attribute` | `string` | Authentication attribute name used to retrieve header value. | | no |
@@ -94,7 +96,7 @@ For `from_context` to work, other components in the pipeline also need to be con
9496
The following fields are exported and can be referenced by other components:
9597

9698
| Name | Type | Description |
97-
| --------- | -------------------------- | --------------------------------------------------------------- |
99+
|-----------|----------------------------|-----------------------------------------------------------------|
98100
| `handler` | `capsule(otelcol.Handler)` | A value that other components can use to authenticate requests. |
99101

100102
## Component health

‎docs/sources/reference/components/otelcol/otelcol.connector.host_info.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ otelcol.connector.host_info "<LABEL>" {
3333
You can use the following arguments with `otelcol.connector.host_info`:
3434

3535
| Name | Type | Description | Default | Required |
36-
| ------------------------ | -------------- | ------------------------------------------------------------------ | ------------- | -------- |
36+
|--------------------------|----------------|--------------------------------------------------------------------|---------------|----------|
3737
| `host_identifiers` | `list(string)` | Ordered list of resource attributes used to identify unique hosts. | `["host.id"]` | no |
3838
| `metrics_flush_interval` | `duration` | How often to flush generated metrics. | `"60s"` | no |
3939

@@ -42,7 +42,7 @@ You can use the following arguments with `otelcol.connector.host_info`:
4242
You can use the following blocks with `otelcol.connector.host_info`:
4343

4444
| Block | Description | Required |
45-
| -------------------------------- | -------------------------------------------------------------------------- | -------- |
45+
|----------------------------------|----------------------------------------------------------------------------|----------|
4646
| [`output`][output] | Configures where to send received telemetry data. | yes |
4747
| [`debug_metrics`][debug_metrics] | Configures the metrics that this component generates to monitor its state. | no |
4848

@@ -51,7 +51,7 @@ You can use the following blocks with `otelcol.connector.host_info`:
5151

5252
### `output`
5353

54-
<span class="badge docs-labels__stage docs-labels__item">Required</span>
54+
{{< badge text="Required" >}}
5555

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

@@ -64,7 +64,7 @@ You can use the following blocks with `otelcol.connector.host_info`:
6464
The following fields are exported and can be referenced by other components:
6565

6666
| Name | Type | Description |
67-
| ------- | ------------------ | ---------------------------------------------------------------- |
67+
|---------|--------------------|------------------------------------------------------------------|
6868
| `input` | `otelcol.Consumer` | A value that other components can use to send telemetry data to. |
6969

7070
`input` accepts `otelcol.Consumer` traces telemetry data.

‎docs/sources/reference/components/otelcol/otelcol.connector.servicegraph.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ otelcol.connector.servicegraph "<LABEL>" {
5959
You can use the following arguments with `otelcol.connector.servicegraph`:
6060

6161
| Name | Type | Description | Default | Required |
62-
| --------------------------- | ---------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------- |
62+
|-----------------------------|------------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|----------|
6363
| `cache_loop` | `duration` | Configures how often to delete series which have not been updated. | `"1m"` | no |
6464
| `database_name_attribute` | `string` | (Deprecated) The attribute name used to identify the database name from span attributes. | `"db.name"` | no |
6565
| `database_name_attributes` | `list(string)` | The list of attribute names used to identify the database name from span attributes. | `["db.name"]` | no |
@@ -85,7 +85,7 @@ Every span which can be paired up to form a request is kept in an in-memory stor
8585
The following metrics are emitted by the processor:
8686

8787
| Metric | Type | Labels | Description |
88-
| ------------------------------------------- | --------- | ------------------------------------- | ------------------------------------------------------------------------- |
88+
|---------------------------------------------|-----------|---------------------------------------|---------------------------------------------------------------------------|
8989
| `traces_service_graph_dropped_spans_total` | Counter | `client`, `server`, `connection_type` | Total count of dropped spans |
9090
| `traces_service_graph_request_client` | Histogram | `client`, `server`, `connection_type` | Number of seconds for a request between two nodes as seen from the client |
9191
| `traces_service_graph_request_failed_total` | Counter | `client`, `server`, `connection_type` | Total count of failed requests between two nodes |
@@ -120,7 +120,7 @@ The attributes in `database_name_attributes` are tried in order, selecting the f
120120
You can use the following blocks with `otelcol.connector.servicegraph`:
121121

122122
| Block | Description | Required |
123-
| -------------------------------- | -------------------------------------------------------------------------- | -------- |
123+
|----------------------------------|----------------------------------------------------------------------------|----------|
124124
| [`output`][output] | Configures where to send telemetry data. | yes |
125125
| [`debug_metrics`][debug_metrics] | Configures the metrics that this component generates to monitor its state. | no |
126126
| [`store`][store] | Configures the in-memory store for spans. | no |
@@ -131,7 +131,7 @@ You can use the following blocks with `otelcol.connector.servicegraph`:
131131

132132
### `output`
133133

134-
<span class="badge docs-labels__stage docs-labels__item">Required</span>
134+
{{< badge text="Required" >}}
135135

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

@@ -144,7 +144,7 @@ You can use the following blocks with `otelcol.connector.servicegraph`:
144144
The `store` block configures the in-memory store for spans.
145145

146146
| Name | Type | Description | Default | Required |
147-
| ----------- | ---------- | --------------------------------------------- | ------- | -------- |
147+
|-------------|------------|-----------------------------------------------|---------|----------|
148148
| `max_items` | `number` | Maximum number of items to keep in the store. | `1000` | no |
149149
| `ttl` | `duration` | The time to live for spans in the store. | `"2s"` | no |
150150

@@ -153,7 +153,7 @@ The `store` block configures the in-memory store for spans.
153153
The following fields are exported and can be referenced by other components:
154154

155155
| Name | Type | Description |
156-
| ------- | ------------------ | ---------------------------------------------------------------- |
156+
|---------|--------------------|------------------------------------------------------------------|
157157
| `input` | `otelcol.Consumer` | A value that other components can use to send telemetry data to. |
158158

159159
`input` accepts `otelcol.Consumer` traces telemetry data.

0 commit comments

Comments
 (0)