> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Alert Configuration

> Create and manage threshold-based system health alerts with enable/disable and edit controls.

The Alert Configuration screen manages system health alert rules at the route `/settings/system-health/alerts`.

## Overview

The screen lists existing health alert configurations via `AlertConfigList`, which supports editing, deleting, and toggling active status. A slide-over sheet opens `AlertConfigForm` for creating or editing individual alerts. A "View History" link navigates to the Alert History page (`/settings/system-health/alerts/history`). All operations are managed through the `useAlertConfigs` hook.

## Who it's for

Required permission: `platform.system_health.manage`

## Before you start

* You must hold the `platform.system_health.manage` permission.
* System Health must be accessible from the Settings sidebar.

## Steps

<Steps>
  <Step title="Open Alert Configuration">Navigate to Settings → System Health → Alert Configuration.</Step>
  <Step title="Review existing alerts">Browse the list of configured alerts and their active/inactive status.</Step>
  <Step title="Create a new alert">Click "Create Alert" to open the slide-over form and define threshold and target.</Step>
  <Step title="Edit an alert">Click the edit action on any alert to modify its configuration.</Step>
  <Step title="Toggle active status">Use the toggle to enable or disable an alert without deleting it.</Step>
  <Step title="View alert history">Click "View History" to navigate to the triggered alerts log.</Step>
</Steps>

## Key concepts

* Threshold-based alerts — fire when a monitored metric crosses a configured boundary
* Active/inactive — alerts can be disabled without deletion
* Evaluation window — the rolling time range over which the metric is averaged before comparison
* Cooldown — minimum time between repeat notifications for the same rule

## Platform default backend alerts

Encore OS ships with three platform-managed health alerts that watch the backend processing pipeline. A backend health-metric feeder collects the underlying gauges every 5 minutes, the platform evaluates each alert against a 15-minute rolling window, and matches deliver an in-app notification with a 60-minute cooldown.

| Default alert          | Metric              | Fires when                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------ |
| DLQ depth > 0          | `fw_dlq_depth`      | Any item is sitting in the workflow dead-letter queue        |
| Domain-event lag > 100 | `domain_event_lag`  | More than 100 domain events are awaiting processing          |
| Edge errors > 10 / 15m | `edge_errors_count` | More than 10 edge-function errors are recorded in 15 minutes |

These defaults appear in the alert list for every organization but are not editable — they are maintained by the platform. Add your own organization-scoped alerts alongside them for application-level metrics.

## Related

<Columns cols={2}>
  <Card title="Platform Foundation" icon="layer-group" href="/pf/overview">
    Platform Foundation overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index">
    Documentation coverage and governance.
  </Card>
</Columns>

<Note>
  This page documents shipped product behavior. It is not medical, legal, or
  billing advice. Verify against your organization's policies and applicable
  regulations before using it for clinical, compliance, or billing decisions.
  Protected health information (PHI) shown in the product is governed by your
  tenant's access controls and is never exposed in this documentation.
</Note>

<Accordion title="Documentation sources">
  * src/routes/platform.tsx
  * src/platform/health/pages/AlertConfigPage.tsx
</Accordion>
