Skip to content

Commit 4586be0

Browse files
clayton-cornellclayton-cornell
authored
[release/v1.5] Update markdown styles in faro docs (#2662)
(cherry picked from commit 0fa6494)
1 parent 3c8468a commit 4586be0

File tree

2 files changed

+40
-37
lines changed

2 files changed

+40
-37
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: faro
55
weight: 100
66
---
77

8-
# faro
8+
# `faro`
99

1010
This section contains reference documentation for the `faro` components.
1111

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

+39-36
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,24 @@ faro.receiver "<LABEL>" {
2929

3030
You can use the following arguments with `faro.receiver`:
3131

32-
Name | Type | Description | Default | Required
33-
-------------------|---------------|----------------------------------------------|---------|---------
34-
`extra_log_labels` | `map(string)` | Extra labels to attach to emitted log lines. | `{}` | no
32+
| Name | Type | Description | Default | Required |
33+
| ------------------ | ------------- | -------------------------------------------- | -------- | -------- |
34+
| `extra_log_labels` | `map(string)` | Extra labels to attach to emitted log lines. | `{}` | no |
3535

3636
## Blocks
3737

3838
You can use the following blocks with `faro.receiver`:
3939

40-
Block | Description | Required
41-
---------------------------------------------|------------------------------------------------------|---------
42-
[`output`][output] | Configures where to send collected telemetry data. | yes
43-
[`server`][server] | Configures the HTTP server. | no
44-
`server` > [`rate_limiting`][rate_limiting] | Configures rate limiting for the HTTP server. | no
45-
[`sourcemaps`][sourcemaps] | Configures sourcemap retrieval. | no
46-
`sourcemaps` > [`location`][location] | Configures on-disk location for sourcemap retrieval. | no
40+
| Block | Description | Required |
41+
| -------------------------------------------- | ---------------------------------------------------- | -------- |
42+
| [`output`][output] | Configures where to send collected telemetry data. | yes |
43+
| [`server`][server] | Configures the HTTP server. | no |
44+
| `server` > [`rate_limiting`][rate_limiting] | Configures rate limiting for the HTTP server. | no |
45+
| [`sourcemaps`][sourcemaps] | Configures sourcemap retrieval. | no |
46+
| `sourcemaps` > [`location`][location] | Configures on-disk location for sourcemap retrieval. | no |
47+
48+
The > symbol indicates deeper levels of nesting.
49+
For example, `sourcemaps` > `location` refers to a `location` block defined inside an `sourcemaps` block.
4750

4851
[location]: #location
4952
[output]: #output
@@ -55,24 +58,24 @@ Block | Description
5558

5659
The `output` block specifies where to forward collected logs and traces.
5760

58-
Name | Type | Description | Default | Required
59-
---------|--------------------------|------------------------------------------------------|---------|---------
60-
`logs` | `list(LogsReceiver)` | A list of `loki` components to forward logs to. | `[]` | no
61-
`traces` | `list(otelcol.Consumer)` | A list of `otelcol` components to forward traces to. | `[]` | no
61+
| Name | Type | Description | Default | Required |
62+
| -------- | ------------------------ | ---------------------------------------------------- | ------- | -------- |
63+
| `logs` | `list(LogsReceiver)` | A list of `loki` components to forward logs to. | `[]` | no |
64+
| `traces` | `list(otelcol.Consumer)` | A list of `otelcol` components to forward traces to. | `[]` | no |
6265

6366
### `server`
6467

6568
The `server` block configures the HTTP server managed by the `faro.receiver` component.
6669
Clients using the [Grafana Faro Web SDK][faro-sdk] forward telemetry data to this HTTP server for processing.
6770

68-
Name | Type | Description | Default | Required
69-
---------------------------|----------------|-----------------------------------------------------------------|-------------|---------
70-
`listen_address` | `string` | Address to listen for HTTP traffic on. | `127.0.0.1` | no
71-
`listen_port` | `number` | Port to listen for HTTP traffic on. | `12347` | no
72-
`cors_allowed_origins` | `list(string)` | Origins for which cross-origin requests are permitted. | `[]` | no
73-
`api_key` | `secret` | Optional API key to validate client requests with. | `""` | no
74-
`max_allowed_payload_size` | `string` | Maximum size (in bytes) for client requests. | `"5MiB"` | no
75-
`include_metadata` | `boolean` | Propagate incoming connection metadata to downstream consumers. | `false` | no
71+
| Name | Type | Description | Default | Required |
72+
| -------------------------- | -------------- | --------------------------------------------------------------- | ----------- | -------- |
73+
| `listen_address` | `string` | Address to listen for HTTP traffic on. | `127.0.0.1` | no |
74+
| `listen_port` | `number` | Port to listen for HTTP traffic on. | `12347` | no |
75+
| `cors_allowed_origins` | `list(string)` | Origins for which cross-origin requests are permitted. | `[]` | no |
76+
| `api_key` | `secret` | Optional API key to validate client requests with. | `""` | no |
77+
| `max_allowed_payload_size` | `string` | Maximum size (in bytes) for client requests. | `"5MiB"` | no |
78+
| `include_metadata` | `boolean` | Propagate incoming connection metadata to downstream consumers. | `false` | no |
7679

7780
By default, telemetry data is only accepted from applications on the same local network as the browser.
7881
To accept telemetry data from a wider set of clients, modify the `listen_address` attribute to the IP address of the appropriate network interface to use.
@@ -90,11 +93,11 @@ If the `api_key` argument is empty, no authentication checks are performed, and
9093

9194
The `rate_limiting` block configures rate limiting for client requests.
9295

93-
Name | Type | Description | Default | Required
94-
-------------|----------|--------------------------------------|---------|---------
95-
`enabled` | `bool` | Whether to enable rate limiting. | `true` | no
96-
`rate` | `number` | Rate of allowed requests per second. | `50` | no
97-
`burst_size` | `number` | Allowed burst size of requests. | `100` | no
96+
| Name | Type | Description | Default | Required |
97+
| ------------ | -------- | ------------------------------------ | ------- | -------- |
98+
| `enabled` | `bool` | Whether to enable rate limiting. | `true` | no |
99+
| `rate` | `number` | Rate of allowed requests per second. | `50` | no |
100+
| `burst_size` | `number` | Allowed burst size of requests. | `100` | no |
98101

99102
Rate limiting functions as a [token bucket algorithm][token-bucket], where a bucket has a maximum capacity for up to `burst_size` requests and refills at a rate of `rate` per second.
100103

@@ -109,11 +112,11 @@ Configuring the `rate` argument determines how fast the bucket refills, and conf
109112
The `sourcemaps` block configures how to retrieve sourcemaps.
110113
Sourcemaps are then used to transform file and line information from minified code into the file and line information from the original source code.
111114

112-
Name | Type | Description | Default | Required
113-
------------------------|----------------|--------------------------------------------|---------|---------
114-
`download` | `bool` | Whether to download sourcemaps. | `true` | no
115-
`download_from_origins` | `list(string)` | Which origins to download sourcemaps from. | `["*"]` | no
116-
`download_timeout` | `duration` | Timeout when downloading sourcemaps. | `"1s"` | no
115+
| Name | Type | Description | Default | Required |
116+
| ----------------------- | -------------- | ------------------------------------------ | ------- | -------- |
117+
| `download` | `bool` | Whether to download sourcemaps. | `true` | no |
118+
| `download_from_origins` | `list(string)` | Which origins to download sourcemaps from. | `["*"]` | no |
119+
| `download_timeout` | `duration` | Timeout when downloading sourcemaps. | `"1s"` | no |
117120

118121
When exceptions are sent to the `faro.receiver` component, it can download sourcemaps from the web application.
119122
You can disable this behavior by setting the `download` argument to `false`.
@@ -134,10 +137,10 @@ When `location` blocks are provided, they're checked first for sourcemaps before
134137
The `location` block declares a location where sourcemaps are stored on the filesystem.
135138
You can specify the `location` block multiple times to declare multiple locations where sourcemaps are stored.
136139

137-
Name | Type | Description | Default | Required
138-
-----------------------|----------|-----------------------------------------------------|---------|---------
139-
`minified_path_prefix` | `string` | The prefix of the minified path sent from browsers. | | yes
140-
`path` | `string` | The path on disk where sourcemaps are stored. | | yes
140+
| Name | Type | Description | Default | Required |
141+
| ---------------------- | -------- | --------------------------------------------------- | ------- | -------- |
142+
| `minified_path_prefix` | `string` | The prefix of the minified path sent from browsers. | | yes |
143+
| `path` | `string` | The path on disk where sourcemaps are stored. | | yes |
141144

142145
The `minified_path_prefix` argument determines the prefix of paths to JavaScript files, such as `http://example.com/`.
143146
The `path` argument then determines where to find the sourcemap for the file.

0 commit comments

Comments
 (0)