Skip to content

Commit

Permalink
Update reference paths in tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
clayton-cornell committed Feb 29, 2024
1 parent 4786954 commit 2f1eccf
Show file tree
Hide file tree
Showing 22 changed files with 267 additions and 604 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ title: Grafana Agent Flow deployment topologies
weight: 900
---

{{< docs/shared source="agent" lookup="/deploy-agent.md" version="<AGENT_VERSION>" >}}
{{< docs/shared source="alloy" lookup="/deploy-agent.md" version="<AGENT_VERSION>" >}}

## Processing different types of telemetry in different {{< param "PRODUCT_ROOT_NAME" >}} instances

Expand Down
18 changes: 4 additions & 14 deletions docs/sources/tasks/_index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/
- /docs/grafana-cloud/send-data/agent/flow/tasks/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/
- getting_started/ # /docs/agent/latest/flow/getting_started/
- getting-started/ # /docs/agent/latest/flow/getting-started/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/
description: How to perform common tasks with Grafana Agent Flow
- ./tasks/
canonical: https://grafana.com/docs/alloy/latest/tasks/
description: How to perform common tasks with Grafana Alloy
menuTitle: Tasks
title: Tasks with Grafana Agent Flow
title: Tasks with Grafana Alloy
weight: 200
---

Expand Down
35 changes: 8 additions & 27 deletions docs/sources/tasks/collect-opentelemetry-data.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/collect-opentelemetry-data/
- /docs/grafana-cloud/send-data/agent/flow/tasks/collect-opentelemetry-data/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/collect-opentelemetry-data/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/collect-opentelemetry-data/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/collect-opentelemetry-data/
- ../getting-started/collect-opentelemetry-data/ # /docs/agent/latest/flow/getting-started/collect-opentelemetry-data/
- ./tasks/collect-opentelemetry-data/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/collect-opentelemetry-data/
description: Learn how to collect OpenTelemetry data
title: Collect OpenTelemetry data
Expand All @@ -18,8 +9,7 @@ weight: 300

# Collect OpenTelemetry data

{{< param "PRODUCT_NAME" >}} can be configured to collect [OpenTelemetry][]-compatible
data and forward it to any OpenTelemetry-compatible endpoint.
{{< param "PRODUCT_NAME" >}} can be configured to collect [OpenTelemetry][]-compatible data and forward it to any OpenTelemetry-compatible endpoint.

This topic describes how to:

Expand Down Expand Up @@ -318,18 +308,9 @@ For more information on receiving OpenTelemetry data using the OpenTelemetry Pro
[OpenTelemetry]: https://opentelemetry.io
[Configure an OpenTelemetry Protocol exporter]: #configure-an-opentelemetry-protocol-exporter
[Configure batching]: #configure-batching

{{% docs/reference %}}
[otelcol.auth.basic]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/otelcol.auth.basic.md"
[otelcol.auth.basic]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/otelcol.auth.basic.md"
[otelcol.exporter.otlp]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/otelcol.exporter.otlp.md"
[otelcol.exporter.otlp]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/otelcol.exporter.otlp.md"
[otelcol.exporter.otlphttp]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/otelcol.exporter.otlphttp.md"
[otelcol.exporter.otlphttp]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/otelcol.exporter.otlphttp.md"
[otelcol.processor.batch]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/otelcol.processor.batch.md"
[otelcol.processor.batch]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/otelcol.processor.batch.md"
[otelcol.receiver.otlp]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/otelcol.receiver.otlp.md"
[otelcol.receiver.otlp]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/otelcol.receiver.otlp.md"
[Components]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/components.md"
[Components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md"
{{% /docs/reference %}}
[otelcol.auth.basic]: ../../reference/components/otelcol.auth.basic/
[otelcol.exporter.otlp]: ../../reference/components/otelcol.exporter.otlp/
[otelcol.exporter.otlphttp]: ../../reference/components/otelcol.exporter.otlphttp/
[otelcol.processor.batch]: ../../reference/components/otelcol.processor.batch/
[otelcol.receiver.otlp]: ../../reference/components/otelcol.receiver.otlp/
[Components]: ../../concepts/components/
29 changes: 6 additions & 23 deletions docs/sources/tasks/collect-prometheus-metrics.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/collect-prometheus-metrics/
- /docs/grafana-cloud/send-data/agent/flow/tasks/collect-prometheus-metrics/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/collect-prometheus-metrics/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/collect-prometheus-metrics/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/collect-prometheus-metrics/
- ../getting-started/collect-prometheus-metrics/ # /docs/agent/latest/flow/getting-started/collect-prometheus-metrics/
- ./tasks/collect-prometheus-metrics/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/collect-prometheus-metrics/
description: Learn how to collect and forward Prometheus metrics
title: Collect and forward Prometheus metrics
Expand Down Expand Up @@ -436,16 +427,8 @@ prometheus.remote_write "default" {
[Field Selectors]: https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
[Labels and Selectors]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#set-based-requirement
[Configure metrics delivery]: #configure-metrics-delivery

{{% docs/reference %}}
[discovery.kubernetes]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/discovery.kubernetes.md"
[discovery.kubernetes]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/discovery.kubernetes.md"
[prometheus.remote_write]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/prometheus.remote_write.md"
[prometheus.remote_write]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/prometheus.remote_write.md"
[prometheus.scrape]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/reference/components/prometheus.scrape.md"
[prometheus.scrape]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/prometheus.scrape.md"
[Components]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/components.md"
[Components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md"
[Objects]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/config-language/expressions/types_and_values.md#objects"
[Objects]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/config-language/expressions/types_and_values.md#objects"
{{% /docs/reference %}}
[discovery.kubernetes]: ../../reference/components/discovery.kubernetes/
[prometheus.remote_write]: ../../reference/components/prometheus.remote_write/
[prometheus.scrape]: ../../reference/components/prometheus.scrape/
[Components]: ../../concepts/components/
[Objects]: ../../concepts/config-language/expressions/types_and_values/#objects
40 changes: 14 additions & 26 deletions docs/sources/tasks/configure-agent-clustering.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,22 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/configure-agent-clustering/
- /docs/grafana-cloud/send-data/agent/flow/tasks/configure-agent-clustering/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/getting-started/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/configure-agent-clustering/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/configure-agent-clustering/
- /docs/grafana-cloud/send-data/agent/flow/getting-started/configure-agent-clustering/
- ../getting-started/configure-agent-clustering/ # /docs/agent/latest/flow/getting-started/configure-agent-clustering/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/configure-agent-clustering/
description: Learn how to configure Grafana Agent clustering in an existing installation
menuTitle: Configure Grafana Agent clustering
title: Configure Grafana Agent clustering in an existing installation
- ./tasks/configure-agent-clustering/
canonical: https://grafana.com/docs/alloy/latest/tasks/configure-agent-clustering/
description: Learn how to configure Grafana Alloy clustering in an existing installation
menuTitle: Configure clustering
title: Configure Grafana Alloy clustering in an existing installation
weight: 400
---

# Configure {{% param "PRODUCT_NAME" %}} clustering in an existing installation

You can configure {{< param "PRODUCT_NAME" >}} to run with [clustering][] so that individual {{< param "PRODUCT_ROOT_NAME" >}}s can work together for workload distribution and high availability.

> **Note:** Clustering is a [beta][] feature. Beta features are subject to breaking
> changes and may be replaced with equivalent functionality that covers the same use case.
{{< admonition type="note" >}}
Clustering is a [beta][] feature. Beta features are subject to breaking changes and may be replaced with equivalent functionality that covers the same use case.

[beta]: ../../stability/#beta
{{< /admonition >}}

This topic describes how to add clustering to an existing installation.

Expand Down Expand Up @@ -62,13 +56,7 @@ To configure clustering:

1. Ensure that all expected nodes appear in the resulting table.

{{% docs/reference %}}
[clustering]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering.md"
[clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/clustering.md"
[beta]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/stability.md#beta"
[beta]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/stability.md#beta"
[install-helm]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/install/kubernetes.md"
[install-helm]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/install/kubernetes.md"
[UI]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/debug.md#component-detail-page"
[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md#component-detail-page"
{{% /docs/reference %}}
[clustering]: ../../concepts/clustering/
[beta]: ../../stability/#beta
[install-helm]: ../../get-started/install/kubernetes/
[UI]: ../debug/#component-detail-page
24 changes: 6 additions & 18 deletions docs/sources/tasks/configure/_index.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,16 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/configure/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/configure/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/configure/
- /docs/grafana-cloud/send-data/agent/flow/tasks/configure/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/setup/configure/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/configure/
- /docs/grafana-cloud/send-data/agent/flow/setup/configure/
- ../setup/configure/ # /docs/agent/latest/flow/setup/configure/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/configure/
description: Configure Grafana Agent Flow after it is installed
- ./tasks/configure/
canonical: https://grafana.com/docs/alloy/latest/tasks/configure/
description: Configure Grafana Alloy after it is installed
menuTitle: Configure
title: Configure Grafana Agent Flow
title: Configure Grafana Alloy
weight: 90
---

# Configure {{% param "PRODUCT_NAME" %}}

You can configure {{< param "PRODUCT_NAME" >}} after it is [installed][Install].
You can configure {{< param "PRODUCT_NAME" >}} after it is [installed][Install].
The default River configuration file for {{< param "PRODUCT_NAME" >}} is located at:

* Linux: `/etc/grafana-agent-flow.river`
Expand All @@ -30,7 +21,4 @@ This section includes information that helps you configure {{< param "PRODUCT_NA

{{< section >}}

{{% docs/reference %}}
[Install]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/get-started/install/"
[Install]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/install/"
{{% /docs/reference %}}
[Install]: ../../get-started/install/
30 changes: 8 additions & 22 deletions docs/sources/tasks/configure/configure-kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/tasks/configure/configure-kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/configure/configure-kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/configure/configure-kubernetes/
- /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-kubernetes/
# Previous page aliases for backwards compatibility:
- /docs/grafana-cloud/agent/flow/setup/configure/configure-kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-kubernetes/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/configure/configure-kubernetes/
- /docs/grafana-cloud/send-data/agent/flow/setup/configure/configure-kubernetes/
- ../../setup/configure/configure-kubernetes/ # /docs/agent/latest/flow/setup/configure/configure-kubernetes/
canonical: https://grafana.com/docs/agent/latest/flow/tasks/configure/configure-kubernetes/
description: Learn how to configure Grafana Agent Flow on Kubernetes
- ./tasks/configure/configure-kubernetes/
canonical: https://grafana.com/docs/alloy/latest/tasks/configure/configure-kubernetes/
description: Learn how to configure Grafana Alloy on Kubernetes
menuTitle: Kubernetes
title: Configure Grafana Agent Flow on Kubernetes
title: Configure Grafana Alloy on Kubernetes
weight: 200
---

Expand All @@ -23,8 +14,7 @@ To configure {{< param "PRODUCT_NAME" >}} on Kubernetes, perform the following s

1. Download a local copy of [values.yaml][] for the Helm chart.

1. Make changes to your copy of `values.yaml` to customize settings for the
Helm chart.
1. Make changes to your copy of `values.yaml` to customize settings for the Helm chart.

Refer to the inline documentation in the `values.yaml` for more information about each option.

Expand All @@ -38,14 +28,10 @@ To configure {{< param "PRODUCT_NAME" >}} on Kubernetes, perform the following s

1. Replace `VALUES_PATH` with the path to your copy of `values.yaml` to use.

[values.yaml]: https://raw.githubusercontent.com/grafana/agent/main/operations/helm/charts/grafana-agent/values.yaml

## Kustomize considerations

If you are using [Kustomize][] to inflate and install the [Helm chart][], be careful
when using a `configMapGenerator` to generate the ConfigMap containing the
configuration. By default, the generator appends a hash to the name and patches
the resource mentioning it, triggering a rolling update.
If you are using [Kustomize][] to inflate and install the [Helm chart][], be careful when using a `configMapGenerator` to generate the ConfigMap containing the configuration.
By default, the generator appends a hash to the name and patches the resource mentioning it, triggering a rolling update.

This behavior is undesirable for {{< param "PRODUCT_NAME" >}} because the startup time can be significant depending on the size of the Write-Ahead Log.
You can use the [Helm chart][] sidecar container to watch the ConfigMap and trigger a dynamic reload.
Expand All @@ -60,6 +46,6 @@ configMapGenerator:
options:
disableNameSuffixHash: true
```

[values.yaml]: https://raw.githubusercontent.com/grafana/agent/main/operations/helm/charts/grafana-agent/values.yaml
[Helm chart]: https://github.com/grafana/agent/tree/main/operations/helm/charts/grafana-agent
[Kustomize]: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/
Loading

0 comments on commit 2f1eccf

Please sign in to comment.