docs: improve metrics and health probes docs#3333
Merged
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 operations documentation to better separate health-probe guidance from metrics guidance, and to improve the structure and discoverability of metrics-related topics.
Changes:
- Removes the
RuntimeInfoliveness/readiness probe discussion from the metrics page and consolidates probe-related references in the health probes page. - Promotes the Grafana dashboard and end-to-end metrics exploration sections to higher-level headings.
- Moves the “Aggregated Metrics” section earlier in the metrics page to make multi-provider setups easier to find.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/content/en/docs/documentation/operations/metrics.md | Reorganizes metrics documentation structure, promotes dashboard/E2E sections, and relocates “Aggregated Metrics” content. |
| docs/content/en/docs/documentation/operations/health-probes.md | Adds a cross-reference to ConfigurationService.stopOnInformerErrorDuringStartup from the RuntimeInfo-based probe guidance. |
|
|
||
| ```java | ||
| // create individual metrics instances | ||
| Metrics micrometerMetrics = MicrometerMetrics.withoutPerResourceMetrics(registry); |
Comment on lines
+107
to
+113
| ### Aggregated Metrics | ||
|
|
||
| The `AggregatedMetrics` class provides a way to combine multiple metrics providers into a single metrics instance using | ||
| the composite pattern. This is particularly useful when you want to simultaneously collect metrics data from different | ||
| monitoring systems or providers. | ||
|
|
||
| You can create an `AggregatedMetrics` instance by providing a list of existing metrics implementations: |
| case as well. Once running, it detects runtime degradation such as a lost watch connection. | ||
|
|
||
| See also: | ||
| [ConfigurationService.stopOnInformerErrorDuringStartup](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java#L287) |
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.
Signed-off-by: Attila Mészáros a_meszaros@apple.com