docs: metrics docs update#3258
Merged
csviri merged 4 commits intooperator-framework:mainfrom Mar 27, 2026
Merged
Conversation
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the observability documentation around MicrometerMetricsV2 metric listings and slightly reduces noise in the metrics E2E test output.
Changes:
- Adjusts the MicrometerMetricsV2 metrics table formatting/content in the observability docs.
- Removes a per-assertion log line from the Prometheus metric presence assertion loop in the E2E test.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sample-operators/metrics-processing/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java | Removes a verbose log statement during metric substring assertions. |
| docs/content/en/docs/documentation/observability.md | Re-formats/updates the MicrometerMetricsV2 metrics table in the docs. |
| | `reconciliations.success.total` | counter | `controller.name`, `namespace`* | Number of successfully finished reconciliations | | ||
| | `reconciliations.failure.total` | counter | `controller.name`, `namespace`* | Number of failed reconciliations | | ||
| | `reconciliations.retries.total` | counter | `controller.name`, `namespace`* | Number of reconciliation retries | | ||
| | `events.received` | counter | `controller.name`, `event`, `action`, `namespace`* | Number of events received by the controller | |
There was a problem hiding this comment.
This table row has noticeable extra padding/trailing whitespace in the cells (especially the description column). It makes future diffs noisy and can cause markdown lint failures if enabled; please trim the extra spaces so the row content is clean.
Suggested change
| | `events.received` | counter | `controller.name`, `event`, `action`, `namespace`* | Number of events received by the controller | | |
| | `events.received` | counter | `controller.name`, `event`, `action`, `namespace`* | Number of events received by the controller | |
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
metacosm
approved these changes
Mar 27, 2026
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.
also removes a unnecessary log message from e2e