docs: Update monitoring procedures for automated Prometheus resource management#3106
docs: Update monitoring procedures for automated Prometheus resource management#3106tolusha wants to merge 2 commits into
Conversation
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
⚡️ Deploying pull request preview... |
Signed-off-by: Anatolii Bazko <abazko@redhat.com>
tolusha
force-pushed
the
docs-che-operator-2117-automated-prometheus
branch
from
ea903f0 to
d65847a
Compare
tolusha
requested review from
a team,
deerskindoll,
gtrivedi88 and
mkuznyetsov
as code owners
|
@gtrivedi88 |
| ---- | ||
| $ oc label namespace {prod-namespace} openshift.io/cluster-monitoring=true | ||
| ---- | ||
| The {prod-operator} automatically creates the required Prometheus resources (ServiceMonitor, Role, and RoleBinding) and configures {orch-namespace} labeling for monitoring {prod-short} Server JVM metrics. |
There was a problem hiding this comment.
CQA P6/P7 — Content type mismatch. This file has a proc_ prefix but after this PR it contains zero procedure steps — no .Prerequisites, no .Procedure section. It's now a concept description with a verification section.
Options:
- (a) Recommended: Rename to
con_prefix, add:page-aliases:for the old URL. - (b) Restructure as a thin procedure with a single verification-focused step.
- (c) Fold into the parent monitoring assembly if standalone modules aren't warranted.
Also: the title "Collecting...metrics with Prometheus" implies active user action. Consider "Verifying {prod-short} Server metrics collection with Prometheus" or "Monitoring {prod-short} Server metrics with Prometheus" to match the JTBD (the user's job is now verifying, not collecting).
| $ oc label namespace {prod-namespace} openshift.io/cluster-monitoring=true | ||
| ---- | ||
| The {prod-operator} automatically creates the required Prometheus resources (ServiceMonitor, Role, and RoleBinding) and configures {orch-namespace} labeling for monitoring {prod-short} Server JVM metrics. | ||
| No manual configuration is required. The operator reconciles these resources automatically. |
There was a problem hiding this comment.
CQA P10 — Missing [role="_abstract"]. The second file has [role="_abstract"] but this one does not. Add it, and rewrite as a JTBD WHY-first abstract. For example:
[role="_abstract"]
The {prod-operator} automatically creates and reconciles the required Prometheus resources (ServiceMonitor, Role, and RoleBinding) and configures namespace labeling. No manual configuration is required to monitor {prod-short} Server JVM metrics.Also consider extracting the shared body text into a snippet (snip_) — both files now have near-identical wording.
| ---- | ||
| $ oc label namespace {prod-namespace} openshift.io/cluster-monitoring=true | ||
| ---- | ||
| The {prod-operator} automatically creates the required Prometheus resources (ServiceMonitor, Role, and RoleBinding) and configures {orch-namespace} labeling for monitoring the {devworkspace} Operator. |
There was a problem hiding this comment.
CQA P6 — Orphaned snippet. This file previously included:
include::example$snip_{project-context}-create-a-role-and-rolebinding-for-prometheus-to-view-metrics.adoc[]
That include is now removed, which is correct. But the snippet file itself (snip_che-create-a-role-and-rolebinding-for-prometheus-to-view-metrics.adoc) still exists in the repo. If no other file references it, delete it in this PR to avoid dead content.
Also same structural issues as the other file: proc_ prefix but no procedure steps — consider converting to con_ concept module with :page-aliases: redirect.
| $ oc label namespace {prod-namespace} openshift.io/cluster-monitoring=true | ||
| ---- | ||
| The {prod-operator} automatically creates the required Prometheus resources (ServiceMonitor, Role, and RoleBinding) and configures {orch-namespace} labeling for monitoring the {devworkspace} Operator. | ||
| No manual configuration is required. The operator reconciles these resources automatically. |
There was a problem hiding this comment.
CQA Q13 — Pre-existing: [source,yaml] on shell commands. The Verification section in both files uses [source,yaml] for oc commands. Since you're touching these files, please fix to [source,terminal,subs="+quotes"] for the two shell command blocks in each file.
Signed-off-by: Anatolii Bazko <abazko@redhat.com>
|
@gtrivedi88 |
2 participants
What does this pull request change?
Updated the {prod-short} Server and {devworkspace} Operator monitoring procedures to reflect that the che-operator now automatically creates and manages all required Prometheus resources (ServiceMonitor, Role, RoleBinding) and namespace labeling.
Changes:
Related PR: eclipse-che/che-operator#2117
The che-operator PR #2117 introduces a new metrics package that automatically manages Prometheus resources for monitoring Eclipse Che Server and the DevWorkspace Operator, eliminating the need for manual configuration previously described in the documentation.
What issues does this pull request fix or reference?
eclipse-che/che-operator#2117
Specify the version of the product this pull request applies to
next
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.