From f22f88b85124716c817ae5747aeb8d1ab4f98fb9 Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Tue, 28 Nov 2023 16:26:35 -0800 Subject: [PATCH] Update monitoring topics --- docs/sources/flow/monitoring/_index.md | 4 +-- .../flow/monitoring/component_metrics.md | 6 ++-- .../flow/monitoring/controller_metrics.md | 6 ++-- docs/sources/flow/monitoring/debugging.md | 28 +++++++++---------- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/sources/flow/monitoring/_index.md b/docs/sources/flow/monitoring/_index.md index 184bd46b7a35..4f072dd64905 100644 --- a/docs/sources/flow/monitoring/_index.md +++ b/docs/sources/flow/monitoring/_index.md @@ -10,8 +10,8 @@ title: Monitoring Grafana Agent Flow weight: 500 --- -# Monitoring Grafana Agent Flow +# Monitoring {{< param "PRODUCT_NAME" >}} -This section details various ways to monitor and debug Grafana Agent Flow. +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/monitoring/component_metrics.md index f85a0440c21c..33c9d5c02e98 100644 --- a/docs/sources/flow/monitoring/component_metrics.md +++ b/docs/sources/flow/monitoring/component_metrics.md @@ -13,7 +13,7 @@ weight: 200 # Component metrics -Grafana Agent Flow [components][] may optionally expose Prometheus metrics +{{< 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. @@ -23,11 +23,11 @@ component is running. > component for observability, alerting, and debugging. Component-specific metrics are exposed at the `/metrics` HTTP endpoint of the -Grafana Agent HTTP server, which defaults to listening on +{{< 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 Grafana Agent listens on for HTTP traffic. +> modify the address {{< param "PRODUCT_NAME" >}} listens on for HTTP traffic. Component-specific metrics will have a `component_id` label matching the component ID generating those metrics. For example, component-specific metrics diff --git a/docs/sources/flow/monitoring/controller_metrics.md b/docs/sources/flow/monitoring/controller_metrics.md index 7aa08f097ef0..a785909d91fe 100644 --- a/docs/sources/flow/monitoring/controller_metrics.md +++ b/docs/sources/flow/monitoring/controller_metrics.md @@ -13,15 +13,15 @@ weight: 100 # Controller metrics -The Grafana Agent Flow [component controller][] exposes Prometheus metrics +The {{< param "PRODUCT_NAME" >}} [component controller][] exposes Prometheus metrics which can be used to investigate the controller state. Metrics for the controller are exposed at the `/metrics` HTTP endpoint of the -Grafana Agent HTTP server, which defaults to listening on +{{< 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 Grafana Agent listens on for HTTP +> describes how to modify the address {{< param "PRODUCT_NAME" >}} listens on for HTTP > traffic. The controller exposes the following metrics: diff --git a/docs/sources/flow/monitoring/debugging.md b/docs/sources/flow/monitoring/debugging.md index f5b634527e3a..3018e32837e6 100644 --- a/docs/sources/flow/monitoring/debugging.md +++ b/docs/sources/flow/monitoring/debugging.md @@ -12,29 +12,29 @@ weight: 300 # Debugging -Follow these steps to debug issues with Grafana Agent Flow: +Follow these steps to debug issues with {{< param "PRODUCT_NAME" >}}: -1. Use the Grafana Agent Flow UI to debug issues. -2. If the UI doesn't help with debugging an issue, logs can be examined +1. Use the {{< param "PRODUCT_NAME" >}} UI to debug issues. +2. If the {{< param "PRODUCT_NAME" >}} UI doesn't help with debugging an issue, logs can be examined instead. -## Grafana Agent Flow UI +## {{< param "PRODUCT_NAME" >}} UI -Grafana Agent Flow includes an embedded UI viewable from Grafana Agent's HTTP +{{< param "PRODUCT_NAME" >}} includes an embedded UI viewable from the {{< param "PRODUCT_NAME" >}} HTTP server, which defaults to listening at `http://localhost:12345`. -> **NOTE**: For security reasons, installations of Grafana Agent Flow on +> **NOTE**: For security reasons, installations of {{< param "PRODUCT_NAME" >}} on > non-containerized platforms default to listening on `localhost`. 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] -> Grafana Agent Flow. +> {{< param "PRODUCT_NAME" >}}. > -> If you are running a custom installation of Grafana Agent Flow, refer to the +> 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 Grafana Agent Flow. +> when running {{< param "PRODUCT_NAME" >}}. ### Home page @@ -46,7 +46,7 @@ their health. Click **View** on a row in the table to navigate to the [Component detail page](#component-detail-page) for that component. -Click the Grafana Agent logo to navigate back to the home page. +Click the {{< param "PRODUCT_ROOT_NAME" >}} logo to navigate back to the home page. ### Graph page @@ -91,13 +91,13 @@ To debug using the UI: ## Examining logs -Logs may also help debug issues with Grafana Agent Flow. +Logs may also help debug issues with {{< param "PRODUCT_NAME" >}}. To reduce logging noise, many components hide debugging info behind debug-level log lines. It is recommended that you configure the [`logging` block][logging] -to show debug-level log lines when debugging issues with Grafana Agent Flow. +to show debug-level log lines when debugging issues with {{< param "PRODUCT_NAME" >}}. -The location of Grafana Agent's logs is different based on how it is deployed. +The location of {{< param "PRODUCT_NAME" >}} logs is different based on how it is deployed. Refer to the [`logging` block][logging] page to see how to find logs for your system. @@ -124,7 +124,7 @@ check the logs for any reported name conflict events. - **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 Agent has been shut down. +terminating {{< param "PRODUCT_ROOT_NAME" >}} has been shut down. {{% docs/reference %}} [logging]: "/docs/agent/ -> /docs/agent//flow/reference/config-blocks/logging.md"