From d1619fc3050d20192bc57b93ffc67e419409b64b Mon Sep 17 00:00:00 2001 From: Piotr <17101802+thampiotr@users.noreply.github.com> Date: Mon, 8 Jan 2024 17:18:58 +0000 Subject: [PATCH] Docs: Move Monitoring section into Tasks section (#6064) * Move monitoring section into Tasks * Make generate versioned files * Revert "Make generate versioned files" This reverts commit 240908be24c7cc8fb79feeb4daebcc8dda8f6bae. * update gen template * tweak monitor docs titles --- docs/sources/_index.md | 4 ++-- docs/sources/_index.md.t | 4 ++-- docs/sources/flow/concepts/clustering.md | 8 +++---- docs/sources/flow/monitoring/_index.md | 18 -------------- docs/sources/flow/reference/cli/run.md | 2 +- .../flow/setup/configure/configure-linux.md | 4 ++-- .../flow/setup/configure/configure-macos.md | 4 ++-- .../flow/setup/configure/configure-windows.md | 4 ++-- docs/sources/flow/setup/install/docker.md | 4 ++-- .../flow/tasks/configure-agent-clustering.md | 4 ++-- .../debugging.md => tasks/debug.md} | 23 +++++++++++------- .../distribute-prometheus-scrape-load.md | 4 ++-- .../estimate-resource-usage.md} | 15 +++++++++--- .../flow/tasks/migrate/from-prometheus.md | 8 +++---- .../flow/tasks/migrate/from-promtail.md | 8 +++---- .../sources/flow/tasks/migrate/from-static.md | 8 +++---- docs/sources/flow/tasks/monitor/_index.md | 24 +++++++++++++++++++ .../monitor}/component_metrics.md | 15 ++++++++---- .../monitor}/controller_metrics.md | 15 ++++++++---- 19 files changed, 106 insertions(+), 70 deletions(-) delete mode 100644 docs/sources/flow/monitoring/_index.md rename docs/sources/flow/{monitoring/debugging.md => tasks/debug.md} (89%) rename docs/sources/flow/{monitoring/agent-resource-usage.md => tasks/estimate-resource-usage.md} (79%) create mode 100644 docs/sources/flow/tasks/monitor/_index.md rename docs/sources/flow/{monitoring => tasks/monitor}/component_metrics.md (75%) rename docs/sources/flow/{monitoring => tasks/monitor}/controller_metrics.md (74%) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 1a7a2a261874..4b19726241b6 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -115,6 +115,6 @@ Patch and security releases may be created at any time. [Flow mode]: "/docs/agent/ -> /docs/agent//flow" [Flow mode]: "/docs/grafana-cloud/ -> /docs/agent//flow" -[UI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md#grafana-agent-flow-ui" +[UI]: "/docs/grafana-cloud/ -> /docs/agent//flow/tasks/debug.md#grafana-agent-flow-ui" {{% /docs/reference %}} diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t index d769d5cfffc5..c8dccbfb6748 100644 --- a/docs/sources/_index.md.t +++ b/docs/sources/_index.md.t @@ -115,6 +115,6 @@ Patch and security releases may be created at any time. [Flow mode]: "/docs/agent/ -> /docs/agent//flow" [Flow mode]: "/docs/grafana-cloud/ -> /docs/agent//flow" -[UI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/agent//flow/monitoring/debugging.md#grafana-agent-flow-ui" +[UI]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md#grafana-agent-flow-ui" +[UI]: "/docs/grafana-cloud/ -> /docs/agent//flow/tasks/debug.md#grafana-agent-flow-ui" {{% /docs/reference %}} diff --git a/docs/sources/flow/concepts/clustering.md b/docs/sources/flow/concepts/clustering.md index 3f6f5b093639..e02a6131d4a5 100644 --- a/docs/sources/flow/concepts/clustering.md +++ b/docs/sources/flow/concepts/clustering.md @@ -76,8 +76,8 @@ Refer to [Debugging clustering issues][debugging] for additional troubleshooting [prometheus.operator.podmonitors]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/prometheus.operator.podmonitors.md#clustering-beta" [prometheus.operator.servicemonitors]: "/docs/agent/ -> /docs/agent//flow/reference/components/prometheus.operator.servicemonitors.md#clustering-beta" [prometheus.operator.servicemonitors]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/components/prometheus.operator.servicemonitors.md#clustering-beta" -[clustering page]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#clustering-page" -[clustering page]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#clustering-page" -[debugging]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md#debugging-clustering-issues" -[debugging]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#debugging-clustering-issues" +[clustering page]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md#clustering-page" +[clustering page]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md#clustering-page" +[debugging]: "/docs/agent/ -> /docs/agent//flow/tasks/debug.md#debugging-clustering-issues" +[debugging]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/debug.md#debugging-clustering-issues" {{% /docs/reference %}} \ No newline at end of file diff --git a/docs/sources/flow/monitoring/_index.md b/docs/sources/flow/monitoring/_index.md deleted file mode 100644 index 729bbaa8ff89..000000000000 --- a/docs/sources/flow/monitoring/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -aliases: -- /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/ -canonical: https://grafana.com/docs/agent/latest/flow/monitoring/ -description: Learn about monitoring Grafana Agent Flow -title: Monitoring Grafana Agent Flow -menuTitle: Monitoring -weight: 500 ---- - -# Monitoring {{% param "PRODUCT_NAME" %}} - -This section details various ways to monitor and debug {{< param "PRODUCT_NAME" >}}. - -{{< section >}} diff --git a/docs/sources/flow/reference/cli/run.md b/docs/sources/flow/reference/cli/run.md index 4a7adc21b7b2..4da0df47a473 100644 --- a/docs/sources/flow/reference/cli/run.md +++ b/docs/sources/flow/reference/cli/run.md @@ -171,7 +171,7 @@ transitions to the terminating state when shutting down. The current state of a clustered {{< param "PRODUCT_ROOT_NAME" >}} is shown on the clustering page in the [UI][]. -[UI]: {{< relref "../../monitoring/debugging.md#clustering-page" >}} +[UI]: {{< relref "../../tasks/debug.md#clustering-page" >}} ## Configuration conversion (beta) diff --git a/docs/sources/flow/setup/configure/configure-linux.md b/docs/sources/flow/setup/configure/configure-linux.md index 3964eb416070..a2cb7389774f 100644 --- a/docs/sources/flow/setup/configure/configure-linux.md +++ b/docs/sources/flow/setup/configure/configure-linux.md @@ -93,6 +93,6 @@ To expose the UI to other machines, complete the following steps: {{% 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/monitoring/debugging.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +[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 %}} diff --git a/docs/sources/flow/setup/configure/configure-macos.md b/docs/sources/flow/setup/configure/configure-macos.md index 5261e75f9877..e0943be422cb 100644 --- a/docs/sources/flow/setup/configure/configure-macos.md +++ b/docs/sources/flow/setup/configure/configure-macos.md @@ -82,6 +82,6 @@ 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/monitoring/debugging.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +[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 %}} diff --git a/docs/sources/flow/setup/configure/configure-windows.md b/docs/sources/flow/setup/configure/configure-windows.md index 010e6897b8ea..520ba2b64539 100644 --- a/docs/sources/flow/setup/configure/configure-windows.md +++ b/docs/sources/flow/setup/configure/configure-windows.md @@ -90,7 +90,7 @@ 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/monitoring/debugging.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +[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 %}} diff --git a/docs/sources/flow/setup/install/docker.md b/docs/sources/flow/setup/install/docker.md index 15f9e391e08e..9460ab71a8f3 100644 --- a/docs/sources/flow/setup/install/docker.md +++ b/docs/sources/flow/setup/install/docker.md @@ -92,6 +92,6 @@ To verify that {{< param "PRODUCT_NAME" >}} is running successfully, navigate to {{% 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/monitoring/debugging.md#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md#grafana-agent-flow-ui" +[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 %}} diff --git a/docs/sources/flow/tasks/configure-agent-clustering.md b/docs/sources/flow/tasks/configure-agent-clustering.md index b1ab444d4ebb..ca67ecd2d608 100644 --- a/docs/sources/flow/tasks/configure-agent-clustering.md +++ b/docs/sources/flow/tasks/configure-agent-clustering.md @@ -69,6 +69,6 @@ To configure clustering: [beta]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/stability.md#beta" [install-helm]: "/docs/agent/ -> /docs/agent//flow/setup/install/kubernetes.md" [install-helm]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/install/kubernetes.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" +[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 %}} diff --git a/docs/sources/flow/monitoring/debugging.md b/docs/sources/flow/tasks/debug.md similarity index 89% rename from docs/sources/flow/monitoring/debugging.md rename to docs/sources/flow/tasks/debug.md index a3d148e52487..6932d6082f82 100644 --- a/docs/sources/flow/monitoring/debugging.md +++ b/docs/sources/flow/tasks/debug.md @@ -1,16 +1,23 @@ --- 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 -title: Debugging -weight: 300 +description: Learn about debugging issues with Grafana Agent Flow +title: Debug issues with Grafana Agent Flow +menuTitle: Debug issues +weight: 1000 --- -# Debugging +# Debug {{< param "PRODUCT_NAME" >}} Follow these steps to debug issues with {{< param "PRODUCT_NAME" >}}: @@ -32,7 +39,7 @@ Follow these steps to debug issues with {{< param "PRODUCT_NAME" >}}: ### Home page -![](../../../assets/ui_home_page.png) +![](../../assets/ui_home_page.png) The home page shows a table of components defined in the configuration file and their health. @@ -42,14 +49,14 @@ Click the {{< param "PRODUCT_ROOT_NAME" >}} logo to navigate back to the home pa ### Graph page -![](../../../assets/ui_graph_page.png) +![](../../assets/ui_graph_page.png) The **Graph** page shows a graph view of components defined in the configuration file and their health. Clicking a component in the graph navigates to the [Component detail page](#component-detail-page) for that component. ### Component detail page -![](../../../assets/ui_component_detail_page.png) +![](../../assets/ui_component_detail_page.png) The component detail page shows the following information for each component: @@ -62,7 +69,7 @@ The component detail page shows the following information for each component: ### Clustering page -![](../../../assets/ui_clustering_page.png) +![](../../assets/ui_clustering_page.png) The clustering page shows the following information for each cluster node: diff --git a/docs/sources/flow/tasks/distribute-prometheus-scrape-load.md b/docs/sources/flow/tasks/distribute-prometheus-scrape-load.md index 961c98543b98..329f6eed9ade 100644 --- a/docs/sources/flow/tasks/distribute-prometheus-scrape-load.md +++ b/docs/sources/flow/tasks/distribute-prometheus-scrape-load.md @@ -63,6 +63,6 @@ To distribute Prometheus metrics scrape load with clustering: [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" +[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 %}} diff --git a/docs/sources/flow/monitoring/agent-resource-usage.md b/docs/sources/flow/tasks/estimate-resource-usage.md similarity index 79% rename from docs/sources/flow/monitoring/agent-resource-usage.md rename to docs/sources/flow/tasks/estimate-resource-usage.md index 21b16106d5a3..6fb8a146f6d9 100644 --- a/docs/sources/flow/monitoring/agent-resource-usage.md +++ b/docs/sources/flow/tasks/estimate-resource-usage.md @@ -1,17 +1,26 @@ --- 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: Guidance for expected Agent resource usage +description: Estimate expected Agent resource usage headless: true -title: Resource usage +title: Estimate resource usage +menuTitle: Estimate resource usage +weight: 190 --- -# {{% param "PRODUCT_NAME" %}} resource usage +# 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 diff --git a/docs/sources/flow/tasks/migrate/from-prometheus.md b/docs/sources/flow/tasks/migrate/from-prometheus.md index 74a53f2475c5..6224d82901e7 100644 --- a/docs/sources/flow/tasks/migrate/from-prometheus.md +++ b/docs/sources/flow/tasks/migrate/from-prometheus.md @@ -258,10 +258,10 @@ The following list is specific to the convert command and not {{< param "PRODUCT [run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" [Start]: "/docs/agent/ -> /docs/agent//flow/setup/start-agent.md" [Start]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/start-agent.md" -[DebuggingUI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md" -[DebuggingUI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md" +[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/monitoring/debugging#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging#grafana-agent-flow-ui" +[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 %}} diff --git a/docs/sources/flow/tasks/migrate/from-promtail.md b/docs/sources/flow/tasks/migrate/from-promtail.md index 89c863f8758f..29dc2ca5c0e6 100644 --- a/docs/sources/flow/tasks/migrate/from-promtail.md +++ b/docs/sources/flow/tasks/migrate/from-promtail.md @@ -241,10 +241,10 @@ The following list is specific to the convert command and not {{< param "PRODUCT [run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" [Start]: "/docs/agent/ -> /docs/agent//flow/setup/start-agent.md" [Start]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/start-agent.md" -[DebuggingUI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md" -[DebuggingUI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md" +[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/monitoring/debugging#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging#grafana-agent-flow-ui" +[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 %}} diff --git a/docs/sources/flow/tasks/migrate/from-static.md b/docs/sources/flow/tasks/migrate/from-static.md index bf8532f207d9..0a6fb982853b 100644 --- a/docs/sources/flow/tasks/migrate/from-static.md +++ b/docs/sources/flow/tasks/migrate/from-static.md @@ -376,8 +376,8 @@ The following list is specific to the convert command and not {{< param "PRODUCT [run]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/reference/cli/run.md" [Start]: "/docs/agent/ -> /docs/agent//flow/setup/start-agent.md" [Start]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/setup/start-agent.md" -[DebuggingUI]: "/docs/agent/ -> /docs/agent//flow/monitoring/debugging.md" -[DebuggingUI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging.md" +[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" @@ -396,6 +396,6 @@ The following list is specific to the convert command and not {{< param "PRODUCT [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/monitoring/debugging#grafana-agent-flow-ui" -[UI]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/monitoring/debugging#grafana-agent-flow-ui" +[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 %}} diff --git a/docs/sources/flow/tasks/monitor/_index.md b/docs/sources/flow/tasks/monitor/_index.md new file mode 100644 index 000000000000..ac23db26072c --- /dev/null +++ b/docs/sources/flow/tasks/monitor/_index.md @@ -0,0 +1,24 @@ +--- +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 +menuTitle: Monitor +weight: 110 +--- + +# How to monitor {{% param "PRODUCT_NAME" %}} + +This section details various ways to monitor and debug {{< param "PRODUCT_NAME" >}}. + +{{< section >}} diff --git a/docs/sources/flow/monitoring/component_metrics.md b/docs/sources/flow/tasks/monitor/component_metrics.md similarity index 75% rename from docs/sources/flow/monitoring/component_metrics.md rename to docs/sources/flow/tasks/monitor/component_metrics.md index 90c3769572c9..5b3693a1f182 100644 --- a/docs/sources/flow/monitoring/component_metrics.md +++ b/docs/sources/flow/tasks/monitor/component_metrics.md @@ -1,17 +1,24 @@ --- 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/ -- 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/ -description: Learn about component metrics -title: Component metrics +description: Learn how to monitor component metrics +title: Monitor components weight: 200 --- -# Component metrics +# How to monitor components {{< param "PRODUCT_NAME" >}} [components][] may optionally expose Prometheus metrics which can be used to investigate the behavior of that component. These component-specific metrics are only generated when an instance of that component is running. diff --git a/docs/sources/flow/monitoring/controller_metrics.md b/docs/sources/flow/tasks/monitor/controller_metrics.md similarity index 74% rename from docs/sources/flow/monitoring/controller_metrics.md rename to docs/sources/flow/tasks/monitor/controller_metrics.md index e0f17a2edba9..0ba7617032aa 100644 --- a/docs/sources/flow/monitoring/controller_metrics.md +++ b/docs/sources/flow/tasks/monitor/controller_metrics.md @@ -1,17 +1,24 @@ --- 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/ -- 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/ -description: Learn about controller metrics -title: Controller metrics +description: Learn how to monitor controller metrics +title: Monitor controller weight: 100 --- -# Controller metrics +# How to monitor controller The {{< param "PRODUCT_NAME" >}} [component controller][] exposes Prometheus metrics which you can use to investigate the controller state.