Disclaimer note for users in both Grafana and Prometheus how-tos #862
+9
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jasonviviano
changed the title
jonvsm
reviewed
Oct 18, 2023
docs/content/guides/operations/control-plane/metrics/grafana/index.md
Outdated
Show resolved
Hide resolved
jonvsm
reviewed
Oct 18, 2023
docs/content/guides/operations/control-plane/metrics/prometheus/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Jonathan Smith <[email protected]>
|
Issue to investigate further the How-To guide issues found: #918 |
AaronCrawfis
suggested changes
Oct 30, 2023
Comment on lines
+13
to
+16
| {{% alert color="primary" %}} | ||
| 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 %}} | ||
|
|
There was a problem hiding this comment.
Suggested change
| {{% alert color="primary" %}} | |
| 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 %}} |
Since the issue is in Prometheus we don't need to list the note on the Grafana guide
| @@ -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" %}} | |||
| 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. | |||
There was a problem hiding this comment.
Suggested change
| 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. | |
| This how-to article has been validated only on local Kubernetes clusters (_Docker Desktop, k3s_). If you run on other clusters please visit the [Prometheus docs](https://prometheus.io/) for help on setting up Prometheus. |
|
Just tested on AKS and everything works as expected. I think we can close this PR until we get reproduction steps of it not working |
|
Closing as not applicable. Please reopen if you hit any issues on cloud-based AKS clusters |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for helping make the Radius documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Auto-generated description
🤖 Generated by Copilot at 3d45744
Summary
🚨📊🌐
This pull request adds warning alerts to the Grafana and Prometheus guides, informing users of potential issues when running these tools in non-local clusters. The alerts also provide links to the official documentation of Grafana and Prometheus for troubleshooting.
Walkthrough
Issue reference
#860