Skip to content

docs: metrics docs update #3258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csviri merged 4 commits into from
Mar 27, 2026
Merged

docs: metrics docs update #3258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2479f2
docs: metrics docs update
csviri Mar 27, 2026
301e630
wip
csviri Mar 27, 2026
8305515
fix table format
csviri Mar 27, 2026
bb1d48b
wip
csviri Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/content/en/docs/documentation/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,17 @@ Metrics metrics = MicrometerMetricsV2.newBuilder(registry)
All meters use `controller.name` as their primary tag. Counters optionally carry a `namespace` tag when
`withNamespaceAsTag()` is enabled.

| Meter name (Micrometer) | Type | Tags | Description |
|--------------------------------------|---------|---------------------------------------------------|------------------------------------------------------------------|
| `reconciliations.active` | gauge | `controller.name` | Number of reconciler executions currently executing |
| `reconciliations.queue` | gauge | `controller.name` | Number of resources currently queued for reconciliation |
| `custom_resources` | gauge | `controller.name` | Number of custom resources tracked by the controller |
| `reconciliations.execution.duration` | timer | `controller.name` | Reconciliation execution duration with explicit bucket histogram |
| `reconciliations.started.total` | counter | `controller.name`, `namespace`* | Number of reconciliations started (including retries) |
| `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 Kubernetes events received by the controller |
| Meter name (Micrometer) | Type | Tags | Description |
|--------------------------------------|---------|----------------------------------------------------|------------------------------------------------------------------|
| `reconciliations.active` | gauge | `controller.name` | Number of reconciler executions currently executing |
| `reconciliations.queue` | gauge | `controller.name` | Number of resources currently queued for reconciliation |
| `custom_resources` | gauge | `controller.name` | Number of custom resources tracked by the controller |
| `reconciliations.execution.duration` | timer | `controller.name` | Reconciliation execution duration with explicit bucket histogram |
| `reconciliations.started.total` | counter | `controller.name`, `namespace`* | Number of reconciliations started (including retries) |
| `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 |

\* `namespace` tag is only included when `withNamespaceAsTag()` is enabled.

Expand Down
1 change: 0 additions & 1 deletion ...ocessing/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,6 @@ private void assertMetricPresent(
log.info("{}: {}", query, result);
assertThat(result).contains("\"status\":\"success\"");
for (String expected : expectedSubstrings) {
log.info("Checking if result: {} contains expected: {}", result, expected);
assertThat(result).contains(expected);
}
});
Expand Down
Loading