Flow Health

Reference for incident and digest CLI surfaces.

Quick Answer

Use this page when you are operating flow-health incidents, inspecting digest
artifacts, or changing your scheduled digest cadence.

Incident Commands

breyta incidents list --status open
breyta incidents show <incident-id>
breyta incidents lanes <incident-id>
breyta incidents acknowledge <incident-id>
breyta incidents snooze <incident-id> --for 2h
breyta incidents suppress <incident-id>

Use incidents when you need to inspect surfaced failures and change operator
disposition without claiming the issue has recovered.

Digest Commands

breyta digests list --kind scheduled --cadence weekly
breyta digests show <digest-id>
breyta digests deliveries <digest-id>
breyta digests mark-read <digest-id>

Use digests when you need summary artifacts, incident rollups, or
per-recipient delivery state.

Cadence Commands

breyta digests cadence
breyta digests cadence set monthly

• breyta digests cadence updates your own delivery settings for the current
  workspace.
• It does not change delivery settings for other workspace members.

Delivery Notes

• Flow-health incidents and digests are available to workspace creators/admins.
• In-app flow-health updates are enabled by default for your account.
• Email flow-health updates are opt-in for your account.
• Scheduled digests follow the selected daily, weekly, or monthly
  cadence. weekly is the default.
• Scheduled digests summarize surfaced incident changes from the previous
  cadence window.
• If there are no surfaced changes in that window, no scheduled digest is sent.
• Urgent incident emails are delivered as soon as possible.
• Urgent emails are not held for the next scheduled digest window.

Related

• CLI Commands
• CLI Workflow
• CLI Essentials