More of the same updated

grafana · Nov 21, 2023 · f311c88 · f311c88
1 parent 80b26ca
commit f311c88
Show file tree

Hide file tree

Showing 9 changed files with 272 additions and 297 deletions.
diff --git a/docs/sources/flow/reference/components/discovery.dockerswarm.md b/docs/sources/flow/reference/components/discovery.dockerswarm.md
@@ -57,14 +57,14 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside
 [oauth2]: #oauth2-block
 [tls_config]: #tls_config-block
 
-### authorization block
+### authorization
 
-{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="<AGENT VERSION>" >}}
-### basic_auth block
+{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="<AGENT_VERSION>" >}}
+### basic_auth
 
-{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
-### filter block
+### filter
 
 Filters can be used to limit the discovery process to a subset of available resources.
 It's possible to define multiple `filter` blocks within the `discovery.dockerswarm` block.
@@ -81,13 +81,13 @@ The following arguments can be used to configure a filter.
 | `name`   | `string`       | Name of the filter.                        |         | yes      |
 | `values` | `list(string)` | List of values associated with the filter. |         | yes      |
 
-### oauth2 block
+### oauth2
 
-{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
-### oauth2 > tls_config block
+### oauth2 > tls_config
 
-{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ## Exported fields
 
@@ -165,25 +165,24 @@ The `nodes` role is used to discover [Swarm nodes](https://docs.docker.com/engin
 
 Available meta labels:
 
-- `__meta_dockerswarm_node_address`: the address of the node.
-- `__meta_dockerswarm_node_availability`: the availability of the node.
-- `__meta_dockerswarm_node_engine_version`: the version of the node engine.
-- `__meta_dockerswarm_node_hostname`: the hostname of the node.
-- `__meta_dockerswarm_node_id`: the ID of the node.
-- `__meta_dockerswarm_node_label_<labelname>`: each label of the node.
-- `__meta_dockerswarm_node_manager_address`: the address of the manager component of the node.
-- `__meta_dockerswarm_node_manager_leader`: the leadership status of the manager component of the node (true or false).
-- `__meta_dockerswarm_node_manager_reachability`: the reachability of the manager component of the node.
-- `__meta_dockerswarm_node_platform_architecture`: the architecture of the node.
-- `__meta_dockerswarm_node_platform_os`: the operating system of the node.
-- `__meta_dockerswarm_node_role`: the role of the node.
-- `__meta_dockerswarm_node_status`: the status of the node.
+- `__meta_dockerswarm_node_address`: The address of the node.
+- `__meta_dockerswarm_node_availability`: The availability of the node.
+- `__meta_dockerswarm_node_engine_version`: The version of the node engine.
+- `__meta_dockerswarm_node_hostname`: The hostname of the node.
+- `__meta_dockerswarm_node_id`: The ID of the node.
+- `__meta_dockerswarm_node_label_<labelname>`: Each label of the node.
+- `__meta_dockerswarm_node_manager_address`: The address of the manager component of the node.
+- `__meta_dockerswarm_node_manager_leader`: The leadership status of the manager component of the node (true or false).
+- `__meta_dockerswarm_node_manager_reachability`: The reachability of the manager component of the node.
+- `__meta_dockerswarm_node_platform_architecture`: The architecture of the node.
+- `__meta_dockerswarm_node_platform_os`: The operating system of the node.
+- `__meta_dockerswarm_node_role`: The role of the node.
+- `__meta_dockerswarm_node_status`: The status of the node.
 
 ## Component health
 
-`discovery.dockerswarm` is only reported as unhealthy when given an invalid
-configuration. In those cases, exported fields retain their last healthy
-values.
+`discovery.dockerswarm` is only reported as unhealthy when given an invalid configuration.
+In those cases, exported fields retain their last healthy values.
 
 ## Debug information
 

diff --git a/docs/sources/flow/reference/components/discovery.ec2.md b/docs/sources/flow/reference/components/discovery.ec2.md
@@ -47,7 +47,7 @@ filter    | [filter][] | Filters discoverable resources. | no
 
 [filter]: #filter-block
 
-### filter block
+### filter
 
 Filters can be used optionally to filter the instance list by other criteria.
 Available filter criteria can be found in the [Amazon EC2 documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html).

diff --git a/docs/sources/flow/reference/components/discovery.eureka.md b/docs/sources/flow/reference/components/discovery.eureka.md
@@ -30,9 +30,9 @@ The following arguments are supported:
 Name                | Type       | Description                                                            | Default              | Required
 ------------------- | ---------- | ---------------------------------------------------------------------- | -------------------- | --------
 `server`            | `string`   | Eureka server URL.                                                     |                      | yes
-`refresh_interval`  | `duration` | Interval at which to refresh the list of targets.                      | `30s`                | no
 `enable_http2`      | `bool`     | Whether HTTP2 is supported for requests.                               | `true`               | no
 `follow_redirects`  | `bool`     | Whether redirects returned by the server should be followed.           | `true`               | no
+`refresh_interval`  | `duration` | Interval at which to refresh the list of targets.                      | `30s`                | no
 
 ## Blocks
 The following blocks are supported inside the definition of `discovery.eureka`:
@@ -54,19 +54,19 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside
 
 ### authorization
 
-{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ### basic_auth
 
-{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ### oauth2
 
-{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ### oauth2 > tls_config
 
-{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ## Exported fields
 
@@ -78,7 +78,6 @@ Name      | Type                | Description
 
 Each target includes the following labels:
 
-* `__meta_eureka_app_name`
 * `__meta_eureka_app_instance_country_id`
 * `__meta_eureka_app_instance_datacenterinfo_metadata_`
 * `__meta_eureka_app_instance_datacenterinfo_name`
@@ -96,6 +95,7 @@ Each target includes the following labels:
 * `__meta_eureka_app_instance_status`
 * `__meta_eureka_app_instance_statuspage_url`
 * `__meta_eureka_app_instance_vip_address`
+* `__meta_eureka_app_name`
 
 ## Component health
 

diff --git a/docs/sources/flow/reference/components/discovery.hetzner.md b/docs/sources/flow/reference/components/discovery.hetzner.md
@@ -72,19 +72,19 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside
 
 ### authorization
 
-{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/authorization-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ### basic_auth
 
-{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ### oauth2
 
-{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/oauth2-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ### oauth2 > tls_config
 
-{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="<AGENT VERSION>" >}}
+{{< docs/shared lookup="flow/reference/components/tls-config-block.md" source="agent" version="<AGENT_VERSION>" >}}
 
 ## Exported fields
 
@@ -96,38 +96,38 @@ Name | Type | Description
 
 Each target includes the following labels:
 
+* `__meta_hetzner_datacenter`: the datacenter of the server
+* `__meta_hetzner_public_ipv4`: the public ipv4 address of the server
+* `__meta_hetzner_public_ipv6_network`: the public ipv6 network (/64) of the server
 * `__meta_hetzner_server_id`: the ID of the server
 * `__meta_hetzner_server_name`: the name of the server
 * `__meta_hetzner_server_status`: the status of the server
-* `__meta_hetzner_public_ipv4`: the public ipv4 address of the server
-* `__meta_hetzner_public_ipv6_network`: the public ipv6 network (/64) of the server
-* `__meta_hetzner_datacenter`: the datacenter of the server
 
 ### `hcloud`
 
 The labels below are only available for targets with `role` set to `hcloud`:
 
-* `__meta_hetzner_hcloud_image_name`: the image name of the server
-* `__meta_hetzner_hcloud_image_description`: the description of the server image
-* `__meta_hetzner_hcloud_image_os_flavor`: the OS flavor of the server image
-* `__meta_hetzner_hcloud_image_os_version`: the OS version of the server image
-* `__meta_hetzner_hcloud_datacenter_location`: the location of the server
-* `__meta_hetzner_hcloud_datacenter_location_network_zone`: the network zone of the server
-* `__meta_hetzner_hcloud_server_type`: the type of the server
 * `__meta_hetzner_hcloud_cpu_cores`: the CPU cores count of the server
 * `__meta_hetzner_hcloud_cpu_type`: the CPU type of the server (shared or dedicated)
-* `__meta_hetzner_hcloud_memory_size_gb`: the amount of memory of the server (in GB)
+* `__meta_hetzner_hcloud_datacenter_location_network_zone`: the network zone of the server
+* `__meta_hetzner_hcloud_datacenter_location`: the location of the server
 * `__meta_hetzner_hcloud_disk_size_gb`: the disk size of the server (in GB)
-* `__meta_hetzner_hcloud_private_ipv4_<networkname>`: the private ipv4 address of the server within a given network
+* `__meta_hetzner_hcloud_image_description`: the description of the server image
+* `__meta_hetzner_hcloud_image_name`: the image name of the server
+* `__meta_hetzner_hcloud_image_os_flavor`: the OS flavor of the server image
+* `__meta_hetzner_hcloud_image_os_version`: the OS version of the server image
 * `__meta_hetzner_hcloud_label_<labelname>`: each label of the server
 * `__meta_hetzner_hcloud_labelpresent_<labelname>`: `true` for each label of the server
+* `__meta_hetzner_hcloud_memory_size_gb`: the amount of memory of the server (in GB)
+* `__meta_hetzner_hcloud_private_ipv4_<networkname>`: the private ipv4 address of the server within a given network
+* `__meta_hetzner_hcloud_server_type`: the type of the server
 
 ### `robot`
 
 The labels below are only available for targets with `role` set to `robot`:
 
-* `__meta_hetzner_robot_product`: the product of the server
 * `__meta_hetzner_robot_cancelled`: the server cancellation status
+* `__meta_hetzner_robot_product`: the product of the server
 
 
 ## Component health
@@ -138,19 +138,19 @@ values.
 
 ## Debug information
 
-`discovery.hetzner` does not expose any component-specific debug information.
+`discovery.hetzner` doesn't expose any component-specific debug information.
 
 ## Debug metrics
 
-`discovery.hetzner` does not expose any component-specific debug metrics.
+`discovery.hetzner` doesn't expose any component-specific debug metrics.
 
 ## Example
 
-This example discovers targets from Hetzner:
+The following example discovers targets from Hetzner:
 
 ```river
 discovery.hetzner "example" {
-  role = HETZNER_ROLE
+  role = <HETZNER_ROLE>
 }
 
 prometheus.scrape "demo" {
@@ -160,17 +160,17 @@ prometheus.scrape "demo" {
 
 prometheus.remote_write "demo" {
   endpoint {
-    url = PROMETHEUS_REMOTE_WRITE_URL
+    url = <PROMETHEUS_REMOTE_WRITE_URL>
 
     basic_auth {
-      username = USERNAME
-      password = PASSWORD
+      username = <USERNAME>
+      password = <PASSWORD>
     }
   }
 }
 ```
 Replace the following:
-  - `HETZNER_ROLE`: The role of the entities that should be discovered.
-  - `PROMETHEUS_REMOTE_WRITE_URL`: The URL of the Prometheus remote_write-compatible server to send metrics to.
-  - `USERNAME`: The username to use for authentication to the remote_write API.
-  - `PASSWORD`: The password to use for authentication to the remote_write API.
+  - _`<HETZNER_ROLE>`_: The role of the entities that should be discovered.
+  - _`<PROMETHEUS_REMOTE_WRITE_URL>`_: The URL of the Prometheus remote_write-compatible server to send metrics to.
+  - _`<USERNAME>`_: The username to use for authentication to the remote_write API.
+  - _`<PASSWORD>`_: The password to use for authentication to the remote_write API.