Notifications (Slack / PagerDuty / webhook)
The top-level notifications: block fans pipeline lifecycle and health
events out to Slack, PagerDuty, or a generic signed webhook — so a failure,
SLA breach, or tripped circuit breaker reaches your team without you having to
stand up Prometheus + Alertmanager first.
It is fully opt-in and requires the notify build feature — included in the
prebuilt binaries; from crates.io, cargo install faucet-cli --features notify
(or --features full). With no
block, nothing changes.
Events
Section titled “Events”| Event | Fires when | Severity |
|---|---|---|
run_failure |
a run (or its final flush) failed — a rule on run_failure also hears circuit_open, contract_abort and budget_exceeded, which are run failures too |
error |
run_success |
a run completed successfully | info |
sla_breach |
a post-run SLA check was violated (staleness / min_rows / volume) | warning |
circuit_open |
the resilience circuit breaker tripped | critical |
contract_abort |
a data-contract breach aborted the run (on_breach: fail) |
error |
dlq_threshold |
a run routed rows to the DLQ at/over the rule’s threshold | warning |
scheduler_stuck |
faucet schedule is exiting on consecutive failures |
critical |
profile_drift |
a column’s learned profile drifted from its baseline (profiling.on_drift: notify or fail) — one event per finding |
warning |
change_requested |
a change request awaits approval — sent through the proposed config’s own notifications: rules |
info |
budget_exceeded |
a run crossed a budget: ceiling and was stopped |
error |
connection_needs_reauth |
a tenant connection’s token endpoint revoked its credentials (faucet serve with tenants) — sent through the tenant’s notifications: |
error |
log_export_failed |
a run’s log export kept failing past notify_after_secs, or buffered lines were dropped before delivery |
warning |
Events fire from every runtime — faucet run, faucet schedule,
faucet serve, and faucet mirror — because the emit sites live in the
shared executor (plus the scheduler’s scheduler_stuck signal). They are
scoped to real, whole-pipeline root runs: --dry-run, --limit, sharded,
and cancelled runs do not notify.
A rule
Section titled “A rule”Each entry in the list is one rule: which events (on:), an optional severity
floor, an optional coalesce window, and one delivery channel:. The channel
uses the project-wide adjacently-tagged { type, config } shape — the same
shape as connector auth:.
notifications: - name: oncall-pagerduty on: [run_failure, circuit_open, contract_abort, scheduler_stuck] channel: type: pagerduty config: routing_key: "${env:PAGERDUTY_ROUTING_KEY}"
- name: slack-alerts on: [run_failure, sla_breach, dlq_threshold] dedupe_window_secs: 300 # coalesce repeats within 5 minutes channel: type: slack config: webhook_url: "${env:SLACK_WEBHOOK_URL}" channel: "#data-alerts"
- name: internal-webhook min_severity: warning # info | warning | error | critical # empty `on:` = every event kind channel: type: webhook config: url: "https://ops.internal.example.com/hooks/faucet" hmac_secret: "${env:FAUCET_WEBHOOK_SECRET}"Fields
Section titled “Fields”| Field | Meaning |
|---|---|
name |
Unique rule name (metric label, dedupe key, logs). |
on |
Event kinds to fire on. Empty = all kinds. |
min_severity |
Only deliver events at/above this severity. Default info. |
dedupe_window_secs |
Leading-edge coalesce: drop an identical event (same rule + pipeline + row) within this window. Absent / 0 = no coalescing. |
dlq_threshold |
For dlq_threshold only: minimum DLQ rows before firing. Default 1. |
channel |
The delivery channel — { type, config }. |
Channels
Section titled “Channels”channel: type: slack config: webhook_url: "${env:SLACK_WEBHOOK_URL}" # incoming-webhook URL channel: "#alerts" # optional override username: "faucet" # optional overridePagerDuty
Section titled “PagerDuty”Uses the Events API v2. A failure-class event (run_failure,
circuit_open, contract_abort, budget_exceeded) opens one incident per
pipeline/row (dedup key <pipeline>:<row>); any other kind (sla_breach,
dlq_threshold, profile_drift, …) opens its own incident, keyed by kind
(<kind>:<pipeline>:<row>), so a warning never merges into a failure. The next
run_success on the same pipeline/row sends a matching resolve for each of
them this process opened, so incidents self-close. For the incidents a success
actually answers — the failure-class one and sla_breach — the resolve does not
depend on the process that saw the failure: a success resolves those keys when
the rule’s on: admits them (PagerDuty ignores a resolve with nothing open), so
incidents opened by an earlier faucet run or another serve run close too.
A success that itself reports an SLA breach (a row below min_rows_per_run, a
volume anomaly) leaves the sla_breach incident open; the first success without
a breach resolves it.
Other kinds (profile_drift, change_requested, …) are closed by the process
that opened them or by hand. The resolves for one success go out in parallel. dedupe_window_secs coalesces within one process only — PagerDuty
itself folds repeats on the dedup key into the open incident.
channel: type: pagerduty config: routing_key: "${env:PAGERDUTY_ROUTING_KEY}" source: "orders-pipeline" # optional; defaults to the pipeline nameGeneric webhook
Section titled “Generic webhook”Posts a stable JSON envelope. If hmac_secret is set, the body is signed with
HMAC-SHA256 and the lowercase-hex digest is sent in signature_header
(default X-Faucet-Signature) so the receiver can verify authenticity.
channel: type: webhook config: url: "https://ops.example.com/hooks/faucet" method: POST # POST (default), PUT or PATCH headers: { X-Env: prod } # optional extra headers hmac_secret: "${env:FAUCET_WEBHOOK_SECRET}" signature_header: "X-Faucet-Signature" # default extra_fields: # optional static body fields tenant: "${vars.tenant}" environment: prodPayload
Section titled “Payload”{ "event": "run_success", "severity": "info", "pipeline": "contacts-sync", "row": "associations", "run_id": "0199f3c1-8a2e-7c40-9f1b-2d7e5a6c3b04", "invocation_id": "0199f3c1-8a31-7d02-b8aa-91c4e0f7d215", "started_at": "2026-08-13T09:14:02.117Z", "finished_at": "2026-08-13T09:16:41.402Z", "duration_secs": 159.285, "title": "Pipeline `contacts-sync` succeeded", "message": "Run completed, 14203 records written.", "details": { "records_written": 14203 }}| Field | Notes |
|---|---|
event |
One of the event kinds listed above. |
severity |
info / warning / error / critical. |
pipeline, row |
Config identity. Not unique per run — see run_id. |
run_id |
Correlates to the submitted run. Under faucet serve this is exactly the id returned by POST /v1/runs, so a completion callback can be matched to the submission. |
invocation_id |
This matrix row’s own id. One submitted run emits one notification per row, all sharing run_id and differing here. |
started_at, finished_at |
RFC 3339 UTC. |
duration_secs |
Monotonic elapsed seconds — never negative, even across a clock step. |
details |
Per-event structured context (e.g. records_written, error_kind, records_dlq). |
Every key is always present; identity and timing fields are null for events
with no owning invocation (e.g. scheduler_stuck, emitted by the scheduler loop
itself). Receivers can therefore rely on a stable key set.
extra_fields merges static values into the top level of that body — useful for
tagging a callback with a tenant or an external job id. Values go through the
normal interpolation pass. A key that collides with any field above is
rejected by faucet validate rather than silently dropped, so a typo can
never spoof the event a receiver keys off.
Secrets
Section titled “Secrets”Supply channel credentials via ${env:...} / ${file:...} / ${secret:...},
which are resolved over the raw config at load time and registered for log
redaction — never inline a webhook URL or routing key. (These universal
directives work anywhere in the config; cloud secrets-manager schemes like
${vault:...} are resolved for the connector-config surfaces documented under
Secrets-manager interpolation.)
Testing your setup
Section titled “Testing your setup”Fire a synthetic event through a config’s rules — no pipeline runs, real delivery — to confirm a channel is wired correctly:
faucet notify test pipeline.yaml --event run_failure--event accepts any event kind (run_failure, run_success, sla_breach,
circuit_open, contract_abort, dlq_threshold, scheduler_stuck,
profile_drift, change_requested, budget_exceeded,
connection_needs_reauth, log_export_failed); --profile selects a profiles: overlay.
The synthetic event uses the row faucet-notify-test, so its PagerDuty dedup
key (<pipeline>:faucet-notify-test) never matches a real run’s, and a
failure-class test incident is resolved right after it is triggered (pass
--keep-open to leave it open). The command prints what each rule did and
exits non-zero when no rule took the event or any delivery failed, so it can
gate a deploy.
Metrics
Section titled “Metrics”| Metric | Labels | Meaning |
|---|---|---|
faucet_notifications_sent_total |
channel, event, outcome |
Deliveries attempted (outcome = ok/error). |
faucet_notifications_dropped_total |
channel, reason |
Not delivered (reason = coalesced/channel_error). |
faucet_notification_dispatch_duration_seconds |
channel |
Per-delivery latency. |
Relationship to Prometheus alerting
Section titled “Relationship to Prometheus alerting”This block is a self-contained notifier — it needs no external monitoring stack. It is complementary to shipping Prometheus alert rules against faucet’s metrics: use notifications for immediate, per-run incident routing, and Prometheus/Alertmanager for threshold- and duration-based alerting across your fleet.