Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Alerts Dashboard

Prev Next

The Alerts Dashboard surfaces problems in Unqork applications and environments. Create alerts to monitor applications and modules. When unexpected behaviors occur, Unqork sends a notification.

The tool tracks the following:

  • API requests with 400 and 500 level response codes (client errors and server errors).
  • API requests that take longer than two seconds to complete.
  • Performance metrics, such as available disk space and CPU and memory usage.

For troublesome API requests, Unqork can send an alert after each request or after a specified number of requests complete. For performance metrics, set thresholds and Unqork sends an email when a metric exceeds them.

The Alerts Dashboard only supports AWS (Amazon Web Services) integration. It does not currently support Azure source logs.

When the Alerts Dashboard opens, the Client and Environment fields populate automatically. The dashboard displays all alerts in the environment. The table shows 10 alerts at a time. Use the pagination buttons to see more, or use the filters to find a specific alert. Any combination of filters can be used. Results update automatically as text is entered. To clear all filters, click the funnel icon (Funnel) icon.

Filter Description
Status The current status of the alert. OK: returned to normal conditions. Alert: threshold still exceeded, alert remains active. No Data: metric has not yet exceeded the threshold.
Priority The alert's risk level. The highest priority is P1 and the lowest is P5.
Last Triggered A timestamp for the most recent time a metric or API request exceeded the threshold. Uses the 24-hour clock and current timezone.
Type The alert type. Log: monitors a troublesome API request. Metric: monitors a specific metric.
Name The alert's name.
View Opens the alert's details for review, editing, or deletion.

Creating an Alert

Two types of alerts are available:

  • Metric: Monitors disk space, memory usage, network throughput, and more. Each metric requires a specific Alert Threshold based on its unit of measurement.
  • Log: Monitors slow API requests and requests with 400 and 500 level response status codes.

To create an alert, click + Create New Alert. A dialog opens with the following settings:

Define the Alert

Setting Description
Type The alert type. Metric: a Metric drop-down displays. Log: Log Type and URL Path fields display.
Metric* App - CPU: CPU time for the environment's applications (% per second). App - Memory: RAM used vs. available (GB). App - Network In: network throughput into the applications (kb/s). App - Network Out: network throughput out of the applications (kb/s). DB - CPU: CPU time for the database (% per second). DB - Memory: RAM used by the database (GB). DB - Disk Space: disk space used. DB - Connections: total database queries (connections per second).
Log Type* Error Logs: API requests with 400 and 500 level response codes. Slow Logs: API requests that take longer than two seconds to complete.
Slow Log Threshold The number of seconds an error-prone API call runs before an alert triggers. The default is two seconds. Displays only when Slow Logs is the selected Log Type.
URL Path An API endpoint (for example, GetSubmissions) or module ID. The alert monitors all calls that include this path. See Logs Dashboard for details.

Set Alert Conditions

Setting Description
Threshold Timing* The duration the alert watches for a metric or log to exceed the Alert Threshold. Options: Minutes or Days. Metric-type alerts support a 30-day range; log-type alerts support a two-day range. A 15-minute threshold is recommended due to the evaluation delay.
Alert Threshold* The threshold that triggers an alert when a metric or log exceeds it. The unit of measurement depends on the selected Metric or Log Type.

Identify the Alert

Setting Description
Name* A name that clearly describes the alert.
Priority* The alert's risk level. The highest priority is P1 and the lowest is P5.
Recipient(s)* All recipients receive an email when a metric or log exceeds the Alert Threshold. Add as many recipients as needed.
Add Recipient Adds a recipient's email address.
Cancel Clears changes and closes the dialog.
Create Alert Adds the new alert to the environment.

Viewing Alert Details

Click View on any alert to see its details. Details vary by alert type.

Metric Alert Details

Locate and click View on a metric-type alert. The following example shows an App - CPU alert.

Alert Details dialog showing a Metric alert for App - CPU with fields for Name, Priority, Status, Metric, Threshold Timing, Alert Threshold, Preview Window, and Recipients.
Attribute Description
Name The alert's name.
Priority The alert's risk level. P1 is the highest priority and P5 is the lowest.
Status The current status. OK: returned to normal. Alert: threshold still exceeded. No Data: not yet triggered.
Metric The performance metric being monitored. See the Metric options in Creating an Alert.
Type Displays metric for all metric alerts.
Threshold Timing The duration the alert watches for the metric to exceed the threshold.
Alert Threshold When exceeded, the status changes to Alert and an email is sent to all recipients.
Preview Window Shows metric performance over the last four hours. The Alert Threshold displays as a red horizontal line.
Recipient(s) All recipients who receive an email when the threshold is exceeded.
Delete Alert Deletes the alert.
Edit Alert Opens the alert for editing.
external-link icon Metrics Dashboard Opens the Metrics Dashboard in the environment.

Log Alert Details

Log alerts monitor troublesome API requests, such as slow requests or requests with 400 and 500 level response codes. See the Logs Dashboard to view full details of specific API requests.

Locate and click View on a log-type alert. The images below show examples of slow and error log alerts.

Slow Log ExampleAlert Details dialog showing a Slow Log alert. Error Log ExampleAlert Details dialog showing an Error Log alert.
Attribute Description
Name The alert's name.
Priority The alert's risk level. P1 is the highest priority and P5 is the lowest.
Status The current status. OK: returned to normal. Alert: threshold still exceeded. No Data: not yet triggered.
Log Type Error: API requests with 400 and 500 level response codes. Slow: API requests exceeding the time threshold.
Type Displays log for all log alerts.
Slow Log Threshold The number of seconds before an alert triggers. Displays only for the Slow Logs Log Type.
URL Path The alert monitors all API requests whose URL includes this path.
Alert Threshold The number of completed API requests before the status changes to Alert.
Threshold Timing The duration the alert watches for the threshold to be exceeded.
Recipient(s) All recipients who receive an email when the threshold is exceeded.
Delete Alert Deletes the alert.
Edit Alert Opens the alert for editing.
external-link icon Logs Dashboard Opens the Logs Dashboard in the environment.

Exporting and Printing Charts

To export or print a performance metric chart, click View on a metric-type alert, then click the menu icon (Menu) button at the top right of the chart widget.

Chart widget menu showing options to print, download CSV, download XLS, download XLSX, and download PDF.
Option Description
Print Chart Prints the chart or saves it as a PDF.
Download CSV Downloads the chart as a .csv file.
Download XLS Downloads the chart as an .xls file.
Download XLSX Downloads the chart as an .xlsx file.
Download PDF Document Downloads the chart as a .pdf file.

Changelog

Date Change
2026-07-21 Full editorial sweep — replaced old image icons with Lucide, fixed modal → dialog, removed * list markers and embedded > from table cells, renamed Say What's Happening section, standardized table descriptions.
2026-07-16 Editorial pass: fixed banned words, em dashes, See Also descriptions, and link paths.
2026-04-28 Editorial quality pass: fixed metadata, added H1, removed CDN anchor wrappers, fixed empty alt text, made icon images inline, removed contractions, removed case markers, updated internal links.