Platform

List Cluster Events

Changed on

Required role: read or higher.

Retrieve a list of retained cluster monitor events ordered from most recent to least recent.

The returned events only have limited details, the full details can be retrieved using the GET /v0/cluster/events/<event-id> endpoint.

Cluster monitor events are collected at a periodic interval (every 10s), however only every 10 minutes or if the overall health changes, does it get inserted into the database (and thus, served by this endpoint). At most 1000 events are retained (newest first), and events older than 72h are deleted. The latest event, if it already exists, is never cleaned up.

get/v0/cluster/events

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Response

all_healthyboolean required

Whether every service was healthy when this event was recorded. Says nothing about the cluster now: for that, read stale alongside it or call GET /v0/cluster_healthz.

api_resources_infostring nullable
api_self_infostring nullable
api_status'InitialUnhealthy' | 'Unhealthy' | 'Healthy' required
compiler_resources_infostring nullable
compiler_self_infostring nullable
compiler_status'InitialUnhealthy' | 'Unhealthy' | 'Healthy' required
idstring uuid required

Cluster monitor event identifier.

recorded_atstring date-time required
runner_resources_infostring nullable
runner_self_infostring nullable
runner_status'InitialUnhealthy' | 'Unhealthy' | 'Healthy' required
staleboolean nullable

Whether the monitor stopped writing, making the statuses below the last recorded ones. Reported for the latest event only: older events are old by design.

Changes