Skip to content

Commit

Permalink
More updates to style and block sorting
Browse files Browse the repository at this point in the history
  • Loading branch information
clayton-cornell committed Nov 17, 2023
1 parent e56219c commit 6e4b22a
Show file tree
Hide file tree
Showing 12 changed files with 247 additions and 259 deletions.
14 changes: 7 additions & 7 deletions docs/sources/flow/reference/components/discovery.azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,10 @@ prometheus.remote_write "demo" {
}
```
Replace the following:
- `<AZURE_SUBSCRIPTION_ID>`: Your Azure subscription ID.
- `<AZURE_CLIENT_ID>`: Your Azure client ID.
- `<AZURE_CLIENT_SECRET>`: Your Azure client secret.
- `<AZURE_TENANT_ID>`: Your Azure tenant ID.
- `<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.
- _`<AZURE_SUBSCRIPTION_ID>`_: Your Azure subscription ID.
- _`<AZURE_CLIENT_ID>`_: Your Azure client ID.
- _`<AZURE_CLIENT_SECRET>`_: Your Azure client secret.
- _`<AZURE_TENANT_ID>`_: Your Azure tenant ID.
- _`<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.
32 changes: 16 additions & 16 deletions docs/sources/flow/reference/components/discovery.consul.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,19 +104,19 @@ Name | Type | Description

Each target includes the following labels:

* `__meta_consul_address`: the address of the target.
* `__meta_consul_dc`: the datacenter name for the target.
* `__meta_consul_health`: the health status of the service.
* `__meta_consul_metadata_<key>`: each node metadata key value of the target.
* `__meta_consul_node`: the node name defined for the target.
* `__meta_consul_partition`: the admin partition name where the service is registered.
* `__meta_consul_service_address`: the service address of the target.
* `__meta_consul_service_id`: the service ID of the target.
* `__meta_consul_service_metadata_<key>`: each service metadata key value of the target.
* `__meta_consul_service_port`: the service port of the target.
* `__meta_consul_service`: the name of the service the target belongs to.
* `__meta_consul_tagged_address_<key>`: each node tagged address key value of the target.
* `__meta_consul_tags`: the list of tags of the target joined by the tag separator.
* `__meta_consul_address`: The address of the target.
* `__meta_consul_dc`: The datacenter name for the target.
* `__meta_consul_health`: The health status of the service.
* `__meta_consul_metadata_<key>`: Each node metadata key value of the target.
* `__meta_consul_node`: The node name defined for the target.
* `__meta_consul_partition`: The admin partition name where the service is registered.
* `__meta_consul_service_address`: The service address of the target.
* `__meta_consul_service_id`: The service ID of the target.
* `__meta_consul_service_metadata_<key>`: Each service metadata key value of the target.
* `__meta_consul_service_port`: The service port of the target.
* `__meta_consul_service`: The name of the service the target belongs to.
* `__meta_consul_tagged_address_<key>`: Each node tagged address key value of the target.
* `__meta_consul_tags`: The list of tags of the target joined by the tag separator.

## Component health

Expand Down Expand Up @@ -160,6 +160,6 @@ prometheus.remote_write "demo" {
}
```
Replace the following:
- `<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.
- _`<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.
32 changes: 16 additions & 16 deletions docs/sources/flow/reference/components/discovery.consulagent.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,18 @@ The following fields are exported and can be referenced by other components:

Each target includes the following labels:

- `__meta_consulagent_address`: the address of the target.
- `__meta_consulagent_dc`: the datacenter name for the target.
- `__meta_consulagent_health`: the health status of the service.
- `__meta_consulagent_metadata_<key>`: each node metadata key value of the target.
- `__meta_consulagent_node`: the node name defined for the target.
- `__meta_consulagent_service_address`: the service address of the target.
- `__meta_consulagent_service_id`: the service ID of the target.
- `__meta_consulagent_service_metadata_<key>`: each service metadata key value of the target.
- `__meta_consulagent_service_port`: the service port of the target.
- `__meta_consulagent_service`: the name of the service the target belongs to.
- `__meta_consulagent_tagged_address_<key>`: each node tagged address key value of the target.
- `__meta_consulagent_tags`: the list of tags of the target joined by the tag separator.
- `__meta_consulagent_address`: The address of the target.
- `__meta_consulagent_dc`: The datacenter name for the target.
- `__meta_consulagent_health`: The health status of the service.
- `__meta_consulagent_metadata_<key>`: Each node metadata key value of the target.
- `__meta_consulagent_node`: The node name defined for the target.
- `__meta_consulagent_service_address`: The service address of the target.
- `__meta_consulagent_service_id`: The service ID of the target.
- `__meta_consulagent_service_metadata_<key>`: Each service metadata key value of the target.
- `__meta_consulagent_service_port`: The service port of the target.
- `__meta_consulagent_service`: The name of the service the target belongs to.
- `__meta_consulagent_tagged_address_<key>`: Each node tagged address key value of the target.
- `__meta_consulagent_tags`: The list of tags of the target joined by the tag separator.

## Component health

Expand All @@ -84,7 +84,7 @@ In those cases, exported fields retain their last healthy values.

## Debug information

`discovery.consulagent` doen't expose any component-specific debug information.
`discovery.consulagent` doesn't expose any component-specific debug information.

## Debug metrics

Expand Down Expand Up @@ -124,6 +124,6 @@ prometheus.remote_write "demo" {

Replace the following:

- `<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.
- _`<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.
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,6 @@ prometheus.remote_write "demo" {
}
```
Replace the following:
- `<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.
- _`<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.
6 changes: 3 additions & 3 deletions docs/sources/flow/reference/components/discovery.dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,6 @@ prometheus.remote_write "demo" {
}
```
Replace the following:
- `<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.
- _`<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.
12 changes: 6 additions & 6 deletions docs/sources/flow/reference/components/discovery.docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,9 @@ prometheus.remote_write "demo" {
}
```
Replace the following:
- `<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.
- _`<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.

### Windows hosts

Expand Down Expand Up @@ -198,9 +198,9 @@ prometheus.remote_write "demo" {
}
```
Replace the following:
- `<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.
- _`<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.

{{% admonition type="note" %}}
This example requires the "Expose daemon on tcp://localhost:2375 without TLS" setting to be enabled in the Docker Engine settings.
Expand Down
Loading

0 comments on commit 6e4b22a

Please sign in to comment.