Alerting

Alerting sends notifications about workflow events and system states. Without an active policy or an active rule, nothing is delivered.

The Alerting page has two areas:

AreaUse
System alertsMonitoring known system values such as backlog, reachability or credential expiry
Custom rulesNotification on selected workflow and operational events

For new monitoring, system alerts are the simpler choice. Custom rules suit your own combinations of event type, scope and filters.

Notification channels

A policy or rule can contain several channels.

ChannelTargetPrerequisite
EmailA single recipient addressA configured SMTP connection
WebhookAn HTTP(S) endpointA reachable and permitted target address; HTTPS is recommended

The SMTP connection is configured under Settings → Integrations with host, port, sender, TLS and optional credentials. A connection test is available there too.

A webhook receives a JSON message with the event type, severity, workflow, status, error and timestamp. An optional secret signs the message with HMAC-SHA256 in the X-NodePilot-Signature header.

Quick setup

  1. Open the appropriate area under Alerting.
  2. Choose a system source or create a custom rule.
  3. Set the condition, the scope and at least one channel.
  4. Check your selection with Preview or Check current values.
  5. Save and send a test notification.
  6. Enable the policy or rule.

The preview sends no message. A test notification really does exercise the saved channels.

System alerts

System alerts monitor measurements NodePilot provides. Several policies with different thresholds, recipients or scopes can be created for one source.

Available sources

CategorySourcePurpose
ExecutionExecution resultSuccessful, failed or cancelled runs
ExecutionStuck executionExecutions running unusually long
ExecutionWorkflow healthThe error rate and runtime trend of a workflow
QueueExecution backlogThe sum of waiting and running executions
QueueQueue depthThe number of waiting executions only
QueueCancellation rateThe number of cancelled executions in a time window
System stateMachine unreachableA failed stored connection test
System stateStale service heartbeatA missing status from a background service
System stateAlert delivery failedRepeated errors when sending email or webhooks
System stateTrigger not registeredA trigger that cannot become active, for example because a directory is unreachable
ScheduleMissed scheduleAn expected scheduled start with no matching execution
ScheduleNo recent workflow successA scheduled workflow without a recent successful run
CredentialsCredential expiringAn upcoming or already reached expiry date
SecurityAudit eventAudit-log entries such as failed logins, lockouts, break-glass sign-ins, role changes or credential deletions — filterable by code, outcome, user, IP and the details JSON

A source can appear as unavailable if the required data is missing. Examples:

  • Machines with no connection test yet are not evaluated as unreachable.
  • Credentials without a maintained expiry date are not monitored.
  • Workflow-related sources need existing execution or schedule data.
  • "Trigger not registered" is available on the active node even when no trigger is affected; an empty state counts as healthy and ends earlier failure episodes. In high-availability operation, only the active node knows that state; on the passive node the source appears as unavailable even though the active node alerts correctly.

Configuring a policy

SettingMeaning
TemplateFills in a sensible starting configuration
ConditionDetermines the value at which an alert fires
Source parametersDetermine, for example, the time window considered
Time until alertThe condition has to hold continuously for this long
SeverityInfo, Warning or Critical
ScopeGlobal, folders or individual workflows; depends on the source
CooldownThe minimum gap between repeated messages
RoutesEmail and webhook destinations

Check current values shows which existing values currently satisfy the policy. A template only fills in the editor; it does not enable the policy automatically.

Custom rules

Custom rules react to events. A rule consists of event types, optional filters, a scope and at least one channel.

Event types

GroupEvents
ExecutionsFailed, succeeded, cancelled, running long, waiting long
CredentialsCredential error

Credential expiry, service/machine health, backlog, cancellation rate and schedule monitoring are configured through system policies. These signals and SystemAlert cannot be selected as event types for a custom rule.

For a manual cancellation, the Cancelled by field can be filtered. The value user limits the rule to executions cancelled individually by a person.

Configuring a rule

SettingMeaning
Event typesThe events the rule reacts to
ScopeAll workflows, selected folders or selected workflows
FiltersAdditional conditions, for example status, workflow name, duration or target machine
Group byGroups similar events together for repetition control
ChannelsEmail or webhook destinations
Channel conditionSends a particular channel only when an additional condition matches
CooldownPrevents the same message repeating too often
Minimum occurrences and time windowAlerts only once an event occurs several times within the window

An empty filter admits every selected event within the defined scope. An empty grouping uses the event's default grouping.

Example: a rule for execution failed can apply globally, send email only on Critical, and fire a webhook exclusively for one folder.

Preview and testing

The three checks serve different purposes:

CheckResult
PreviewChecks the rule, filters, grouping and channel conditions against a sample event
Check current valuesEvaluates a system policy against currently available measurements
Test notificationSends a real message to all saved channels

A new configuration should first be saved disabled, tested, and then enabled.

Delivery history

The Deliveries action opens the history of delivery attempts. It shows:

  • The time and the rule
  • The channel and the destination
  • The status Pending, Sent or Failed
  • The attempt number
  • The error message

Failed deliveries are retried with growing pauses (30 seconds, 2, 10 and 30 minutes) and marked as failed after five unsuccessful attempts. The last attempt therefore comes about 45 minutes after the first, so a receiver that is unavailable for a shorter time still gets the alert. The retention period follows the notification retention; by default, completed entries are kept for 90 days.

Permissions and security

  • Admins and operators may read rules and deliveries.
  • Only admins may create, change, delete, test or enable policies and rules.
  • Webhook secrets are stored encrypted and are not shown again.
  • Webhook destinations are subject to the configured rules for outbound connections.
  • Changes and test firings are recorded in the audit log.
  • The preview ("check current values") of the Audit event source is admin-only because it returns audit rows — the same boundary as the audit log itself.

Alerting currently sends no automatic all-clear when a state returns to normal.

All chapters