Skip to content

Commit 1195390

Browse files
authored
docs: metrics docs update (#3258)
* docs: metrics docs update Signed-off-by: Attila Mészáros <[email protected]> * wip Signed-off-by: Attila Mészáros <[email protected]> * fix table format Signed-off-by: Attila Mészáros <[email protected]> * wip Signed-off-by: Attila Mészáros <[email protected]> --------- Signed-off-by: Attila Mészáros <[email protected]>
1 parent c0eb78f commit 1195390

2 files changed

Lines changed: 11 additions & 12 deletions

File tree

docs/content/en/docs/documentation/observability.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -113,17 +113,17 @@ Metrics metrics = MicrometerMetricsV2.newBuilder(registry)
113113
All meters use `controller.name` as their primary tag. Counters optionally carry a `namespace` tag when
114114
`withNamespaceAsTag()` is enabled.
115115

116-
| Meter name (Micrometer) | Type | Tags | Description |
117-
|--------------------------------------|---------|---------------------------------------------------|------------------------------------------------------------------|
118-
| `reconciliations.active` | gauge | `controller.name` | Number of reconciler executions currently executing |
119-
| `reconciliations.queue` | gauge | `controller.name` | Number of resources currently queued for reconciliation |
120-
| `custom_resources` | gauge | `controller.name` | Number of custom resources tracked by the controller |
121-
| `reconciliations.execution.duration` | timer | `controller.name` | Reconciliation execution duration with explicit bucket histogram |
122-
| `reconciliations.started.total` | counter | `controller.name`, `namespace`* | Number of reconciliations started (including retries) |
123-
| `reconciliations.success.total` | counter | `controller.name`, `namespace`* | Number of successfully finished reconciliations |
124-
| `reconciliations.failure.total` | counter | `controller.name`, `namespace`* | Number of failed reconciliations |
125-
| `reconciliations.retries.total` | counter | `controller.name`, `namespace`* | Number of reconciliation retries |
126-
| `events.received` | counter | `controller.name`, `event`, `action`, `namespace` | Number of Kubernetes events received by the controller |
116+
| Meter name (Micrometer) | Type | Tags | Description |
117+
|--------------------------------------|---------|----------------------------------------------------|------------------------------------------------------------------|
118+
| `reconciliations.active` | gauge | `controller.name` | Number of reconciler executions currently executing |
119+
| `reconciliations.queue` | gauge | `controller.name` | Number of resources currently queued for reconciliation |
120+
| `custom_resources` | gauge | `controller.name` | Number of custom resources tracked by the controller |
121+
| `reconciliations.execution.duration` | timer | `controller.name` | Reconciliation execution duration with explicit bucket histogram |
122+
| `reconciliations.started.total` | counter | `controller.name`, `namespace`* | Number of reconciliations started (including retries) |
123+
| `reconciliations.success.total` | counter | `controller.name`, `namespace`* | Number of successfully finished reconciliations |
124+
| `reconciliations.failure.total` | counter | `controller.name`, `namespace`* | Number of failed reconciliations |
125+
| `reconciliations.retries.total` | counter | `controller.name`, `namespace`* | Number of reconciliation retries |
126+
| `events.received` | counter | `controller.name`, `event`, `action`, `namespace`* | Number of events received by the controller |
127127

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

sample-operators/metrics-processing/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,6 @@ private void assertMetricPresent(
260260
log.info("{}: {}", query, result);
261261
assertThat(result).contains("\"status\":\"success\"");
262262
for (String expected : expectedSubstrings) {
263-
log.info("Checking if result: {} contains expected: {}", result, expected);
264263
assertThat(result).contains(expected);
265264
}
266265
});

0 commit comments

Comments
 (0)