From 07c69aa5abfd71f98fc603e13ed7340fd231a029 Mon Sep 17 00:00:00 2001 From: Piotr <17101802+thampiotr@users.noreply.github.com> Date: Fri, 5 Jan 2024 11:41:33 +0100 Subject: [PATCH] Move 'Getting started' to 'Tasks' (#6043) * Move 'Getting started' to 'Tasks' * fix aliases --- docs/sources/about.md | 12 ++++----- .../loki-config.png | Bin .../otlp-lgtm-graph.png | Bin .../prometheus-config.png | Bin .../tempo-config.png | Bin docs/sources/flow/_index.md | 6 ++--- docs/sources/flow/getting-started/_index.md | 19 ------------- docs/sources/flow/reference/cli/convert.md | 6 ++--- docs/sources/flow/tasks/_index.md | 25 ++++++++++++++++++ .../collect-opentelemetry-data.md | 8 +++++- .../collect-prometheus-metrics.md | 8 +++++- .../configure-agent-clustering.md | 8 +++++- .../distribute-prometheus-scrape-load.md | 16 +++++++---- .../migrating-from-operator.md | 6 ++++- .../migrating-from-prometheus.md | 8 +++++- .../migrating-from-promtail.md | 8 +++++- .../migrating-from-static.md | 16 +++++++---- .../opentelemetry-to-lgtm-stack.md | 24 ++++++++++------- 18 files changed, 114 insertions(+), 56 deletions(-) rename docs/sources/assets/{getting-started => tasks}/loki-config.png (100%) rename docs/sources/assets/{getting-started => tasks}/otlp-lgtm-graph.png (100%) rename docs/sources/assets/{getting-started => tasks}/prometheus-config.png (100%) rename docs/sources/assets/{getting-started => tasks}/tempo-config.png (100%) delete mode 100644 docs/sources/flow/getting-started/_index.md create mode 100644 docs/sources/flow/tasks/_index.md rename docs/sources/flow/{getting-started => tasks}/collect-opentelemetry-data.md (95%) rename docs/sources/flow/{getting-started => tasks}/collect-prometheus-metrics.md (96%) rename docs/sources/flow/{getting-started => tasks}/configure-agent-clustering.md (83%) rename docs/sources/flow/{getting-started => tasks}/distribute-prometheus-scrape-load.md (78%) rename docs/sources/flow/{getting-started => tasks}/migrating-from-operator.md (97%) rename docs/sources/flow/{getting-started => tasks}/migrating-from-prometheus.md (95%) rename docs/sources/flow/{getting-started => tasks}/migrating-from-promtail.md (95%) rename docs/sources/flow/{getting-started => tasks}/migrating-from-static.md (95%) rename docs/sources/flow/{getting-started => tasks}/opentelemetry-to-lgtm-stack.md (93%) diff --git a/docs/sources/about.md b/docs/sources/about.md index 0737815b61d6..c33d73087408 100644 --- a/docs/sources/about.md +++ b/docs/sources/about.md @@ -29,12 +29,12 @@ Grafana Agent is available in three different variants: [Static mode Kubernetes operator]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/operator" [Flow mode]: "/docs/agent/ -> /docs/agent//flow" [Flow mode]: "/docs/grafana-cloud/ -> /docs/agent//flow" -[Prometheus]: "/docs/agent/ -> /docs/agent//flow/getting-started/collect-prometheus-metrics.md" -[Prometheus]: "/docs/grafana-cloud/ -> /docs/agent//flow/getting-started/collect-prometheus-metrics.md" -[OTel]: "/docs/agent/ -> /docs/agent//flow/getting-started/collect-opentelemetry-data.md" -[OTel]: "/docs/grafana-cloud/ -> /docs/agent//flow/getting-started/collect-opentelemetry-data.md" -[Loki]: "/docs/agent/ -> /docs/agent//flow/getting-started/migrating-from-promtail.md" -[Loki]: "/docs/grafana-cloud/ -> /docs/agent//flow/getting-started/migrating-from-promtail.md" +[Prometheus]: "/docs/agent/ -> /docs/agent//flow/tasks/collect-prometheus-metrics.md" +[Prometheus]: "/docs/grafana-cloud/ -> /docs/agent//flow/tasks/collect-prometheus-metrics.md" +[OTel]: "/docs/agent/ -> /docs/agent//flow/tasks/collect-opentelemetry-data.md" +[OTel]: "/docs/grafana-cloud/ -> /docs/agent//flow/tasks/collect-opentelemetry-data.md" +[Loki]: "/docs/agent/ -> /docs/agent//flow/tasks/migrating-from-promtail.md" +[Loki]: "/docs/grafana-cloud/ -> /docs/agent//flow/tasks/migrating-from-promtail.md" [clustering]: "/docs/agent/ -> /docs/agent//flow/concepts/clustering/_index.md" [clustering]: "/docs/grafana-cloud/ -> /docs/agent//flow/concepts/clustering/_index.md" [rules]: "/docs/agent/ -> /docs/agent/latest/flow/reference/components/mimir.rules.kubernetes.md" diff --git a/docs/sources/assets/getting-started/loki-config.png b/docs/sources/assets/tasks/loki-config.png similarity index 100% rename from docs/sources/assets/getting-started/loki-config.png rename to docs/sources/assets/tasks/loki-config.png diff --git a/docs/sources/assets/getting-started/otlp-lgtm-graph.png b/docs/sources/assets/tasks/otlp-lgtm-graph.png similarity index 100% rename from docs/sources/assets/getting-started/otlp-lgtm-graph.png rename to docs/sources/assets/tasks/otlp-lgtm-graph.png diff --git a/docs/sources/assets/getting-started/prometheus-config.png b/docs/sources/assets/tasks/prometheus-config.png similarity index 100% rename from docs/sources/assets/getting-started/prometheus-config.png rename to docs/sources/assets/tasks/prometheus-config.png diff --git a/docs/sources/assets/getting-started/tempo-config.png b/docs/sources/assets/tasks/tempo-config.png similarity index 100% rename from docs/sources/assets/getting-started/tempo-config.png rename to docs/sources/assets/tasks/tempo-config.png diff --git a/docs/sources/flow/_index.md b/docs/sources/flow/_index.md index 7458fd016b03..4262238f9020 100644 --- a/docs/sources/flow/_index.md +++ b/docs/sources/flow/_index.md @@ -80,14 +80,14 @@ This feature is experimental, and it doesn't support all River components. * [Install][] {{< param "PRODUCT_NAME" >}}. * Learn about the core [Concepts][] of {{< param "PRODUCT_NAME" >}}. -* Follow our [Getting started][] guides for {{< param "PRODUCT_NAME" >}}. -* Follow our [Tutorials][] to get started with {{< param "PRODUCT_NAME" >}}. +* Follow our [Tutorials][] for hands-on learning of {{< param "PRODUCT_NAME" >}}. +* Consult our [Tasks][] instructions to accomplish common objectives with {{< param "PRODUCT_NAME" >}}. * Check out our [Reference][] documentation to find specific information you might be looking for. [Install]: {{< relref "./setup/install/" >}} [Concepts]: {{< relref "./concepts/" >}} -[Getting started]: {{< relref "./getting-started/" >}} +[Tasks]: {{< relref "./tasks/" >}} [Tutorials]: {{< relref "./tutorials/ ">}} [Reference]: {{< relref "./reference" >}} diff --git a/docs/sources/flow/getting-started/_index.md b/docs/sources/flow/getting-started/_index.md deleted file mode 100644 index bc989084f42b..000000000000 --- a/docs/sources/flow/getting-started/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -aliases: -- /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/ -canonical: https://grafana.com/docs/agent/latest/flow/getting-started/ -description: Learn how to use Grafana Agent Flow -menuTitle: Get started -title: Get started with Grafana Agent Flow -weight: 200 ---- - -# Get started with {{% param "PRODUCT_NAME" %}} - -This section details guides for getting started with {{< param "PRODUCT_NAME" >}}. - -{{< section >}} diff --git a/docs/sources/flow/reference/cli/convert.md b/docs/sources/flow/reference/cli/convert.md index 88c9628fde31..833341b47752 100644 --- a/docs/sources/flow/reference/cli/convert.md +++ b/docs/sources/flow/reference/cli/convert.md @@ -82,7 +82,7 @@ This includes Prometheus features such as and many supported *_sd_configs. Unsupported features in a source configuration result in [errors]. -Refer to [Migrate from Prometheus to {{< param "PRODUCT_NAME" >}}]({{< relref "../../getting-started/migrating-from-prometheus/" >}}) for a detailed migration guide. +Refer to [Migrate from Prometheus to {{< param "PRODUCT_NAME" >}}]({{< relref "../../tasks/migrating-from-prometheus/" >}}) for a detailed migration guide. ### Promtail @@ -96,7 +96,7 @@ are supported and can be converted to {{< param "PRODUCT_NAME" >}} configuration If you have unsupported features in a source configuration, you will receive [errors] when you convert to a flow configuration. The converter will also raise warnings for configuration options that may require your attention. -Refer to [Migrate from Promtail to {{< param "PRODUCT_NAME" >}}]({{< relref "../../getting-started/migrating-from-promtail/" >}}) for a detailed migration guide. +Refer to [Migrate from Promtail to {{< param "PRODUCT_NAME" >}}]({{< relref "../../tasks/migrating-from-promtail/" >}}) for a detailed migration guide. ### Static @@ -113,4 +113,4 @@ flags with a space between each flag, for example `--extra-args="-enable-feature If you have unsupported features in a Static mode source configuration, you will receive [errors][] when you convert to a Flow mode configuration. The converter will also raise warnings for configuration options that may require your attention. -Refer to [Migrate from Grafana Agent Static to {{< param "PRODUCT_NAME" >}}]({{< relref "../../getting-started/migrating-from-static/" >}}) for a detailed migration guide. \ No newline at end of file +Refer to [Migrate from Grafana Agent Static to {{< param "PRODUCT_NAME" >}}]({{< relref "../../tasks/migrating-from-static/" >}}) for a detailed migration guide. \ No newline at end of file diff --git a/docs/sources/flow/tasks/_index.md b/docs/sources/flow/tasks/_index.md new file mode 100644 index 000000000000..4ca62e8c1331 --- /dev/null +++ b/docs/sources/flow/tasks/_index.md @@ -0,0 +1,25 @@ +--- +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 +menuTitle: Tasks +title: Tasks with Grafana Agent Flow +weight: 200 +--- + +# Tasks with {{% param "PRODUCT_NAME" %}} + +This section details how to perform common tasks with {{< param "PRODUCT_NAME" >}}. + +{{< section >}} diff --git a/docs/sources/flow/getting-started/collect-opentelemetry-data.md b/docs/sources/flow/tasks/collect-opentelemetry-data.md similarity index 95% rename from docs/sources/flow/getting-started/collect-opentelemetry-data.md rename to docs/sources/flow/tasks/collect-opentelemetry-data.md index 70dee8041d9f..22248f9f70f9 100644 --- a/docs/sources/flow/getting-started/collect-opentelemetry-data.md +++ b/docs/sources/flow/tasks/collect-opentelemetry-data.md @@ -1,10 +1,16 @@ --- 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/ -canonical: https://grafana.com/docs/agent/latest/flow/getting-started/collect-opentelemetry-data/ +- ../getting-started/collect-opentelemetry-data/ # /docs/agent/latest/flow/getting-started/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 weight: 300 diff --git a/docs/sources/flow/getting-started/collect-prometheus-metrics.md b/docs/sources/flow/tasks/collect-prometheus-metrics.md similarity index 96% rename from docs/sources/flow/getting-started/collect-prometheus-metrics.md rename to docs/sources/flow/tasks/collect-prometheus-metrics.md index be6d2ce71e01..350ce1ccfd4d 100644 --- a/docs/sources/flow/getting-started/collect-prometheus-metrics.md +++ b/docs/sources/flow/tasks/collect-prometheus-metrics.md @@ -1,10 +1,16 @@ --- 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/ -canonical: https://grafana.com/docs/agent/latest/flow/getting-started/collect-prometheus-metrics/ +- ../getting-started/collect-prometheus-metrics/ # /docs/agent/latest/flow/getting-started/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 weight: 200 diff --git a/docs/sources/flow/getting-started/configure-agent-clustering.md b/docs/sources/flow/tasks/configure-agent-clustering.md similarity index 83% rename from docs/sources/flow/getting-started/configure-agent-clustering.md rename to docs/sources/flow/tasks/configure-agent-clustering.md index eacc61407986..b1ab444d4ebb 100644 --- a/docs/sources/flow/getting-started/configure-agent-clustering.md +++ b/docs/sources/flow/tasks/configure-agent-clustering.md @@ -1,10 +1,16 @@ --- 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/ -canonical: https://grafana.com/docs/agent/latest/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 diff --git a/docs/sources/flow/getting-started/distribute-prometheus-scrape-load.md b/docs/sources/flow/tasks/distribute-prometheus-scrape-load.md similarity index 78% rename from docs/sources/flow/getting-started/distribute-prometheus-scrape-load.md rename to docs/sources/flow/tasks/distribute-prometheus-scrape-load.md index d881b2f0a34b..961c98543b98 100644 --- a/docs/sources/flow/getting-started/distribute-prometheus-scrape-load.md +++ b/docs/sources/flow/tasks/distribute-prometheus-scrape-load.md @@ -1,10 +1,16 @@ --- 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/ -canonical: https://grafana.com/docs/agent/latest/flow/getting-started/distribute-prometheus-scrape-load/ +- ../getting-started/distribute-prometheus-scrape-load/ # /docs/agent/latest/flow/getting-started/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 title: Distribute Prometheus metrics scrape load @@ -53,10 +59,10 @@ To distribute Prometheus metrics scrape load with clustering: [beta]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/stability.md#beta" [configure-grafana-agent]: "/docs/agent/ -> /docs/agent//flow/setup/configure" [configure-grafana-agent]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/configure" -[Configure Prometheus metrics collection]: "/docs/agent/ -> /docs/agent//flow/getting-started/collect-prometheus-metrics.md" -[Configure Prometheus metrics collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/collect-prometheus-metrics.md" -[Configure clustering]: "/docs/agent/ -> /docs/agent//flow/getting-started/configure-agent-clustering.md" -[Configure clustering]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/configure-agent-clustering.md" +[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/monitoring/debugging.md#component-detail-page" [UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#component-detail-page" {{% /docs/reference %}} diff --git a/docs/sources/flow/getting-started/migrating-from-operator.md b/docs/sources/flow/tasks/migrating-from-operator.md similarity index 97% rename from docs/sources/flow/getting-started/migrating-from-operator.md rename to docs/sources/flow/tasks/migrating-from-operator.md index 5985488c2915..375ffec59e51 100644 --- a/docs/sources/flow/getting-started/migrating-from-operator.md +++ b/docs/sources/flow/tasks/migrating-from-operator.md @@ -1,8 +1,12 @@ --- aliases: +- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-operator/ +- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-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/ -canonical: https://grafana.com/docs/agent/latest/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/migrating-from-operator/ description: Migrating from Grafana Agent Operator to Grafana Agent Flow menuTitle: Migrate from Operator title: Migrating from Grafana Agent Operator to Grafana Agent Flow diff --git a/docs/sources/flow/getting-started/migrating-from-prometheus.md b/docs/sources/flow/tasks/migrating-from-prometheus.md similarity index 95% rename from docs/sources/flow/getting-started/migrating-from-prometheus.md rename to docs/sources/flow/tasks/migrating-from-prometheus.md index 8d77d6914340..837ca9da1e07 100644 --- a/docs/sources/flow/getting-started/migrating-from-prometheus.md +++ b/docs/sources/flow/tasks/migrating-from-prometheus.md @@ -1,10 +1,16 @@ --- aliases: +- /docs/grafana-cloud/agent/flow/tasks/migrating-from-prometheus/ +- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-prometheus/ +- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrating-from-prometheus/ +- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-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/ -canonical: https://grafana.com/docs/agent/latest/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/migrating-from-prometheus/ description: Learn how to migrate from Prometheus to Grafana Agent Flow menuTitle: Migrate from Prometheus title: Migrate from Prometheus to Grafana Agent Flow diff --git a/docs/sources/flow/getting-started/migrating-from-promtail.md b/docs/sources/flow/tasks/migrating-from-promtail.md similarity index 95% rename from docs/sources/flow/getting-started/migrating-from-promtail.md rename to docs/sources/flow/tasks/migrating-from-promtail.md index 4799e0e20b5f..d38e9b904697 100644 --- a/docs/sources/flow/getting-started/migrating-from-promtail.md +++ b/docs/sources/flow/tasks/migrating-from-promtail.md @@ -1,10 +1,16 @@ --- aliases: +- /docs/grafana-cloud/agent/flow/tasks/migrating-from-promtail/ +- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-promtail/ +- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrating-from-promtail/ +- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-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/ -canonical: https://grafana.com/docs/agent/latest/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/migrating-from-promtail/ description: Learn how to migrate from Promtail to Grafana Agent Flow menuTitle: Migrate from Promtail title: Migrate from Promtail to Grafana Agent Flow diff --git a/docs/sources/flow/getting-started/migrating-from-static.md b/docs/sources/flow/tasks/migrating-from-static.md similarity index 95% rename from docs/sources/flow/getting-started/migrating-from-static.md rename to docs/sources/flow/tasks/migrating-from-static.md index 8b7b1f98721e..a4033dab096a 100644 --- a/docs/sources/flow/getting-started/migrating-from-static.md +++ b/docs/sources/flow/tasks/migrating-from-static.md @@ -1,10 +1,16 @@ --- aliases: +- /docs/grafana-cloud/agent/flow/tasks/migrating-from-static/ +- /docs/grafana-cloud/monitor-infrastructure/agent/flow/tasks/migrating-from-static/ +- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/tasks/migrating-from-static/ +- /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-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/ -canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-from-static/ +- ../getting-started/migrating-from-static/ # /docs/agent/latest/flow/getting-started/migrating-from-static/ +canonical: https://grafana.com/docs/agent/latest/flow/tasks/migrating-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 @@ -382,10 +388,10 @@ The following list is specific to the convert command and not {{< param "PRODUCT [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/getting-started/migrating-from-prometheus.md#limitations" -[Prometheus Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-prometheus.md#limitations" -[Promtail Limitations]: "/docs/agent/ -> /docs/agent//flow/getting-started/migrating-from-promtail.md#limitations" -[Promtail Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/migrating-from-promtail.md#limitations" +[Prometheus Limitations]: "/docs/agent/ -> /docs/agent//flow/tasks/migrating-from-prometheus.md#limitations" +[Prometheus Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-from-prometheus.md#limitations" +[Promtail Limitations]: "/docs/agent/ -> /docs/agent//flow/tasks/migrating-from-promtail.md#limitations" +[Promtail Limitations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/migrating-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" diff --git a/docs/sources/flow/getting-started/opentelemetry-to-lgtm-stack.md b/docs/sources/flow/tasks/opentelemetry-to-lgtm-stack.md similarity index 93% rename from docs/sources/flow/getting-started/opentelemetry-to-lgtm-stack.md rename to docs/sources/flow/tasks/opentelemetry-to-lgtm-stack.md index 279960d79fe0..2da979078336 100644 --- a/docs/sources/flow/getting-started/opentelemetry-to-lgtm-stack.md +++ b/docs/sources/flow/tasks/opentelemetry-to-lgtm-stack.md @@ -1,10 +1,16 @@ --- 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/ -canonical: https://grafana.com/docs/agent/latest/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 title: OpenTelemetry to Grafana stack @@ -38,11 +44,11 @@ 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][] getting started guide. 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 -You can start with the {{< param "PRODUCT_NAME" >}} configuration you created in the [Collect open telemetry data][] Getting Started guide. +You can start with the {{< param "PRODUCT_NAME" >}} configuration you created in the [Collect open telemetry data][] task. ```river otelcol.receiver.otlp "example" { @@ -108,7 +114,7 @@ loki.write "default" { To use Loki with basic-auth, which is required with Grafana Cloud Loki, you must configure the [loki.write][] component. You can get the Loki configuration from the Loki **Details** page in the [Grafana Cloud Portal][]: -![](../../../assets/getting-started/loki-config.png) +![](../../../assets/tasks/loki-config.png) ```river otelcol.exporter.loki "grafana_cloud_loki" { @@ -143,7 +149,7 @@ otelcol.exporter.otlp "default" { To use Tempo with basic-auth, which is required with Grafana Cloud Tempo, you must use the [otelcol.auth.basic][] component. You can get the Tempo configuration from the Tempo **Details** page in the [Grafana Cloud Portal][]: -![](../../../assets/getting-started/tempo-config.png) +![](../../../assets/tasks/tempo-config.png) ```river otelcol.exporter.otlp "grafana_cloud_tempo" { @@ -180,7 +186,7 @@ prometheus.remote_write "default" { To use Prometheus with basic-auth, which is required with Grafana Cloud Prometheus, you must configure the [prometheus.remote_write][] component. You can get the Prometheus configuration from the Prometheus **Details** page in the [Grafana Cloud Portal][]: -![](../../../assets/getting-started/prometheus-config.png) +![](../../../assets/tasks/prometheus-config.png) ```river otelcol.exporter.prometheus "grafana_cloud_prometheus" { @@ -306,7 +312,7 @@ ts=2023-05-09T09:37:15.304234Z component=otelcol.receiver.otlp.default level=inf You can now check the pipeline graphically by visiting http://localhost:12345/graph -![](../../../assets/getting-started/otlp-lgtm-graph.png) +![](../../../assets/tasks/otlp-lgtm-graph.png) [OpenTelemetry]: https://opentelemetry.io [Grafana Loki]: https://grafana.com/oss/loki/ @@ -316,8 +322,8 @@ You can now check the pipeline graphically by visiting http://localhost:12345/gr [Grafana Mimir]: https://grafana.com/oss/mimir/ {{% docs/reference %}} -[Collect open telemetry data]: "/docs/agent/ -> /docs/agent//flow/getting-started/collect-opentelemetry-data.md" -[Collect open telemetry data]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/getting-started/collect-opentelemetry-data.md" +[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"