Skip to content

chore: add monitoring docs#220

Merged
openshift-merge-bot[bot] merged 3 commits intoredhat-developer:mainfrom
Fortune-Ndlovu:add-monitoring-docs
Aug 19, 2025
Merged

chore: add monitoring docs#220
openshift-merge-bot[bot] merged 3 commits intoredhat-developer:mainfrom
Fortune-Ndlovu:add-monitoring-docs

Conversation

@Fortune-Ndlovu
Copy link
Copy Markdown
Member

@Fortune-Ndlovu Fortune-Ndlovu commented Aug 17, 2025

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

  • For each Chart updated, version bumped in the corresponding Chart.yaml according to Semantic Versioning.
  • For each Chart updated, variables are documented in the values.yaml and added to the corresponding README.md. The pre-commit utility can be used to generate the necessary content. Use pre-commit run -a to apply changes. The pre-commit Workflow will do this automatically for you if needed.
  • JSON Schema template updated and re-generated the raw schema via the pre-commit hook.
  • Tests pass using the Chart Testing tool and the ct lint command.
  • If you updated the orchestrator-infra chart, make sure the versions of the Knative CRDs are aligned with the versions of the CRDs installed by the OpenShift Serverless operators declared in the values.yaml file. See Installing Knative Eventing and Knative Serving CRDs for more details.

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:

  • Move the monitoring guide from the main rhdh repository into the rhdh-chart repository.

Documentation:

  • Add a monitoring guide detailing how to configure and enable metrics collection for the RHDH Helm chart on OpenShift and AKS with ServiceMonitor and pod annotations.
  • Provide configuration examples, troubleshooting steps, and links to related documentation for metrics monitoring.

Signed-off-by: Fortune-Ndlovu <fndlovu@redhat.com>
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Aug 17, 2025

Reviewer's Guide

This 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

Change Details Files
Add comprehensive monitoring documentation
  • Create docs/monitoring.md with metrics monitoring overview and prerequisites
  • Document OpenShift ServiceMonitor setup and Helm values.yaml snippet
  • Document AKS pod annotations and Azure Monitor add-on configurations
  • Provide full values.yaml examples for OpenShift and AKS
  • Include troubleshooting steps and related documentation links
docs/monitoring.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@openshift-ci openshift-ci Bot requested review from gazarenkov and zdrapela August 17, 2025 13:09
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes - here's some feedback:

  • 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.
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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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>
@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@openshift-ci openshift-ci Bot added the lgtm label Aug 19, 2025
@openshift-merge-bot openshift-merge-bot Bot merged commit 7df857c into redhat-developer:main Aug 19, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants