Class KubernetesPodRestartsCheck

java.lang.Object

com.kingsrook.qqq.backend.core.health.KubernetesPodRestartsCheck

All Implemented Interfaces:

HealthCheck

public class KubernetesPodRestartsCheck
extends Object
implements HealthCheck

Container restarts of this application's pods, read from the Kubernetes API, so a crash (OutOfMemoryError, OOMKilled) or a crash loop shows on the System Health page and raises the standard health.check.* alerts. Opt-in: registered only when QQQ_HEALTH_POD_RESTARTS_SELECTOR (a label selector such as "app in (website-backend,website-backend-worker)") is set and a service account token is mounted. The pod's service account needs get/list on pods in its namespace. DOWN: a container is in CrashLoopBackOff. DEGRADED: a container's last termination finished inside the window (QQQ_HEALTH_POD_RESTARTS_WINDOW_MINUTES, default 60), with its cause: JVM out of memory (exit 3), OOMKilled, or the exit code. A DEPENDENCY check: it never affects /ready or /live.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KubernetesPodRestartsCheck.Fetcher	Reads the pod list JSON (a seam for tests).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
KubernetesPodRestartsCheck(String selector, Duration window, KubernetesPodRestartsCheck.Fetcher fetcher, Clock clock)	Constructor.

Method Summary

Modifier and Type	Method	Description
static HealthCheckMetaData	definitionFromEnvironment(QMetaDataVariableInterpreter interpreter)	The registration when this process runs in Kubernetes and the host opted in; null otherwise.
HealthCheckOutcome	run(HealthCheckInput input)	Evaluate the pod list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

KubernetesPodRestartsCheck

public KubernetesPodRestartsCheck(String selector,
 Duration window,
 KubernetesPodRestartsCheck.Fetcher fetcher,
 Clock clock)

Constructor.

Method Details

definitionFromEnvironment

public static HealthCheckMetaData definitionFromEnvironment(QMetaDataVariableInterpreter interpreter)

The registration when this process runs in Kubernetes and the host opted in; null otherwise.

run

public HealthCheckOutcome run(HealthCheckInput input)

Evaluate the pod list.

Specified by:

run in interface HealthCheck