Skip to content

Commit

Permalink
regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thampiotr committed Nov 15, 2023
1 parent 9bfcf7a commit 51bfdae
Show file tree
Hide file tree
Showing 72 changed files with 769 additions and 43 deletions.
2 changes: 1 addition & 1 deletion docs/generator/component_links.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func WriteCompatibleComponentsSection(componentName string) error {
var newFileContents []byte
if startIndex == -1 || endIndex == -1 {
// Append the new section to the end of the file
newFileContents = append(fileContents, replacement...)
newFileContents = append(fileContents, append([]byte("\n"), replacement...)...)
} else {
// Replace the section with the new content
newFileContents = append(fileContents[:startIndex], replacement...)
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/components/discovery.azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components
Expand All @@ -161,8 +162,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
20 changes: 20 additions & 0 deletions docs/sources/flow/reference/components/discovery.consul.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,3 +167,23 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

`discovery.consul` can output data to the following components:

- Components that accept Targets:
- [`discovery.relabel`]({{< relref "../components/discovery.relabel.md" >}})
- [`local.file_match`]({{< relref "../components/local.file_match.md" >}})
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.

<!-- END GENERATED COMPATIBLE COMPONENTS -->
20 changes: 20 additions & 0 deletions docs/sources/flow/reference/components/discovery.consulagent.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,23 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

`discovery.consulagent` can output data to the following components:

- Components that accept Targets:
- [`discovery.relabel`]({{< relref "../components/discovery.relabel.md" >}})
- [`local.file_match`]({{< relref "../components/local.file_match.md" >}})
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.

<!-- END GENERATED COMPATIBLE COMPONENTS -->
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components
Expand All @@ -132,8 +133,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
6 changes: 4 additions & 2 deletions docs/sources/flow/reference/components/discovery.dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,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.<!-- START GENERATED COMPATIBLE COMPONENTS -->
- `PASSWORD`: The password to use for authentication to the remote_write API.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

Expand All @@ -105,8 +107,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/components/discovery.docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ Replace the following:

> **NOTE**: This example requires the "Expose daemon on tcp://localhost:2375
> without TLS" setting to be enabled in the Docker Engine settings.
<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components
Expand All @@ -227,8 +228,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
20 changes: 20 additions & 0 deletions docs/sources/flow/reference/components/discovery.dockerswarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,23 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

`discovery.dockerswarm` can output data to the following components:

- Components that accept Targets:
- [`discovery.relabel`]({{< relref "../components/discovery.relabel.md" >}})
- [`local.file_match`]({{< relref "../components/local.file_match.md" >}})
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.

<!-- END GENERATED COMPATIBLE COMPONENTS -->
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/components/discovery.ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components
Expand All @@ -146,8 +147,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/components/discovery.eureka.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components
Expand All @@ -152,8 +153,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
6 changes: 4 additions & 2 deletions docs/sources/flow/reference/components/discovery.file.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,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.<!-- START GENERATED COMPATIBLE COMPONENTS -->
- `PASSWORD`: The password to use for authentication to the remote_write API.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

Expand All @@ -184,8 +186,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
6 changes: 4 additions & 2 deletions docs/sources/flow/reference/components/discovery.gce.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,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.<!-- START GENERATED COMPATIBLE COMPONENTS -->
- `PASSWORD`: The password to use for authentication to the remote_write API.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

Expand All @@ -124,8 +126,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
20 changes: 20 additions & 0 deletions docs/sources/flow/reference/components/discovery.hetzner.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,23 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

`discovery.hetzner` can output data to the following components:

- Components that accept Targets:
- [`discovery.relabel`]({{< relref "../components/discovery.relabel.md" >}})
- [`local.file_match`]({{< relref "../components/local.file_match.md" >}})
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.

<!-- END GENERATED COMPATIBLE COMPONENTS -->
20 changes: 20 additions & 0 deletions docs/sources/flow/reference/components/discovery.http.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,3 +168,23 @@ discovery.http "dynamic_targets" {
refresh_interval = "15s"
}
```

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

`discovery.http` can output data to the following components:

- Components that accept Targets:
- [`discovery.relabel`]({{< relref "../components/discovery.relabel.md" >}})
- [`local.file_match`]({{< relref "../components/local.file_match.md" >}})
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.

<!-- END GENERATED COMPATIBLE COMPONENTS -->
20 changes: 20 additions & 0 deletions docs/sources/flow/reference/components/discovery.ionos.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,23 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components

`discovery.ionos` can output data to the following components:

- Components that accept Targets:
- [`discovery.relabel`]({{< relref "../components/discovery.relabel.md" >}})
- [`local.file_match`]({{< relref "../components/local.file_match.md" >}})
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.

<!-- END GENERATED COMPATIBLE COMPONENTS -->
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/components/discovery.kubelet.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ 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.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components
Expand All @@ -205,8 +206,8 @@ Replace the following:
- [`loki.source.docker`]({{< relref "../components/loki.source.docker.md" >}})
- [`loki.source.file`]({{< relref "../components/loki.source.file.md" >}})
- [`loki.source.kubernetes`]({{< relref "../components/loki.source.kubernetes.md" >}})
- [`otelcol.processor.discovery`]({{< relref "../components/otelcol.processor.discovery.md" >}})
- [`prometheus.scrape`]({{< relref "../components/prometheus.scrape.md" >}})
- [`pyroscope.ebpf`]({{< relref "../components/pyroscope.ebpf.md" >}})
- [`pyroscope.scrape`]({{< relref "../components/pyroscope.scrape.md" >}})

Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
Expand Down
Loading

0 comments on commit 51bfdae

Please sign in to comment.