Skip to content

Commit

Permalink
feedback, thanks
Browse files Browse the repository at this point in the history
  • Loading branch information
thampiotr committed Nov 30, 2023
1 parent 4c10ed2 commit 0cb987e
Show file tree
Hide file tree
Showing 118 changed files with 601 additions and 145 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ If the check fails, then the doc supported services list should be updated. For

## Update generated reference docs

Some sections of Agent Flow reference documentation are automatically generated. To update them, run `make generate-docs`.
Some sections of Grafana Agent Flow reference documentation are automatically generated. To update them, run `make generate-docs`.

### Community Projects

Below is a list of community-led projects for working with Grafana Agent. These projects are not maintained or supported by Grafana Labs.
The following is a list of community-led projects for working with Grafana Agent. These projects are not maintained or supported by Grafana Labs.

#### Helm (Kubernetes Deployment)

Expand Down
11 changes: 8 additions & 3 deletions docs/generator/links_to_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,14 @@ func (l *LinksToTypesGenerator) Generate() (string, error) {
return "", nil
}

note := "\nNote 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.\n\n"
note := `
{{% admonition type="note" %}}
Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.
{{% /admonition %}}
`

return heading + acceptingSection + outputSection + note, nil
}
Expand Down
41 changes: 16 additions & 25 deletions docs/sources/flow/reference/compatibility/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,15 @@ that can export or consume it.

## Targets

Targets are a `list(map(string))` - a [list]({{< relref "../../config-language/expressions/types_and_values/#naming-convention" >}}) of [maps]({{< relref "../../config-language/expressions/types_and_values/#naming-convention" >}}) with [string]({{< relref "../../config-language/expressions/types_and_values/#strings" >}}) values. As such,
they can contain different key-value pairs and can be used with a wide range of
components. Some components require Targets to contain specific key-value pairs in order
to work correctly, it is recommended to always check component reference for
Targets are a `list(map(string))` - a [list]({{< relref "../../config-language/expressions/types_and_values/#naming-convention" >}}) of [maps]({{< relref "../../config-language/expressions/types_and_values/#naming-convention" >}}) with [string]({{< relref "../../config-language/expressions/types_and_values/#strings" >}}) values.
They can contain different key-value pairs, and you can use them with a wide range of
components. Some components require Targets to contain specific key-value pairs
to work correctly. It is recommended to always check component references for
details when working with Targets.

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Targets Exporters
Below are components that _export_ Targets grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _export_ Targets.

<!-- START GENERATED SECTION: EXPORTERS OF Targets -->

Expand Down Expand Up @@ -116,8 +115,7 @@ on the namespace to expand and see more detail.

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Targets Consumers
Below are components that _consume_ Targets grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _consume_ Targets.

<!-- START GENERATED SECTION: CONSUMERS OF Targets -->

Expand Down Expand Up @@ -161,8 +159,7 @@ following components to build your Prometheus metrics pipeline:

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Prometheus `MetricsReceiver` Exporters
Below are components that _export_ Prometheus `MetricsReceiver`, grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _export_ Prometheus `MetricsReceiver`.

<!-- START GENERATED SECTION: EXPORTERS OF Prometheus `MetricsReceiver` -->

Expand All @@ -179,8 +176,8 @@ on the namespace to expand and see more detail.

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Prometheus `MetricsReceiver` Consumers
Below are components that _consume_ Prometheus `MetricsReceiver`, grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _consume_ Prometheus `MetricsReceiver`.

<!-- START GENERATED SECTION: CONSUMERS OF Prometheus `MetricsReceiver` -->

Expand Down Expand Up @@ -210,8 +207,7 @@ following components to build your Loki logs pipeline:

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Loki `LogsReceiver` Exporters
Below are components that _export_ Loki `LogsReceiver` grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _export_ Loki `LogsReceiver`.

<!-- START GENERATED SECTION: EXPORTERS OF Loki `LogsReceiver` -->

Expand All @@ -230,8 +226,7 @@ on the namespace to expand and see more detail.

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Loki `LogsReceiver` Consumers
Below are components that _consume_ Loki `LogsReceiver` grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _consume_ Loki `LogsReceiver`.

<!-- START GENERATED SECTION: CONSUMERS OF Loki `LogsReceiver` -->

Expand Down Expand Up @@ -273,13 +268,12 @@ The OpenTelemetry data is sent between components using `otelcol.Consumer`s.
`otelcol.Consumer`s are [capsules]({{< relref "../../config-language/expressions/types_and_values/#capsules" >}})
that are exported by components that can receive OpenTelemetry data. Components that
can consume OpenTelemetry data can be passed the `otelcol.Consumer` as an argument. Note that some components
that use `otelcol.Consumer` only support a subset of telemetry signals, e.g. only traces. Check the component
that use `otelcol.Consumer` only support a subset of telemetry signals, for example, only traces. Check the component
reference pages for more details on what is supported. Use the following components to build your OpenTelemetry pipeline:

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### OpenTelemetry `otelcol.Consumer` Exporters
Below are components that _export_ OpenTelemetry `otelcol.Consumer`, grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _export_ OpenTelemetry `otelcol.Consumer`.

<!-- START GENERATED SECTION: EXPORTERS OF OpenTelemetry `otelcol.Consumer` -->

Expand Down Expand Up @@ -309,8 +303,7 @@ on the namespace to expand and see more detail.

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### OpenTelemetry `otelcol.Consumer` Consumers
Below are components that _consume_ OpenTelemetry `otelcol.Consumer`, grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _consume_ OpenTelemetry `otelcol.Consumer`.

<!-- START GENERATED SECTION: CONSUMERS OF OpenTelemetry `otelcol.Consumer` -->

Expand Down Expand Up @@ -356,8 +349,7 @@ following components to build your Pyroscope profiles pipeline:

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Pyroscope `ProfilesReceiver` Exporters
Below are components that _export_ Pyroscope `ProfilesReceiver`, grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _export_ Pyroscope `ProfilesReceiver`.

<!-- START GENERATED SECTION: EXPORTERS OF Pyroscope `ProfilesReceiver` -->

Expand All @@ -369,8 +361,7 @@ on the namespace to expand and see more detail.

<!-- NOTE: this title is used as an anchor in links. Do not change. -->
### Pyroscope `ProfilesReceiver` Consumers
Below are components that _consume_ Pyroscope `ProfilesReceiver`, grouped by namespace. Click
on the namespace to expand and see more detail.
The following components, grouped by namespace, _consume_ Pyroscope `ProfilesReceiver`.

<!-- START GENERATED SECTION: CONSUMERS OF Pyroscope `ProfilesReceiver` -->

Expand Down
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.consul.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.eureka.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.file.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.gce.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.hetzner.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.http.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,11 @@ discovery.http "dynamic_targets" {

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.ionos.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.kubelet.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.kuma.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,11 @@ Replace the following:

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
6 changes: 5 additions & 1 deletion docs/sources/flow/reference/components/discovery.linode.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,11 @@ prometheus.remote_write "demo" {

- Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}})

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.
{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
Loading

0 comments on commit 0cb987e

Please sign in to comment.