get_cluster_system_events
Retrieve the cluster system event log for root cause analysis: find config changes, failovers, rebalances, or service restarts before a symptom; use since_time to window events.
Instructions
Get the cluster's system event log — what changed on the cluster, and when.
This is the RCA timeline: once a symptom is confirmed, it finds the config change, failover, rebalance or service restart that preceded it. Window it to the symptom's onset with since_time, then cross-check that timestamp against get_cluster_metrics.
Self-managed Couchbase Server 7.6+ only (Capella is rejected without a REST call); needs the Full Admin or Cluster Admin role. Calls GET /events.
Ordering — easy to misread:
Events are ALWAYS oldest-first, but which ones the server picks depends on since_time. Without it, the server takes the
limitMOST RECENT events, so the last element is the newest thing on the cluster. With it, it takes thelimitEARLIEST events at or after that time, so the last element is NOT the newest — more may follow it.Do not re-sort or re-slice to get "the latest N": slicing keeps the oldest. Lower
limitand let the server choose.To page forward, pass summary.next_since_time as the next since_time. It is inclusive, so the boundary event repeats — dedupe on uuid. When it is null on a truncated result, check summary.paging_blocked: every event in the batch shares one timestamp, so sinceTime cannot move past them and a higher limit is the only way to see the rest.
A cluster's log is overwhelmingly "info", so expect routine entries in the window; move
the window rather than raising limit.
Reading the result:
summary.by_severity / by_component say what the window holds at a glance, so a lone "error" among routine entries is visible without reading every event.
summary.possibly_truncated means the server filled the limit, so more events probably exist outside the window. Absence of a later event is not evidence.
The log is a ring buffer (10,000 entries by default), so an empty result for an old since_time can mean the events aged out, not that nothing happened.
Returns {"summary": {...}, "events": [...]}; raises on failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| timeout | No | ||
| since_time | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||