10. Alerts

Ngenea Hub allows you to configure job alerts to monitor the status of both scheduled and non-scheduled jobs. Alerts can be triggered when jobs have not started, are running but not progressing, failing, failed with task failures, completely failed or completed successfully.

Alerts are useful for ensuring that issues are detected and communicated promptly via email to the configured recipients. You can configure alerts either via the Global Settings page in the UI or via the /configurations API in the backend.

For more details on how to configure alerts in the UI, see Job Alerts.

10.1. Configuration Settings

The following backend configuration fields are supported for job alerts. These fields can be updated via the /configurations API.

Setting	Type	Default	Description
alert_scheduled	Boolean	False	Enable alerts for scheduled jobs.
alert_unscheduled	Boolean	False	Enable alerts for unscheduled jobs.
alert_notstarted_jobs	Boolean	False	Enable alerts for jobs that have not started.
notstarted_job_threshold	Integer (seconds)	7200	Time in seconds before a job is considered not started.
alert_notprogressed_jobs	Boolean	False	Enable alerts for jobs that are running but not progressed.
notprogressed_job_threshold	Integer (seconds)	7200	Time in seconds before a job is considered not progressed.
alert_inprogress_failing_jobs	Boolean	False	Enable alerts for jobs that are failing while in progress.
alert_completed_has_failures_jobs	Boolean	False	Enable alerts for jobs that completed with task failures.
alert_completed_failed_jobs	Boolean	False	Enable alerts for jobs that completed with job failure.
alert_completed_success_jobs	Boolean	False	Enable alerts for jobs that completed successfully.
alert_email_address	Array of EmailField	[]	List of email addresses that will receive alert notifications.
alerting_started_at	Datetime	null	Timestamp indicating when alerting was activated.