chore: add monitoring docs#220
Merged
openshift-merge-bot[bot] merged 3 commits intoredhat-developer:mainfrom Aug 19, 2025
Merged
chore: add monitoring docs#220openshift-merge-bot[bot] merged 3 commits intoredhat-developer:mainfrom
openshift-merge-bot[bot] merged 3 commits intoredhat-developer:mainfrom
Conversation
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
Reviewer's GuideThis PR introduces a new comprehensive monitoring guide for the RHDH Helm chart by adding a detailed docs/monitoring.md file, covering metrics setup on OpenShift and AKS with configuration examples, troubleshooting steps, and related references. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- The docs reference example ConfigMap YAMLs under
configuration_files/and anopenshift-metrics.pngimage, but those files aren’t added—please include them at the correct paths so users can follow the examples. - The doc alternates between calling the service “RHDH” and “Backstage”; please unify the naming throughout to avoid confusion.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The docs reference example ConfigMap YAMLs under `configuration_files/` and an `openshift-metrics.png` image, but those files aren’t added—please include them at the correct paths so users can follow the examples.
- The doc alternates between calling the service “RHDH” and “Backstage”; please unify the naming throughout to avoid confusion.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
|
gazarenkov
approved these changes
Aug 19, 2025
7df857c
into
redhat-developer:main
8 checks passed
5 tasks
This file contains hidden or 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
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.



Description of the change
Note: we are moving the rhdh-chart specific monitoring documentation from the rhdh repo https://github.com/redhat-developer/rhdh/blob/main/docs/monitoring-and-logging.md into the rhdh-chart repo
Which issue(s) does this PR fix or relate to
https://issues.redhat.com/browse/RHIDP-8119
How to test changes / Special notes to the reviewer
Checklist
Chart.yamlaccording to Semantic Versioning.values.yamland added to the corresponding README.md. The pre-commit utility can be used to generate the necessary content. Usepre-commit run -ato apply changes. The pre-commit Workflow will do this automatically for you if needed.pre-commithook.ct lintcommand.Summary by Sourcery
Move and expand the RHDH monitoring documentation into the Helm chart repository, providing a comprehensive guide to enable and troubleshoot metrics collection on OpenShift and AKS.
Enhancements:
Documentation: