From 2f1eccfb99c3c61e3a814d51fd0c84db876ed9ac Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Wed, 28 Feb 2024 16:55:39 -0800 Subject: [PATCH] Update reference paths in tasks --- .../{deploy-agent.md => deploy-alloy.md} | 2 +- docs/sources/tasks/_index.md | 18 +-- .../tasks/collect-opentelemetry-data.md | 35 ++--- .../tasks/collect-prometheus-metrics.md | 29 +--- .../tasks/configure-agent-clustering.md | 40 ++---- docs/sources/tasks/configure/_index.md | 24 +--- .../tasks/configure/configure-kubernetes.md | 30 ++-- .../tasks/configure/configure-linux.md | 42 ++---- .../tasks/configure/configure-macos.md | 32 ++--- .../tasks/configure/configure-windows.md | 23 +--- docs/sources/tasks/debug.md | 52 +++---- .../distribute-prometheus-scrape-load.md | 39 ++---- docs/sources/tasks/estimate-resource-usage.md | 59 +++----- docs/sources/tasks/migrate/_index.md | 14 +- docs/sources/tasks/migrate/from-operator.md | 65 ++++----- docs/sources/tasks/migrate/from-prometheus.md | 59 +++----- docs/sources/tasks/migrate/from-promtail.md | 54 +++----- docs/sources/tasks/migrate/from-static.md | 129 +++++++----------- docs/sources/tasks/monitor/_index.md | 17 +-- .../tasks/monitor/component_metrics.md | 28 +--- .../tasks/monitor/controller_metrics.md | 23 +--- .../tasks/opentelemetry-to-lgtm-stack.md | 57 +++----- 22 files changed, 267 insertions(+), 604 deletions(-) rename docs/sources/get-started/{deploy-agent.md => deploy-alloy.md} (98%) diff --git a/docs/sources/get-started/deploy-agent.md b/docs/sources/get-started/deploy-alloy.md similarity index 98% rename from docs/sources/get-started/deploy-agent.md rename to docs/sources/get-started/deploy-alloy.md index 0a76e62c42..f9cc4ad79b 100644 --- a/docs/sources/get-started/deploy-agent.md +++ b/docs/sources/get-started/deploy-alloy.md @@ -17,7 +17,7 @@ title: Grafana Agent Flow deployment topologies weight: 900 --- -{{< docs/shared source="agent" lookup="/deploy-agent.md" version="" >}} +{{< docs/shared source="alloy" lookup="/deploy-agent.md" version="" >}} ## Processing different types of telemetry in different {{< param "PRODUCT_ROOT_NAME" >}} instances diff --git a/docs/sources/tasks/_index.md b/docs/sources/tasks/_index.md index 4ca62e8c13..e991be5fbd 100644 --- a/docs/sources/tasks/_index.md +++ b/docs/sources/tasks/_index.md @@ -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 --- diff --git a/docs/sources/tasks/collect-opentelemetry-data.md b/docs/sources/tasks/collect-opentelemetry-data.md index 22248f9f70..8c7e9b315c 100644 --- a/docs/sources/tasks/collect-opentelemetry-data.md +++ b/docs/sources/tasks/collect-opentelemetry-data.md @@ -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 @@ -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: @@ -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//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//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//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//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//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//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/ diff --git a/docs/sources/tasks/collect-prometheus-metrics.md b/docs/sources/tasks/collect-prometheus-metrics.md index 350ce1ccfd..ad499a03bc 100644 --- a/docs/sources/tasks/collect-prometheus-metrics.md +++ b/docs/sources/tasks/collect-prometheus-metrics.md @@ -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 @@ -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//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//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//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//flow/concepts/components.md" -[Components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md" -[Objects]: "/docs/agent/ -> /docs/agent//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 diff --git a/docs/sources/tasks/configure-agent-clustering.md b/docs/sources/tasks/configure-agent-clustering.md index d8539914fc..490ec68174 100644 --- a/docs/sources/tasks/configure-agent-clustering.md +++ b/docs/sources/tasks/configure-agent-clustering.md @@ -1,19 +1,10 @@ --- 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 --- @@ -21,8 +12,11 @@ weight: 400 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. @@ -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//flow/concepts/clustering.md" -[clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/clustering.md" -[beta]: "/docs/agent/ -> /docs/agent//stability.md#beta" -[beta]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/stability.md#beta" -[install-helm]: "/docs/agent/ -> /docs/agent//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//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 diff --git a/docs/sources/tasks/configure/_index.md b/docs/sources/tasks/configure/_index.md index c44ea3dc02..d5d8df5186 100644 --- a/docs/sources/tasks/configure/_index.md +++ b/docs/sources/tasks/configure/_index.md @@ -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` @@ -30,7 +21,4 @@ This section includes information that helps you configure {{< param "PRODUCT_NA {{< section >}} -{{% docs/reference %}} -[Install]: "/docs/agent/ -> /docs/agent//flow/get-started/install/" -[Install]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/install/" -{{% /docs/reference %}} +[Install]: ../../get-started/install/ diff --git a/docs/sources/tasks/configure/configure-kubernetes.md b/docs/sources/tasks/configure/configure-kubernetes.md index 2941f68a42..93c051897d 100644 --- a/docs/sources/tasks/configure/configure-kubernetes.md +++ b/docs/sources/tasks/configure/configure-kubernetes.md @@ -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 --- @@ -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. @@ -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. @@ -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/ diff --git a/docs/sources/tasks/configure/configure-linux.md b/docs/sources/tasks/configure/configure-linux.md index 4b0bd3344e..e7882c8ccd 100644 --- a/docs/sources/tasks/configure/configure-linux.md +++ b/docs/sources/tasks/configure/configure-linux.md @@ -1,19 +1,10 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/configure/configure-linux/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/configure/configure-linux/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/configure/configure-linux/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-linux/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/setup/configure/configure-linux/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-linux/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/configure/configure-linux/ -- /docs/grafana-cloud/send-data/agent/flow/setup/configure/configure-linux/ -- ../../setup/configure/configure-linux/ # /docs/agent/latest/flow/setup/configure/configure-linux/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/configure/configure-linux/ -description: Learn how to configure Grafana Agent Flow on Linux +- ./tasks/configure/configure-linux/ +canonical: https://grafana.com/docs/alloy/latest/tasks/configure/configure-linux/ +description: Learn how to configure Grafana Alloy on Linux menuTitle: Linux -title: Configure Grafana Agent Flow on Linux +title: Configure Grafana Alloy on Linux weight: 300 --- @@ -36,8 +27,7 @@ To change the configuration file used by the service, perform the following step * Debian or Ubuntu: edit `/etc/default/grafana-agent-flow` * RHEL/Fedora or SUSE/openSUSE: edit `/etc/sysconfig/grafana-agent-flow` -1. Change the contents of the `CONFIG_FILE` environment variable to point to - the new configuration file to use. +1. Change the contents of the `CONFIG_FILE` environment variable to point at the new configuration file to use. 1. Restart the {{< param "PRODUCT_NAME" >}} service: @@ -47,13 +37,11 @@ To change the configuration file used by the service, perform the following step ## Pass additional command-line flags -By default, the {{< param "PRODUCT_NAME" >}} service launches with the [run][] -command, passing the following flags: +By default, the {{< param "PRODUCT_NAME" >}} service launches with the [run][] command, passing the following flags: * `--storage.path=/var/lib/grafana-agent-flow` -To pass additional command-line flags to the {{< param "PRODUCT_NAME" >}} binary, perform -the following steps: +To pass additional command-line flags to the {{< param "PRODUCT_NAME" >}} binary, perform the following steps: 1. Edit the environment file for the service: @@ -69,14 +57,12 @@ the following steps: sudo systemctl restart grafana-agent-flow ``` -To see the list of valid command-line flags that can be passed to the service, -refer to the documentation for the [run][] command. +To see the list of valid command-line flags that can be passed to the service, refer to the documentation for the [run][] command. ## Expose the UI to other machines -By default, {{< param "PRODUCT_NAME" >}} listens on the local network for its HTTP -server. This prevents other machines on the network from being able to access -the [UI for debugging][UI]. +By default, {{< param "PRODUCT_NAME" >}} listens on the local network for its HTTP server. +This prevents other machines on the network from being able to access the [UI for debugging][UI]. To expose the UI to other machines, complete the following steps: @@ -96,9 +82,5 @@ To expose the UI to other machines, complete the following steps: To listen on all interfaces, replace `LISTEN_ADDR` with `0.0.0.0`. -{{% docs/reference %}} -[run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" -[run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" -[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md#grafana-agent-flow-ui" -{{% /docs/reference %}} +[run]:../../../reference/cli/run/ +[UI]: ../../debug/#grafana-alloy-ui diff --git a/docs/sources/tasks/configure/configure-macos.md b/docs/sources/tasks/configure/configure-macos.md index 8b860a010d..af45146562 100644 --- a/docs/sources/tasks/configure/configure-macos.md +++ b/docs/sources/tasks/configure/configure-macos.md @@ -1,19 +1,10 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/configure/configure-macos/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/configure/configure-macos/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/configure/configure-macos/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-macos/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/setup/configure/configure-macos/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-macos/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/configure/configure-macos/ -- /docs/grafana-cloud/send-data/agent/flow/setup/configure/configure-macos/ -- ../../setup/configure/configure-macos/ # /docs/agent/latest/flow/setup/configure/configure-macos/ +- ./tasks/configure/configure-macos/ canonical: https://grafana.com/docs/agent/latest/flow/tasks/configure/configure-macos/ -description: Learn how to configure Grafana Agent Flow on macOS +description: Learn how to configure Grafana Alloy on macOS menuTitle: macOS -title: Configure Grafana Agent Flow on macOS +title: Configure Grafana Alloy on macOS weight: 400 --- @@ -32,13 +23,10 @@ To configure {{< param "PRODUCT_NAME" >}} on macOS, perform the following steps: ## Configure the {{% param "PRODUCT_NAME" %}} service {{< admonition type="note" >}} -Due to limitations in Homebrew, customizing the service used by -{{< param "PRODUCT_NAME" >}} on macOS requires changing the Homebrew formula and -reinstalling {{< param "PRODUCT_NAME" >}}. +Due to limitations in Homebrew, customizing the service used by {{< param "PRODUCT_NAME" >}} on macOS requires changing the Homebrew formula and reinstalling {{< param "PRODUCT_NAME" >}}. {{< /admonition >}} -To customize the {{< param "PRODUCT_NAME" >}} service on macOS, perform the following -steps: +To customize the {{< param "PRODUCT_NAME" >}} service on macOS, perform the following steps: 1. Run the following command in a terminal: @@ -70,9 +58,8 @@ steps: ## Expose the UI to other machines -By default, {{< param "PRODUCT_NAME" >}} listens on the local network for its HTTP -server. This prevents other machines on the network from being able to access -the [UI for debugging][UI]. +By default, {{< param "PRODUCT_NAME" >}} listens on the local network for its HTTP server. +This prevents other machines on the network from being able to access the [UI for debugging][UI]. To expose the UI to other machines, complete the following steps: @@ -87,7 +74,4 @@ To expose the UI to other machines, complete the following steps: To listen on all interfaces, replace `127.0.0.1` with `0.0.0.0`. -{{% docs/reference %}} -[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md#grafana-agent-flow-ui" -{{% /docs/reference %}} +[UI]: ../../debug/#grafana-alloy-ui diff --git a/docs/sources/tasks/configure/configure-windows.md b/docs/sources/tasks/configure/configure-windows.md index 806579ea13..b5d723804e 100644 --- a/docs/sources/tasks/configure/configure-windows.md +++ b/docs/sources/tasks/configure/configure-windows.md @@ -1,19 +1,10 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/configure/configure-windows/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/configure/configure-windows/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/configure/configure-windows/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-windows/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/setup/configure/configure-windows/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/setup/configure/configure-windows/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/setup/configure/configure-windows/ -- /docs/grafana-cloud/send-data/agent/flow/setup/configure/configure-windows/ -- ../../setup/configure/configure-windows/ # /docs/agent/latest/flow/setup/configure/configure-windows/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/configure/configure-windows/ -description: Learn how to configure Grafana Agent Flow on Windows +- ./tasks/configure/configure-windows/ +canonical: https://grafana.com/docs/alloy/latest/tasks/configure/configure-windows/ +description: Learn how to configure Grafana Alloy on Windows menuTitle: Windows -title: Configure Grafana Agent Flow on Windows +title: Configure Grafana Alloy on Windows weight: 500 --- @@ -95,8 +86,4 @@ To expose the UI to other machines, complete the following steps: To listen on all interfaces, replace `LISTEN_ADDR` with `0.0.0.0`. -{{% docs/reference %}} -[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md#grafana-agent-flow-ui" -{{% /docs/reference %}} - +[UI]: ../../debug/#grafana-alloy-ui diff --git a/docs/sources/tasks/debug.md b/docs/sources/tasks/debug.md index 331307a58d..0138d9f597 100644 --- a/docs/sources/tasks/debug.md +++ b/docs/sources/tasks/debug.md @@ -1,18 +1,9 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/debug/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/debug/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/debug/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/debug/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/monitoring/debugging/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/debugging/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/monitoring/debugging/ -- /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging/ -- ../monitoring/debugging/ # /docs/agent/latest/flow/monitoring/debugging/ -canonical: https://grafana.com/docs/agent/latest/flow/monitoring/debugging/ -description: Learn about debugging issues with Grafana Agent Flow -title: Debug issues with Grafana Agent Flow +- ./tasks/debug/ +canonical: https://grafana.com/docs/alloy/latest/tasks/debug/ +description: Learn about debugging issues with Grafana alloy +title: Debug issues with Grafana Alloy menuTitle: Debug issues weight: 1000 --- @@ -28,14 +19,17 @@ Follow these steps to debug issues with {{< param "PRODUCT_NAME" >}}: {{< param "PRODUCT_NAME" >}} includes an embedded UI viewable from the {{< param "PRODUCT_ROOT_NAME" >}} HTTP server, which defaults to listening at `http://localhost:12345`. -> **NOTE**: For security reasons, installations of {{< param "PRODUCT_NAME" >}} on non-containerized platforms default to listening on `localhost`. -> This default prevents other machines on the network from being able to view the UI. -> -> To expose the UI to other machines on the network on non-containerized platforms, refer to the documentation for how you [installed][install] {{< param "PRODUCT_NAME" >}}. -> -> If you are running a custom installation of {{< param "PRODUCT_NAME" >}}, -> refer to the documentation for [the `grafana-agent run` command][grafana-agent run] to learn how to change the HTTP listen address, -> and pass the appropriate flag when running {{< param "PRODUCT_NAME" >}}. +{{< admonition type="note" >}} +For security reasons, installations of {{< param "PRODUCT_NAME" >}} on non-containerized platforms default to listening on `localhost`. +This default prevents other machines on the network from being able to view the UI. + +To expose the UI to other machines on the network on non-containerized platforms, refer to the documentation for how you [installed][install] {{< param "PRODUCT_NAME" >}}. + +If you are running a custom installation of {{< param "PRODUCT_NAME" >}}, refer to the documentation for the [`grafana-agent run` command][grafana-agent run] to learn how to change the HTTP listen address, > and pass the appropriate flag when running {{< param "PRODUCT_NAME" >}}. + +[install]: ../../get-started/install/ +[grafana-agent run]: ../../reference/cli/run/ +{{< /admonition >}} ### Home page @@ -113,16 +107,6 @@ To debug issues when using [clustering][], check for the following symptoms. - **Node stuck in terminating state**: The node attempted to gracefully shut down and set its state to Terminating, but it has not completely gone away. Check the clustering page to view the state of the peers and verify that the terminating {{< param "PRODUCT_ROOT_NAME" >}} has been shut down. -{{% docs/reference %}} -[logging]: "/docs/agent/ -> /docs/agent//flow/reference/config-blocks/logging.md" -[logging]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/config-blocks/logging.md" -[clustering]: "/docs/agent/ -> /docs/agent//flow/concepts/clustering.md" -[clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/clustering.md" -[install]: "/docs/agent/ -> /docs/agent//flow/get-started/install" -[install]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/install" -[secret]: "/docs/agent/ -> /docs/agent//flow/concepts/config-language/expressions/types_and_values.md#secrets.md" -[secret]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/config-language/expressions/types_and_values.md#secrets.md" -[grafana-agent run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" -[grafana-agent run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" -{{% /docs/reference %}} - +[logging]: ../../reference/config-blocks/logging/ +[clustering]: ../../concepts/clustering/ +[secret]: ../../concepts/config-language/expressions/types_and_values/#secrets diff --git a/docs/sources/tasks/distribute-prometheus-scrape-load.md b/docs/sources/tasks/distribute-prometheus-scrape-load.md index ee3a3fd982..f243bd6328 100644 --- a/docs/sources/tasks/distribute-prometheus-scrape-load.md +++ b/docs/sources/tasks/distribute-prometheus-scrape-load.md @@ -1,15 +1,6 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/distribute-prometheus-scrape-load/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/distribute-prometheus-scrape-load/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/distribute-prometheus-scrape-load/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/distribute-prometheus-scrape-load/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/getting-started/distribute-prometheus-scrape-load/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/distribute-prometheus-scrape-load/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/distribute-prometheus-scrape-load/ -- /docs/grafana-cloud/send-data/agent/flow/getting-started/distribute-prometheus-scrape-load/ -- ../getting-started/distribute-prometheus-scrape-load/ # /docs/agent/latest/flow/getting-started/distribute-prometheus-scrape-load/ +- ./tasks/distribute-prometheus-scrape-load/ canonical: https://grafana.com/docs/agent/latest/flow/tasks/distribute-prometheus-scrape-load/ description: Learn how to distribute your Prometheus metrics scrape load menuTitle: Distribute Prometheus metrics scrape load @@ -22,12 +13,15 @@ weight: 500 A good predictor for the size of an {{< param "PRODUCT_NAME" >}} deployment is the number of Prometheus targets each {{< param "PRODUCT_ROOT_NAME" >}} scrapes. [Clustering][] with target auto-distribution allows a fleet of {{< param "PRODUCT_ROOT_NAME" >}}s to work together to dynamically distribute their scrape load, providing 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 >}} ## Before you begin -- Familiarize yourself with how to [configure existing {{< param "PRODUCT_NAME" >}} installations][configure-grafana-agent]. +- Familiarize yourself with how to [configure][] existing {{< param "PRODUCT_NAME" >}} installations. - [Configure Prometheus metrics collection][]. - [Configure clustering][]. - Ensure that all of your clustered {{< param "PRODUCT_ROOT_NAME" >}}s have the same configuration file. @@ -52,17 +46,8 @@ To distribute Prometheus metrics scrape load with clustering: 1. Compare the Debug Info sections between two different {{< param "PRODUCT_ROOT_NAME" >}} to ensure that they're not scraping the same sets of targets. -{{% docs/reference %}} -[Clustering]: "/docs/agent/ -> /docs/agent//flow/concepts/clustering.md" -[Clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/clustering.md" -[beta]: "/docs/agent/ -> /docs/agent//stability.md#beta" -[beta]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/stability.md#beta" -[configure-grafana-agent]: "/docs/agent/ -> /docs/agent//flow/tasks/configure" -[configure-grafana-agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure" -[Configure Prometheus metrics collection]: "/docs/agent/ -> /docs/agent//flow/tasks/collect-prometheus-metrics.md" -[Configure Prometheus metrics collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/collect-prometheus-metrics.md" -[Configure clustering]: "/docs/agent/ -> /docs/agent//flow/tasks/configure-agent-clustering.md" -[Configure clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure-agent-clustering.md" -[UI]: "/docs/agent/ -> /docs/agent//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/ +[configure]: ../configure/ +[Configure Prometheus metrics collection]: ../collect-prometheus-metrics/ +[Configure clustering]: ../configure-agent-clustering/ +[UI]: ../debug/#component-detail-page diff --git a/docs/sources/tasks/estimate-resource-usage.md b/docs/sources/tasks/estimate-resource-usage.md index f3ed1b7aed..3ca252603a 100644 --- a/docs/sources/tasks/estimate-resource-usage.md +++ b/docs/sources/tasks/estimate-resource-usage.md @@ -1,19 +1,8 @@ --- aliases: - - /docs/agent/flow/tasks/estimate-resource-usage/ - - /docs/grafana-cloud/agent/flow/tasks/estimate-resource-usage/ - - /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/estimate-resource-usage/ - - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/estimate-resource-usage/ - - /docs/grafana-cloud/send-data/agent/flow/tasks/estimate-resource-usage/ - # Previous page aliases for backwards compatibility: - - /docs/agent/flow/monitoring/resource-usage/ - - /docs/grafana-cloud/agent/flow/monitoring/resource-usage/ - - /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/resource-usage/ - - /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/monitoring/resource-usage/ - - /docs/grafana-cloud/send-data/agent/flow/monitoring/resource-usage/ - - ../monitoring/resource-usage/ # /docs/agent/latest/flow/monitoring/resource-usage/ -canonical: https://grafana.com/docs/agent/latest/flow/monitoring/resource-usage/ -description: Estimate expected Grafana Agent resource usage +- ./tasks/resource-usage/ +canonical: https://grafana.com/docs/alloy/latest/tasks/resource-usage/ +description: Estimate expected Grafana Alloy resource usage headless: true title: Estimate resource usage menuTitle: Estimate resource usage @@ -22,62 +11,50 @@ weight: 190 # Estimate {{% param "PRODUCT_NAME" %}} resource usage -This page provides guidance for expected resource usage of -{{< param "PRODUCT_NAME" >}} for each telemetry type, based on operational -experience of some of the {{< param "PRODUCT_NAME" >}} maintainers. +This page provides guidance for expected resource usage of {{< param "PRODUCT_NAME" >}} for each telemetry type, based on operational experience of some of the {{< param "PRODUCT_NAME" >}} maintainers. {{< admonition type="note" >}} The resource usage depends on the workload, hardware, and the configuration used. -The information on this page is a good starting point for most users, but your -actual usage may be different. +The information on this page is a good starting point for most users, but your actual usage may be different. {{< /admonition >}} ## Prometheus metrics -The Prometheus metrics resource usage depends mainly on the number of active -series that need to be scraped and the scrape interval. +The Prometheus metrics resource usage depends mainly on the number of active series that need to be scraped and the scrape interval. -As a rule of thumb, **per each 1 million active series** and with the default -scrape interval, you can expect to use approximately: +As a rule of thumb, **per each 1 million active series** and with the default scrape interval, you can expect to use approximately: * 0.4 CPU cores * 11 GiB of memory * 1.5 MiB/s of total network bandwidth, send and receive -These recommendations are based on deployments that use [clustering][], but they -will broadly apply to other deployment modes. For more information on how to -deploy {{< param "PRODUCT_NAME" >}}, see [deploying grafana agent][]. - -[deploying grafana agent]: {{< relref "../get-started/deploy-agent.md" >}} -[clustering]: {{< relref "../concepts/clustering.md" >}} +These recommendations are based on deployments that use [clustering][], but they will broadly apply to other deployment modes. +Refer to [Deploy {{< param "PRODUCT_NAME" >}}][deploy] for more information on how to deploy {{< param "PRODUCT_NAME" >}}. ## Loki logs Loki logs resource usage depends mainly on the volume of logs ingested. -As a rule of thumb, **per each 1 MiB/second of logs ingested**, you can expect -to use approximately: +As a rule of thumb, **per each 1 MiB/second of logs ingested**, you can expect to use approximately: * 1 CPU core * 120 MiB of memory -These recommendations are based on Kubernetes DaemonSet deployments on clusters -with relatively small number of nodes and high logs volume on each. The resource -usage can be higher per each 1 MiB/second of logs if you have a large number of -small nodes due to the constant overhead of running the {{< param "PRODUCT_NAME" >}} on each node. +These recommendations are based on Kubernetes DaemonSet deployments on clusters with relatively small number of nodes and high logs volume on each. +The resource usage can be higher per each 1 MiB/second of logs if you have a large number of small nodes due to the constant overhead of running the {{< param "PRODUCT_NAME" >}} on each node. -Additionally, factors such as number of labels, number of files and average log -line length may all play a role in the resource usage. +Additionally, factors such as number of labels, number of files and average log line length may all play a role in the resource usage. ## Pyroscope profiles Pyroscope profiles resource usage depends mainly on the volume of profiles. -As a rule of thumb, **per each 100 profiles/second**, you can expect to use -approximately: +As a rule of thumb, **per each 100 profiles/second**, you can expect to use approximately: * 1 CPU core * 10 GiB of memory -Factors such as size of each profile and frequency of fetching them also play a -role in the overall resource usage. +Factors such as size of each profile and frequency of fetching them also play a role in the overall resource usage. + +[deploy]: ../../get-started/deploy-alloy/ +[clustering]: ../../concepts/clustering/ diff --git a/docs/sources/tasks/migrate/_index.md b/docs/sources/tasks/migrate/_index.md index a0c98966dc..e6dc140cf4 100644 --- a/docs/sources/tasks/migrate/_index.md +++ b/docs/sources/tasks/migrate/_index.md @@ -1,19 +1,15 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/migrate/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrate/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrate/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/migrate/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrate/ -description: How to migrate to Grafana Agent Flow +- ./tasks/migrate/ +canonical: https://grafana.com/docs/alloy/latest/tasks/migrate/ +description: How to migrate to Grafana Alloy menuTitle: Migrate -title: Migrate to Grafana Agent Flow +title: Migrate to Grafana Alloy weight: 100 --- # How to migrate to {{% param "PRODUCT_NAME" %}} -This section details how to migrate to {{< param "PRODUCT_NAME" >}} from other -common solutions. +This section details how to migrate to {{< param "PRODUCT_NAME" >}} from other common solutions. {{< section >}} diff --git a/docs/sources/tasks/migrate/from-operator.md b/docs/sources/tasks/migrate/from-operator.md index f035f95484..7fbe509129 100644 --- a/docs/sources/tasks/migrate/from-operator.md +++ b/docs/sources/tasks/migrate/from-operator.md @@ -1,15 +1,10 @@ --- aliases: -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrate/from-operator/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/migrate/from-operator/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-operator/ -- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-operator/ -- ../../getting-started/migrating-from-operator/ # /docs/agent/latest/flow/getting-started/migrating-from-operator/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrate/from-operator/ -description: Migrate from Grafana Agent Operator to Grafana Agent Flow +- ./tasks/migrate/from-operator/ +canonical: https://grafana.com/docs/alloy/latest/tasks/migrate/from-operator/ +description: Migrate from Grafana Agent Operator to Grafana Alloy menuTitle: Migrate from Operator -title: Migrate from Grafana Agent Operator to Grafana Agent Flow +title: Migrate from Grafana Agent Operator to Grafana Alloy weight: 320 --- @@ -275,38 +270,24 @@ The logging subsystem is very powerful and has many options for processing logs. ## Integrations The `Integration` CRD isn't supported with {{< param "PRODUCT_NAME" >}}. -However, all static mode integrations have an equivalent component in the [`prometheus.exporter`][] namespace. +However, all static mode integrations have an equivalent component in the [`prometheus.exporter`][prometheus.exporter] namespace. The [reference documentation][component documentation] should help convert those integrations to their {{< param "PRODUCT_NAME" >}} equivalent. -[default values]: https://github.com/grafana/agent/blob/main/operations/helm/charts/grafana-agent/values.yaml - -{{% docs/reference %}} -[clustering]: "/docs/agent/ -> /docs/agent//flow/concepts/clustering" -[clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/clustering" -[deployment guide]: "/docs/agent/ -> /docs/agent//flow/get-started/deploy-agent" -[deployment guide]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/get-started/deploy-agent" -[operator guide]: "/docs/agent/ -> /docs/agent//operator/deploy-agent-operator-resources.md#deploy-a-metricsinstance-resource" -[operator guide]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/operator/deploy-agent-operator-resources.md#deploy-a-metricsinstance-resource" -[Helm chart]: "/docs/agent/ -> /docs/agent//flow/get-started/install/kubernetes" -[Helm chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/get-started/install/kubernetes" -[remote.kubernetes.secret]: "/docs/agent/ -> /docs/agent//flow/reference/components/remote.kubernetes.secret.md" -[remote.kubernetes.secret]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/remote.kubernetes.secret.md" -[prometheus.remote_write]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.remote_write.md" -[prometheus.remote_write]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/prometheus.remote_write.md" -[prometheus.operator.podmonitors]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.operator.podmonitors.md" -[prometheus.operator.podmonitors]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/prometheus.operator.podmonitors.md" -[prometheus.operator.servicemonitors]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.operator.servicemonitors.md" -[prometheus.operator.servicemonitors]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/prometheus.operator.servicemonitors.md" -[prometheus.operator.probes]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.operator.probes.md" -[prometheus.operator.probes]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/prometheus.operator.probes.md" -[prometheus.scrape]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.scrape.md" -[prometheus.scrape]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/prometheus.scrape" -[loki.source.kubernetes]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.source.kubernetes.md" -[loki.source.kubernetes]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/loki.source.kubernetes.md" -[loki.source.podlogs]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.source.podlogs.md" -[loki.source.podlogs]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components/loki.source.podlogs.md" -[component documentation]: "/docs/agent/ -> /docs/agent//flow/reference/components" -[component documentation]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components" -[`prometheus.exporter`]: "/docs/agent/ -> /docs/agent//flow/reference/components" -[`prometheus.exporter`]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/flow/reference/components" -{{% /docs/reference %}} + +[default values]: https://github.com/grafana/alloy/blob/main/operations/helm/charts/grafana-agent/values.yaml +[clustering]: ../../../concepts/clustering/ +[deployment guide]: ../../../get-started/deploy-alloy + +[operator guide]: https://grafana.com/docs/agent/latest/operator/deploy-agent-operator-resources/#deploy-a-metricsinstance-resource + +[Helm chart]: ../../../get-started/install/kubernetes/ +[remote.kubernetes.secret]: ../../../reference/components/remote.kubernetes.secret/ +[prometheus.remote_write]: ../../../reference/components/prometheus.remote_write/ +[prometheus.operator.podmonitors]: ../../../reference/components/prometheus.operator.podmonitors/ +[prometheus.operator.servicemonitors]: ../../../reference/components/prometheus.operator.servicemonitors/ +[prometheus.operator.probes]: ../../../reference/components/prometheus.operator.probes/ +[prometheus.scrape]: ../../../reference/components/prometheus.scrape/ +[loki.source.kubernetes]: ../../../reference/components/loki.source.kubernetes/ +[loki.source.podlogs]: ../../../reference/components/loki.source.podlogs/ +[component documentation]: ../../../reference/components/ +[prometheus.exporter]: ../../../reference/components/ diff --git a/docs/sources/tasks/migrate/from-prometheus.md b/docs/sources/tasks/migrate/from-prometheus.md index 84241791ec..f24db05b3c 100644 --- a/docs/sources/tasks/migrate/from-prometheus.md +++ b/docs/sources/tasks/migrate/from-prometheus.md @@ -1,19 +1,10 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/migrate/from-prometheus/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrate/from-prometheus/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrate/from-prometheus/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/migrate/from-prometheus/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/getting-started/migrating-from-prometheus/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-prometheus/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-prometheus/ -- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-prometheus/ -- ../../getting-started/migrating-from-prometheus/ # /docs/agent/latest/flow/getting-started/migrating-from-prometheus/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrate/from-prometheus/ -description: Learn how to migrate from Prometheus to Grafana Agent Flow +- ./tasks/migrate/from-prometheus/ +canonical: https://grafana.com/docs/alloy/latest/tasks/migrate/from-prometheus/ +description: Learn how to migrate from Prometheus to Grafana Alloy menuTitle: Migrate from Prometheus -title: Migrate from Prometheus to Grafana Agent Flow +title: Migrate from Prometheus to Grafana Alloy weight: 320 --- @@ -71,10 +62,10 @@ This conversion will enable you to take full advantage of the many additional fe 1. If the `convert` command can't convert a Prometheus configuration, diagnostic information is sent to `stderr`.\ You can bypass any non-critical issues and output the {{< param "PRODUCT_NAME" >}} configuration using a best-effort conversion by including the `--bypass-errors` flag. - {{< admonition type="caution" >}} - If you bypass the errors, the behavior of the converted configuration may not match the original Prometheus configuration. - Make sure you fully test the converted configuration before using it in a production environment. - {{< /admonition >}} + {{< admonition type="caution" >}} + If you bypass the errors, the behavior of the converted configuration may not match the original Prometheus configuration. + Make sure you fully test the converted configuration before using it in a production environment. + {{< /admonition >}} {{< code >}} @@ -131,14 +122,14 @@ This allows you to try {{< param "PRODUCT_NAME" >}} without modifying your exist > In this task, you will use the [run][] CLI command to run {{< param "PRODUCT_NAME" >}} > using a Prometheus configuration. -[Run][] {{< param "PRODUCT_NAME" >}} and include the command line flag `--config.format=prometheus`. +[Run][run alloy] {{< param "PRODUCT_NAME" >}} and include the command line flag `--config.format=prometheus`. Your configuration file must be a valid Prometheus configuration file rather than a {{< param "PRODUCT_NAME" >}} configuration file. ### Debugging 1. You can follow the convert CLI command [debugging][] instructions to generate a diagnostic report. -1. Refer to the {{< param "PRODUCT_NAME" >}} [Debugging][DebuggingUI] for more information about a running {{< param "PRODUCT_NAME" >}}. +1. Refer to [Debug {{< param "PRODUCT_NAME" >}}][DebuggingUI] for more information about a running {{< param "PRODUCT_NAME" >}}. 1. If your Prometheus configuration can't be converted and loaded directly into {{< param "PRODUCT_NAME" >}}, diagnostic information is sent to `stderr`. You can bypass any non-critical issues and start the Agent by including the `--config.bypass-conversion-errors` flag in addition to `--config.format=prometheus`. @@ -244,24 +235,12 @@ The following list is specific to the convert command and not {{< param "PRODUCT [Prometheus]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/ [debugging]: #debugging [example]: #example - -{{% docs/reference %}} -[prometheus.scrape]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.scrape.md" -[prometheus.scrape]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/prometheus.scrape.md" -[prometheus.remote_write]: "/docs/agent/ -> /docs/agent//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" -[Components]: "/docs/agent/ -> /docs/agent//flow/concepts/components.md" -[Components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md" -[convert]: "/docs/agent/ -> /docs/agent//flow/reference/cli/convert.md" -[convert]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/convert.md" -[run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" -[run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" -[Run]: "/docs/agent/ -> /docs/agent//flow/get-started/run/" -[Run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/run/" -[DebuggingUI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md" -[DebuggingUI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md" -[River]: "/docs/agent/ -> /docs/agent//flow/concepts/config-language/_index.md" -[River]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/config-language/_index.md" -[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug#grafana-agent-flow-ui" -{{% /docs/reference %}} +[prometheus.scrape]: ../../../reference/components/prometheus.scrape/ +[prometheus.remote_write]: ../../../reference/components/prometheus.remote_write/ +[Components]: ../../../concepts/components/ +[convert]: ../../../reference/cli/convert/ +[run]: ../../../reference/cli/run/ +[run alloy]: ../../../get-started/run/ +[DebuggingUI]: ../../tasks/debug/ +[River]: ../../../concepts/config-language/ +[UI]: ../../debug/#grafana-alloy-ui diff --git a/docs/sources/tasks/migrate/from-promtail.md b/docs/sources/tasks/migrate/from-promtail.md index 7a0dda9b92..041ef53533 100644 --- a/docs/sources/tasks/migrate/from-promtail.md +++ b/docs/sources/tasks/migrate/from-promtail.md @@ -1,19 +1,10 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/migrate/from-promtail/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrate/from-promtail/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrate/from-promtail/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/migrate/from-promtail/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/getting-started/migrating-from-promtail/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-promtail/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-promtail/ -- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-promtail/ -- ../../getting-started/migrating-from-promtail/ # /docs/agent/latest/flow/getting-started/migrating-from-promtail/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrate/from-promtail/ -description: Learn how to migrate from Promtail to Grafana Agent Flow +- ./tasks/migrate/from-promtail/ +canonical: https://grafana.com/docs/alloy/latest/tasks/migrate/from-promtail/ +description: Learn how to migrate from Promtail to Grafana Alloy menuTitle: Migrate from Promtail -title: Migrate from Promtail to Grafana Agent Flow +title: Migrate from Promtail to Grafana Alloy weight: 330 --- @@ -64,7 +55,7 @@ This conversion will enable you to take full advantage of the many additional fe * _``_: The full path to the Promtail configuration. * _``_: The full path to output the {{< param "PRODUCT_NAME" >}} configuration. -1. [Run][] {{< param "PRODUCT_NAME" >}} using the new configuration from _``_: +1. [Run][run alloy] {{< param "PRODUCT_NAME" >}} using the new configuration from _``_: ### Debugging @@ -127,7 +118,7 @@ This allows you to try {{< param "PRODUCT_NAME" >}} without modifying your exist > In this task, you will use the [run][] CLI command to run {{< param "PRODUCT_NAME" >}} using a Promtail configuration. -[Run][] {{< param "PRODUCT_NAME" >}} and include the command line flag `--config.format=promtail`. +[Run][run alloy] {{< param "PRODUCT_NAME" >}} and include the command line flag `--config.format=promtail`. Your configuration file must be a valid Promtail configuration file rather than a {{< param "PRODUCT_NAME" >}} configuration file. ### Debugging @@ -225,26 +216,13 @@ The following list is specific to the convert command and not {{< param "PRODUCT [Promtail]: https://www.grafana.com/docs/loki//clients/promtail/ [debugging]: #debugging [expanded in the configuration file]: https://www.grafana.com/docs/loki//clients/promtail/configuration/#use-environment-variables-in-the-configuration - -{{% docs/reference %}} -[local.file_match]: "/docs/agent/ -> /docs/agent//flow/reference/components/local.file_match.md" -[local.file_match]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/local.file_match.md" -[loki.source.file]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.source.file.md" -[loki.source.file]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.source.file.md" -[loki.write]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.write.md" -[loki.write]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.write.md" -[Components]: "/docs/agent/ -> /docs/agent//flow/concepts/components.md" -[Components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md" -[convert]: "/docs/agent/ -> /docs/agent//flow/reference/cli/convert.md" -[convert]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/convert.md" -[run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" -[run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" -[Run]: "/docs/agent/ -> /docs/agent//flow/get-started/run/" -[Run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/run/" -[DebuggingUI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md" -[DebuggingUI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md" -[River]: "/docs/agent/ -> /docs/agent//flow/concepts/config-language/_index.md" -[River]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/config-language/_index.md" -[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug#grafana-agent-flow-ui" -{{% /docs/reference %}} +[local.file_match]: ../../../reference/components/local.file_match/ +[loki.source.file]: ../../../reference/components/loki.source.file/ +[loki.write]: ../../../reference/components/loki.write/ +[Components]: ../../../concepts/components/ +[convert]: ../../../reference/cli/convert/ +[run]: ../../../reference/cli/run/ +[run alloy]: ../../../get-started/run/ +[DebuggingUI]: ../../../tasks/debug/ +[River]: ../../../concepts/config-language/ +[UI]: ../../tasks/debug/#grafana-alloy-ui diff --git a/docs/sources/tasks/migrate/from-static.md b/docs/sources/tasks/migrate/from-static.md index 5d1b73626f..8b1fc30129 100644 --- a/docs/sources/tasks/migrate/from-static.md +++ b/docs/sources/tasks/migrate/from-static.md @@ -1,25 +1,16 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/migrate/from-static/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrate/from-static/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrate/from-static/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/migrate/from-static/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/getting-started/migrating-from-static/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-static/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-static/ -- /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-static/ -- ../../getting-started/migrating-from-static/ # /docs/agent/latest/flow/getting-started/migrating-from-static/ +- ./tasks/migrate/from-static/ canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrate/from-static/ -description: Learn how to migrate your configuration from Grafana Agent Static to Grafana Agent Flow -menuTitle: Migrate from Static to Flow -title: Migrate Grafana Agent Static to Grafana Agent Flow +description: Learn how to migrate your configuration from Grafana Agent Static to Grafana Alloy +menuTitle: Migrate from Grafana Agent Static +title: Migrate Grafana Agent Static to Grafana Alloy weight: 340 --- -# Migrate from {{% param "PRODUCT_ROOT_NAME" %}} Static to {{% param "PRODUCT_NAME" %}} +# Migrate from Grafana Agent Static to {{% param "PRODUCT_NAME" %}} -The built-in {{< param "PRODUCT_ROOT_NAME" >}} convert command can migrate your [Static][] configuration to a {{< param "PRODUCT_NAME" >}} configuration. +The built-in {{< param "PRODUCT_ROOT_NAME" >}} convert command can migrate your [Grafana Agent Static][Static] configuration to a {{< param "PRODUCT_NAME" >}} configuration. This topic describes how to: @@ -42,7 +33,7 @@ This topic describes how to: ## Convert a Grafana Agent Static configuration -To fully migrate Grafana Agent [Static][] to {{< param "PRODUCT_NAME" >}}, you must convert your Static configuration into a {{< param "PRODUCT_NAME" >}} configuration. +To fully migrate Grafana Agent Static to {{< param "PRODUCT_NAME" >}}, you must convert your Grafana Agent Static configuration into a {{< param "PRODUCT_NAME" >}} configuration. This conversion will enable you to take full advantage of the many additional features available in {{< param "PRODUCT_NAME" >}}. > In this task, you will use the [convert][] CLI command to output a {{< param "PRODUCT_NAME" >}} @@ -64,14 +55,14 @@ This conversion will enable you to take full advantage of the many additional fe Replace the following: - * _``_: The full path to the [Static][] configuration. + * _``_: The full path to the Grafana Agent Static configuration. * _`_`: The full path to output the {{< param "PRODUCT_NAME" >}} configuration. -1. [Run][] {{< param "PRODUCT_NAME" >}} using the new {{< param "PRODUCT_NAME" >}} configuration from _``_: +1. [Run][run alloy] {{< param "PRODUCT_NAME" >}} using the new {{< param "PRODUCT_NAME" >}} configuration from _``_: ### Debugging -1. If the convert command can't convert a [Static][] configuration, diagnostic information is sent to `stderr`. +1. If the convert command can't convert a Grafana Agent Static configuration, diagnostic information is sent to `stderr`. You can use the `--bypass-errors` flag to bypass any non-critical issues and output the {{< param "PRODUCT_NAME" >}} configuration using a best-effort conversion. {{< admonition type="caution" >}} @@ -93,7 +84,7 @@ This conversion will enable you to take full advantage of the many additional fe Replace the following: - * _``_: The full path to the [Static][] configuration. + * _``_: The full path to the Grafana Agent Static configuration. * _``_: The full path to output the {{< param "PRODUCT_NAME" >}} configuration. 1. You can use the `--report` flag to output a diagnostic report. @@ -112,7 +103,7 @@ This conversion will enable you to take full advantage of the many additional fe Replace the following: - * _``_: The full path to the [Static][] configuration. + * _``_: The full path to the Grafana Agent Static configuration. * _``_: The full path to output the {{< param "PRODUCT_NAME" >}} configuration. * _``_: The output path for the report. @@ -122,16 +113,16 @@ This conversion will enable you to take full advantage of the many additional fe (Warning) Please review your agent command line flags and ensure they are set in your {{< param "PRODUCT_NAME" >}} configuration file where necessary. ``` -## Run a Static mode configuration +## Run a Grafana Agent Static mode configuration If you’re not ready to completely switch to a {{< param "PRODUCT_NAME" >}} configuration, you can run {{< param "PRODUCT_ROOT_NAME" >}} using your existing Grafana Agent Static configuration. -The `--config.format=static` flag tells {{< param "PRODUCT_ROOT_NAME" >}} to convert your [Static] configuration to {{< param "PRODUCT_NAME" >}} and load it directly without saving the new configuration. +The `--config.format=static` flag tells {{< param "PRODUCT_ROOT_NAME" >}} to convert your Grafana Agent Static configuration to {{< param "PRODUCT_NAME" >}} and load it directly without saving the new configuration. This allows you to try {{< param "PRODUCT_NAME" >}} without modifying your existing Grafana Agent Static configuration infrastructure. > In this task, you will use the [run][] CLI command to run {{< param "PRODUCT_NAME" >}} using a Static configuration. [Run][] {{< param "PRODUCT_NAME" >}} and include the command line flag `--config.format=static`. -Your configuration file must be a valid [Static] configuration file. +Your configuration file must be a valid Grafana Agent Static configuration file. ### Debugging @@ -139,7 +130,7 @@ Your configuration file must be a valid [Static] configuration file. 1. Refer to the {{< param "PRODUCT_NAME" >}} [debugging UI][DebuggingUI] for more information about running {{< param "PRODUCT_NAME" >}}. -1. If your [Static] configuration can't be converted and loaded directly into {{< param "PRODUCT_NAME" >}}, diagnostic information is sent to `stderr`. +1. If your Grafana Agent Static configuration can't be converted and loaded directly into {{< param "PRODUCT_NAME" >}}, diagnostic information is sent to `stderr`. You can use the `--config.bypass-conversion-errors` flag with `--config.format=static` to bypass any non-critical issues and start {{< param "PRODUCT_NAME" >}}. {{< admonition type="caution" >}} @@ -149,9 +140,9 @@ Your configuration file must be a valid [Static] configuration file. ## Example -This example demonstrates converting a [Static] configuration file to a {{< param "PRODUCT_NAME" >}} configuration file. +This example demonstrates converting a Grafana Agent Static configuration file to a {{< param "PRODUCT_NAME" >}} configuration file. -The following [Static] configuration file provides the input for the conversion. +The following Grafana Agent Static configuration file provides the input for the conversion. ```yaml server: @@ -223,7 +214,7 @@ grafana-agent-flow convert --source-format=static --output= Replace the following: -* _``_: The full path to the [Static][] configuration. +* _``_: The full path to the Grafana Agent Static configuration. * _``_: The full path to output the {{< param "PRODUCT_NAME" >}} configuration. The new {{< param "PRODUCT_NAME" >}} configuration file looks like this: @@ -320,9 +311,9 @@ grafana-agent-flow convert --source-format=static --extra-args="-enable-features {{< /code >}} Replace the following: - * _``_: The full path to the [Static][] configuration. + * _``_: The full path to the Grafana Agent Static configuration. * _``_: The full path to output the {{< param "PRODUCT_NAME" >}} configuration. - + ## Environment Vars You can use the `-config.expand-env` command line flag to interpret environment variables in your Grafana Agent Static configuration. @@ -343,7 +334,7 @@ The following list is specific to the convert command and not {{< param "PRODUCT Any additional unsupported features are returned as errors during conversion. * There is no gRPC server to configure for {{< param "PRODUCT_NAME" >}}, as any non-default configuration will show as unsupported during the conversion. * Check if you are using any extra command line arguments with Static that aren't present in your configuration file. For example, `-server.http.address`. -* Check if you are using any environment variables in your [Static][] configuration. +* Check if you are using any environment variables in your Grafana Agent Static configuration. These will be evaluated during conversion and you may want to replace them with the {{< param "PRODUCT_NAME" >}} Standard library [env][] function after conversion. * Review additional [Prometheus Limitations][] for limitations specific to your [Metrics][] configuration. * Review additional [Promtail Limitations][] for limitations specific to your [Logs][] configuration. @@ -353,49 +344,33 @@ The following list is specific to the convert command and not {{< param "PRODUCT [debugging]: #debugging [example]: #example -{{% docs/reference %}} -[Static]: "/docs/agent/ -> /docs/agent//static" -[Static]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static" -[prometheus.scrape]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.scrape.md" -[prometheus.scrape]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/prometheus.scrape.md" -[prometheus.remote_write]: "/docs/agent/ -> /docs/agent//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" -[local.file_match]: "/docs/agent/ -> /docs/agent//flow/reference/components/local.file_match.md" -[local.file_match]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/local.file_match.md" -[loki.process]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.process.md" -[loki.process]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.process.md" -[loki.source.file]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.source.file.md" -[loki.source.file]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.source.file.md" -[loki.write]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.write.md" -[loki.write]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.write.md" -[Components]: "/docs/agent/ -> /docs/agent//flow/concepts/components.md" -[Components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md" -[convert]: "/docs/agent/ -> /docs/agent//flow/reference/cli/convert.md" -[convert]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/convert.md" -[run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" -[run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" -[Run]: "/docs/agent/ -> /docs/agent//flow/get-started/run/" -[Run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/get-started/run/" -[DebuggingUI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md" -[DebuggingUI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md" -[River]: "/docs/agent/ -> /docs/agent//flow/concepts/config-language/" -[River]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/config-language/" -[Integrations next]: "/docs/agent/ -> /docs/agent//static/configuration/integrations/integrations-next/_index.md" -[Integrations next]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/configuration/traces-config.md -[Traces]: "/docs/agent/ -> /docs/agent//static/configuration/traces-config.md" -[Traces]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/configuration/traces-config.md" -[Agent Management]: "/docs/agent/ -> /docs/agent//static/configuration/agent-management.md" -[Agent Management]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/configuration/agent-management.md" -[env]: "/docs/agent/ -> /docs/agent//flow/reference/stdlib/env.md" -[env]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/stdlib/env.md" -[Prometheus Limitations]: "/docs/agent/ -> /docs/agent//flow/tasks/migrate/from-prometheus.md#limitations" -[Prometheus Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/migrate/from-prometheus.md#limitations" -[Promtail Limitations]: "/docs/agent/ -> /docs/agent//flow/tasks/migrate/from-promtail.md#limitations" -[Promtail Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/migrate/from-promtail.md#limitations" -[Metrics]: "/docs/agent/ -> /docs/agent//static/configuration/metrics-config.md" -[Metrics]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/configuration/metrics-config.md" -[Logs]: "/docs/agent/ -> /docs/agent//static/configuration/logs-config.md" -[Logs]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/static/logs-config.md" -[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug#grafana-agent-flow-ui" -{{% /docs/reference %}} + +[Static]: https://grafana.com/docs/agent/latest/static + +[prometheus.scrape]: ../../../reference/components/prometheus.scrape/ +[prometheus.remote_write]: ../../../reference/components/prometheus.remote_write/ +[local.file_match]: ../../../reference/components/local.file_match/ +[loki.process]: ../../../reference/components/loki.process/ +[loki.source.file]: ../../../reference/components/loki.source.file/ +[loki.write]: ../../../reference/components/loki.write/ +[Components]: ../../../concepts/components/ +[convert]: ../../../reference/cli/convert/ +[run]: ../../../reference/cli/run/ +[run alloy]: ../../../get-started/run/ +[DebuggingUI]: ../../debug/ +[River]: ../../../concepts/config-language/ + + +[Integrations next]: https://grafana.com/docs/agent/latest/static/configuration/integrations/integrations-next/ +[Traces]: https://grafana.com/docs/agent/latest/static/configuration/traces-config/ +[Agent Management]: https://grafana.com/docs/agent/latest/static/configuration/agent-management/ + +[env]: ../../../reference/stdlib/env/ +[Prometheus Limitations]: ../from-prometheus/#limitations +[Promtail Limitations]: ../from-promtail/#limitations + + +[Metrics]: https://grafana.com/docs/agent/latest/static/configuration/metrics-config/ +[Logs]: https://grafana.com/docs/agent/latest/static/configuration/logs-config/ + +[UI]: ../../debug/#grafana-agent-flow-ui diff --git a/docs/sources/tasks/monitor/_index.md b/docs/sources/tasks/monitor/_index.md index ac23db2607..d96ba0cd0c 100644 --- a/docs/sources/tasks/monitor/_index.md +++ b/docs/sources/tasks/monitor/_index.md @@ -1,18 +1,9 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/monitor/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/monitor/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/monitor/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/monitor/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/monitoring/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/monitoring/ -- /docs/grafana-cloud/send-data/agent/flow/monitoring/ -- ../monitoring/ # /docs/agent/latest/flow/monitoring/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/monitor/ -description: Learn about monitoring Grafana Agent Flow -title: Monitor Grafana Agent Flow +- ./tasks/monitor/ +canonical: https://grafana.com/docs/alloy/latest/tasks/monitor/ +description: Learn about monitoring Grafana Alloy +title: Monitor Grafana Alloy menuTitle: Monitor weight: 110 --- diff --git a/docs/sources/tasks/monitor/component_metrics.md b/docs/sources/tasks/monitor/component_metrics.md index 5b3693a1f1..732a7336c9 100644 --- a/docs/sources/tasks/monitor/component_metrics.md +++ b/docs/sources/tasks/monitor/component_metrics.md @@ -1,18 +1,7 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/monitor/component_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/monitor/component_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/monitor/component_metrics/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/monitor/component_metrics/ -- component-metrics/ # /docs/agent/latest/flow/tasks/monitor/component-metrics/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/monitoring/component_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/component_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/monitoring/component_metrics/ -- /docs/grafana-cloud/send-data/agent/flow/monitoring/component_metrics/ -- ../../monitoring/component-metrics/ # /docs/agent/latest/flow/monitoring/component-metrics/ -- ../../monitoring/component_metrics/ # /docs/agent/latest/flow/monitoring/component_metrics/ -canonical: https://grafana.com/docs/agent/latest/flow/monitoring/component_metrics/ +- ./monitor/component_metrics/ +canonical: https://grafana.com/docs/alloy/latest/monitor/component_metrics/ description: Learn how to monitor component metrics title: Monitor components weight: 200 @@ -28,7 +17,7 @@ These component-specific metrics are only generated when an instance of that com Component-specific metrics are exposed at the `/metrics` HTTP endpoint of the {{< param "PRODUCT_NAME" >}} HTTP server, which defaults to listening on `http://localhost:12345`. -> The documentation for the [`grafana-agent run`][grafana-agent run] command describes how to > modify the address {{< param "PRODUCT_NAME" >}} listens on for HTTP traffic. +> The documentation for the [`grafana-agent run`][grafana-agent run] command describes how to modify the address {{< param "PRODUCT_NAME" >}} listens on for HTTP traffic. Component-specific metrics have a `component_id` label matching the component ID generating those metrics. For example, component-specific metrics for a `prometheus.remote_write` component labeled `production` will have a `component_id` label with the value `prometheus.remote_write.production`. @@ -36,11 +25,6 @@ For example, component-specific metrics for a `prometheus.remote_write` componen The [reference documentation][] for each component described the list of component-specific metrics that the component exposes. Not all components expose metrics. -{{% docs/reference %}} -[components]: "/docs/agent/ -> /docs/agent//flow/concepts/components.md" -[components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md" -[grafana-agent run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" -[grafana-agent run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" -[reference documentation]: "/docs/agent/ -> /docs/agent//flow/reference/components" -[reference documentation]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components" -{{% /docs/reference %}} \ No newline at end of file +[components]: ../../../concepts/components/ +[grafana-agent run]: ../../../reference/cli/run/ +[reference documentation]: ../../../reference/components/ diff --git a/docs/sources/tasks/monitor/controller_metrics.md b/docs/sources/tasks/monitor/controller_metrics.md index 0ba7617032..97af76c9cd 100644 --- a/docs/sources/tasks/monitor/controller_metrics.md +++ b/docs/sources/tasks/monitor/controller_metrics.md @@ -1,18 +1,7 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/monitor/controller_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/monitor/controller_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/monitor/controller_metrics/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/monitor/controller_metrics/ -- controller-metrics/ # /docs/agent/latest/flow/tasks/monitor/controller-metrics/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/monitoring/controller_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/monitoring/controller_metrics/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/monitoring/controller_metrics/ -- /docs/grafana-cloud/send-data/agent/flow/monitoring/controller_metrics/ -- ../../monitoring/controller-metrics/ # /docs/agent/latest/flow/monitoring/controller-metrics/ -- ../../monitoring/controller_metrics/ # /docs/agent/latest/flow/monitoring/controller_metrics/ -canonical: https://grafana.com/docs/agent/latest/flow/monitoring/controller_metrics/ +- ./monitor/controller_metrics/ +canonical: https://grafana.com/docs/alloy/latest/monitor/controller_metrics/ description: Learn how to monitor controller metrics title: Monitor controller weight: 100 @@ -36,9 +25,5 @@ The controller exposes the following metrics: * `agent_component_dependencies_wait_seconds` (Histogram): Time spent by components waiting to be evaluated after one of their dependencies is updated. * `agent_component_evaluation_queue_size` (Gauge): The current number of component evaluations waiting to be performed. -{{% docs/reference %}} -[component controller]: "/docs/agent/ -> /docs/agent//flow/concepts/component_controller.md" -[component controller]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/component_controller.md" -[grafana-agent run]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" -[grafana-agent run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" -{{% /docs/reference %}} +[component controller]: ../../../concepts/component_controller/ +[grafana-agent run]: ../../../reference/cli/run/ diff --git a/docs/sources/tasks/opentelemetry-to-lgtm-stack.md b/docs/sources/tasks/opentelemetry-to-lgtm-stack.md index 2da9790783..c323d9239a 100644 --- a/docs/sources/tasks/opentelemetry-to-lgtm-stack.md +++ b/docs/sources/tasks/opentelemetry-to-lgtm-stack.md @@ -1,18 +1,8 @@ --- aliases: -- /docs/grafana-cloud/agent/flow/tasks/opentelemetry-to-lgtm-stack/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/opentelemetry-to-lgtm-stack/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/opentelemetry-to-lgtm-stack/ -- /docs/grafana-cloud/send-data/agent/flow/tasks/opentelemetry-to-lgtm-stack/ -# Previous page aliases for backwards compatibility: -- /docs/grafana-cloud/agent/flow/getting-started/opentelemetry-to-lgtm-stack/ -- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/opentelemetry-to-lgtm-stack/ -- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/opentelemetry-to-lgtm-stack/ -- /docs/grafana-cloud/send-data/agent/flow/getting-started/opentelemetry-to-lgtm-stack/ -- ../getting-started/opentelemetry-to-lgtm-stack/ # /docs/agent/latest/flow/getting-started/opentelemetry-to-lgtm-stack/ -canonical: https://grafana.com/docs/agent/latest/flow/tasks/opentelemetry-to-lgtm-stack/ -description: Learn how to collect OpenTelemetry data and forward it to the Grafana - stack +- ./tasks/opentelemetry-to-lgtm-stack/ +canonical: https://grafana.com/docs/alloy/latest/tasks/opentelemetry-to-lgtm-stack/ +description: Learn how to collect OpenTelemetry data and forward it to the Grafana stack title: OpenTelemetry to Grafana stack weight: 350 --- @@ -44,7 +34,8 @@ This topic describes how to: * Have a set of OpenTelemetry applications ready to push telemetry data to {{< param "PRODUCT_NAME" >}}. * Identify where {{< param "PRODUCT_NAME" >}} will write received telemetry data. * Be familiar with the concept of [Components][] in {{< param "PRODUCT_NAME" >}}. -* Complete the [Collect open telemetry data][] task. You will pick up from where that guide ended. +* Complete the [Collect open telemetry data][] task. + You will pick up from where that guide ended. ## The pipeline @@ -98,7 +89,7 @@ Traces: OTel → batch processor → OTel exporter ## Grafana Loki [Grafana Loki][] is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus. -Similar to Prometheus, to send from OTLP to Loki, you can do a passthrough from the [otelcol.exporter.loki] component to [loki.write] component. +Similar to Prometheus, to send from OTLP to Loki, you can do a passthrough from the [otelcol.exporter.loki][] component to [loki.write][] component. ```river otelcol.exporter.loki "default" { @@ -310,7 +301,7 @@ ts=2023-05-09T09:37:15.304109Z component=otelcol.receiver.otlp.default level=inf ts=2023-05-09T09:37:15.304234Z component=otelcol.receiver.otlp.default level=info msg="Starting HTTP server" endpoint=0.0.0.0:4318 ``` -You can now check the pipeline graphically by visiting http://localhost:12345/graph +You can now check the pipeline graphically by visiting [http://localhost:12345/graph][] ![](../../../assets/tasks/otlp-lgtm-graph.png) @@ -320,26 +311,14 @@ You can now check the pipeline graphically by visiting http://localhost:12345/gr [Grafana Cloud Portal]: https://grafana.com/docs/grafana-cloud/account-management/cloud-portal#your-grafana-cloud-stack [Prometheus Remote Write]: https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage [Grafana Mimir]: https://grafana.com/oss/mimir/ - -{{% docs/reference %}} -[Collect open telemetry data]: "/docs/agent/ -> /docs/agent//flow/tasks/collect-opentelemetry-data.md" -[Collect open telemetry data]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/collect-opentelemetry-data.md" -[Components]: "/docs/agent/ -> /docs/agent//flow/concepts/components.md" -[Components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/concepts/components.md" -[loki.write]: "/docs/agent/ -> /docs/agent//flow/reference/components/loki.write.md" -[loki.write]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.write.md" -[otelcol.auth.basic]: "/docs/agent/ -> /docs/agent//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.loki]: "/docs/agent/ -> /docs/agent//flow/reference/components/otelcol.exporter.loki.md" -[otelcol.exporter.loki]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/otelcol.exporter.loki.md" -[otelcol.exporter.otlp]: "/docs/agent/ -> /docs/agent//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.prometheus]: "/docs/agent/ -> /docs/agent//flow/reference/components/otelcol.exporter.prometheus.md" -[otelcol.exporter.prometheus]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/otelcol.exporter.prometheus.md" -[otelcol.processor.batch]: "/docs/agent/ -> /docs/agent//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//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" -[prometheus.remote_write]: "/docs/agent/ -> /docs/agent//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" -{{% /docs/reference %}} +[Collect open telemetry data]: ../collect-opentelemetry-data/ +[Components]: ../../concepts/components/ +[loki.write]: ../../reference/components/loki.write/ +[otelcol.auth.basic]: ../../reference/components/otelcol.auth.basic/ +[otelcol.exporter.loki]: ../../reference/components/otelcol.exporter.loki/ +[otelcol.exporter.otlp]: ../../reference/components/otelcol.exporter.otlp/ +[otelcol.exporter.prometheus]: ../../reference/components/otelcol.exporter.prometheus/ +[otelcol.processor.batch]: ../../reference/components/otelcol.processor.batch/ +[otelcol.receiver.otlp]: ../../reference/components/otelcol.receiver.otlp/ +[prometheus.remote_write]: ../../reference/components/prometheus.remote_write/ +[http://localhost:12345/graph]: http://localhost:12345/graph