From 3d45744c8d1f2662941c3c1ffe52b825e65f8f15 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 17 Oct 2023 17:04:47 +0000 Subject: [PATCH 1/2] Adding warning labels to metric how-tos --- .../guides/operations/control-plane/metrics/grafana/index.md | 4 ++++ .../operations/control-plane/metrics/prometheus/index.md | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/docs/content/guides/operations/control-plane/metrics/grafana/index.md b/docs/content/guides/operations/control-plane/metrics/grafana/index.md index 8fb41126d..464187fa9 100644 --- a/docs/content/guides/operations/control-plane/metrics/grafana/index.md +++ b/docs/content/guides/operations/control-plane/metrics/grafana/index.md @@ -10,6 +10,10 @@ tags: ["metrics", "observability"] [Grafana](https://grafana.com/) is an open source visualization and analytics tool that allows you to query, visualize, alert on, and explore your metrics. This guide will show you how to install Grafana and configure it to visualize the Radius control plane metrics from Prometheus. +{{% alert color="primary" %}} +Users may experience issues when running in non-local clusters, please take a look at the official [Grafana](https://grafana.com/) docs for help on debugging. +{{% /alert %}} + ## Example dashboards There are two example dashboards that you can import into Grafana to quickly get started visualizing your metrics and then customize them to meet your needs. diff --git a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md b/docs/content/guides/operations/control-plane/metrics/prometheus/index.md index 660b4e91f..6919f9ef4 100644 --- a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md +++ b/docs/content/guides/operations/control-plane/metrics/prometheus/index.md @@ -10,6 +10,11 @@ tags: ["metrics", "observability"] [Prometheus](https://prometheus.io/) collects and stores metrics as time series data. This guide will show you how to collect Radius control plane metrics to then be visualized and queried. + +{{% alert color="primary" %}} +Users may experience issues when running in non-local clusters, please take a look at the official [Prometheus](https://prometheus.io/) docs for help on debugging. +{{% /alert %}} + ## Install Prometheus on Kubernetes 1. Make sure you have the following pre-requisites: From 1f969e2fef9199c2fb47511aa1fe461793849703 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Fri, 27 Oct 2023 11:09:41 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Jonathan Smith --- .../guides/operations/control-plane/metrics/grafana/index.md | 2 +- .../guides/operations/control-plane/metrics/prometheus/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/guides/operations/control-plane/metrics/grafana/index.md b/docs/content/guides/operations/control-plane/metrics/grafana/index.md index 464187fa9..4be918627 100644 --- a/docs/content/guides/operations/control-plane/metrics/grafana/index.md +++ b/docs/content/guides/operations/control-plane/metrics/grafana/index.md @@ -11,7 +11,7 @@ tags: ["metrics", "observability"] [Grafana](https://grafana.com/) is an open source visualization and analytics tool that allows you to query, visualize, alert on, and explore your metrics. This guide will show you how to install Grafana and configure it to visualize the Radius control plane metrics from Prometheus. {{% alert color="primary" %}} -Users may experience issues when running in non-local clusters, please take a look at the official [Grafana](https://grafana.com/) docs for help on debugging. +This how-to article has been validated only on a local Kubernetes cluster. If you test in other configurations and have questions, please review [Grafana](https://grafana.com/). {{% /alert %}} ## Example dashboards diff --git a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md b/docs/content/guides/operations/control-plane/metrics/prometheus/index.md index 6919f9ef4..04b95a41d 100644 --- a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md +++ b/docs/content/guides/operations/control-plane/metrics/prometheus/index.md @@ -12,7 +12,7 @@ tags: ["metrics", "observability"] {{% alert color="primary" %}} -Users may experience issues when running in non-local clusters, please take a look at the official [Prometheus](https://prometheus.io/) docs for help on debugging. +This how-to article has been validated only on a local Kubernetes cluster. If you test in other configurations and have questions, please review [Prometheus](https://prometheus.io/) docs for help on debugging. {{% /alert %}} ## Install Prometheus on Kubernetes