Skip to content

Commit a42d91f

Browse files
committed
wip
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
1 parent 6763762 commit a42d91f

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/content/en/docs/documentation/operations/health-probes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ API.
1717
| `isStarted()` | `true` once the operator and all its controllers have fully started |
1818
| `allEventSourcesAreHealthy()` | `true` when every registered event source (informers, polling sources, etc.) reports a healthy status |
1919
| `unhealthyEventSources()` | returns a map of controller name → unhealthy event sources, useful for diagnostics |
20-
| `unhealthyInformerWrappingEventSourceHealthIndicator()` | returns a map of controller name → unhealthy informer-wrapping event sources, each exposing per-informer details via `InformerHealthIndicator` (`hasSynced()`, `isWatching()`, `isRunning()`, `getTargetNamespace()`) |
20+
| `unhealthyInformerWrappingEventSourceHealthIndicator()` | returns a map of controller name → unhealthy informer-wrapping event sources, each exposing per-informer details via `InformerHealthIndicator` (`hasSynced()`, `isRunning()`, `getTargetNamespace()`) |
2121

2222
In most cases a single readiness probe backed by `allEventSourcesAreHealthy()` is sufficient: before the
2323
operator has fully started the informers will not have synced yet, so the check naturally covers the startup
@@ -27,7 +27,7 @@ case as well. Once running, it detects runtime degradation such as a lost watch
2727

2828
For advanced use cases — such as exposing per-informer health in a diagnostic endpoint or logging which
2929
specific namespace lost its watch — `unhealthyInformerWrappingEventSourceHealthIndicator()` gives access to
30-
individual `InformerHealthIndicator` instances. Each indicator exposes `hasSynced()`, `isWatching()`,
30+
individual `InformerHealthIndicator` instances. Each indicator exposes `hasSynced()`,
3131
`isRunning()`, and `getTargetNamespace()`. This is typically not needed for a standard health probe but can
3232
be valuable for operational dashboards or troubleshooting.
3333

0 commit comments

Comments
 (0)