Alerts Dashboard Tool

Overview

The Alerts Dashboard tool alerts you to problems in your applications and environment. The tool lets you track:

  • API (application programming interface) requests with 400 and 500 level response codes. All 400 codes are client error codes. And 500 codes are server error codes.

  • API requests that take longer than 2 seconds to complete.

  • Performance metrics like available disk space and CPU and memory usage.

For troublesome API requests, you can have the monitor alert you after each request. Or you can have the monitor alert you after a specific number of requests complete. You can also create a monitor to watch performance metrics. You'll set thresholds for your metrics, so you get an alert when a metric crosses that barrier. When your monitor triggers an alert, the monitor will send you an email about the incident.

What You'll Learn

In this article, you'll learn how to:

Navigating the Alerts Dashboard

When you open the Alerts Dashboard, the Client and Environment fields populate automatically. On the Alerts dashboard, you'll also see all your environment's monitors. Monitors are tools for watching your applications and modules. When unexpected behavior occurs, you'll receive an alert of the issue.

By default, only 10 monitors show at a time. You can click the pagination buttons below the Monitors table to see more. Or, to make it easier, you can use the dashboard's filters to help you find a particular monitor. You can use any or all these filters, depending on how specific you want to be. As you enter text into the fields, the request appears automatically. To clear all fields, just click the funnel icon to the far right.

The filters include:

Filter Description

Status

This is the current status of the monitor. The different statuses are:

  • OK: A triggered monitor that returns to normal operating conditions.

  • Alert: A triggered monitor. The metric still exceeds the set threshold.

  • No Data: A monitor that has yet to trigger. The metric hasn't crossed the set threshold.

Priority

This is the monitor's level of risk. The highest priority is P1 and the lowest is P5.

Last Triggered

A timestamp for the most recent time a metric or API request crossed your threshold. The timestamp uses the 24-hour clock and your current timezone.

Type

This is the type of monitor created. It can be either of the following:

  • Metric: Monitoring a specific metric.

  • Log: Monitoring a troublesome API request.

Name

This is the monitor's name.

Here's an example of what the Alerts Dashboard will look like:

Creating a Monitor

Let's start by creating a monitor. At the bottom of the Alerts Dashboard, you'll see the + Create Monitor button. When you click the button, a pop-up appears for you to add all your monitor's details.

The fields and drop-downs you'll see are:

Attribute Description

Type

This is the type of monitor. Your options are:

  • Metric: On selection, a new Metric field opens up. From this field, you can select a range of CPU and memory usage to network throughput metrics for monitoring.

  • Log: On selection, new Log Type and URL Path fields open up. Log Type options include Error and Show.

Threshold Timing

The duration the monitor watches for a metric or log to exceed the Alert Threshold. This drop-down lets you monitor in:

  • Seconds

  • Minutes

  • Days

Alert Threshold

The is a set threshold that triggers an alert when a metric or log exceeds it. The monitor fires off an email to the defined recipient.

Name

Here you'll enter a name for your monitor.

Priority

This is the monitor's level of risk. The highest priority is P1, and the lowest is P5.

Recipient

When a metric or log exceeds the Alert Threshold, this recipient will receive an email alert.

Add Recipient Button

Click this button to add a recipient's email address. When a log or metric exceeds the Alert Threshold, this recipient will receive an email.

NOTE  You can add as many recipients as you want.

Cancel Button

Click this button to clear changes and close the pop-up.

Create Monitor Button

Click this button to add the monitor you created.

The first selection you'll make is the monitor type. Depending on your choice, different options appear to create a specific monitor. So, let's create each monitor individually.

Creating a Metric Monitor

You can set up alerts for different metrics. You can look at everything from disk space and memory usage to network throughput. Before we move onto creating a Metric Monitor, lets talk about your metric options. Each metric comes with a different Alert Threshold to set up.

The metrics and their Alert Thresholds are:

Metric Description

App - CPU

The time the CPU spent running your environment's applications.

The metric chart's vertical axis is measured in percent. So, you'll enter a numerical percent value as your Alert Threshold.

App - Memory

The amount of physical RAM used versus the total amount of RAM available.

The metric chart's vertical axis is measured in GB (gigabytes). So, you'll enter a numerical GB value as your Alert Threshold.

App - Network In

The amount of network throughput entering your applications.

The metric chart's vertical axis is measured in kb/s (kilobytes per second). So, you'll enter a numerical kb/s value as your Alert Threshold.

App - Network Out

The amount of network throughput leaving your applications.

The metric chart's vertical axis is measured in kb/s (kilobytes per second). So, you'll enter a numerical kb/s value as your Alert Threshold.

DB - CPU

The time the CPU spent running in your environment.

The metric chart's vertical axis is measured in percent. So, you'll enter a numerical percent value as your Alert Threshold.

DB - Memory

The amount of RAM in use.

The metric chart's vertical axis is measured in GB (gigabytes). So, you'll enter a numerical GB value as your Alert Threshold.

DB - Disk Space

The amount of disk space used.

The metric chart's vertical axis is measured in percent. So, you'll enter a numerical percent value as your Alert Threshold.

DB - Connections

The total number of queries executed by Unqork's database.

The metric chart's vertical axis is measured in connections. So, you'll enter a numerical connection value as your Alert Threshold.

To create a Metric Monitor:

1. Select Metric as your Type.
2. Select a metric from the Metric drop-down.

NOTE  Your Alert Threshold appears as a red, horizontal line in the preview window.

3. Enter a numerical value in the Threshold Timing field.
4. Select a time measurement from the Threshold Timing drop-down. You can select seconds, minutes, or days.
5. Enter a numerical value in the Alert Threshold field. The red line in the preview window moves as you enter a threshold.
6. Enter a unique name for your monitor in the Name field.
7. Select a priority from the Priority drop-down.

NOTE  Remember, this is the level of risk you assign to your monitor. The highest priority is P1, and the lowest is P5.

8. Click Add Recipient.
9. Enter the email address of the person you want to send alert emails to.
10. Click Save.

NOTE  To add more recipients, click the Add Recipient button again and add another email address.

11. Click Create Monitor.

NOTE  If you don't see your new monitor appear on the Alerts Dashboard in a few seconds, refresh the page.

Creating a Log Monitor

Now, let's create a Log Monitor. Remember, you'll set up Log Monitors to watch slow or error-prone API requests. The monitor lets you watch for a set number of requests to occur before sending an alert. For example, you could have a recipient alerted if 5 slow API requests occur in a 5-minute window.

First, you must select which type of log to monitor. Your options are:

  • Error Logs: These logs are specific to API requests with 400 and 500 level response codes. Remember, 400 codes are client error codes. And 500 codes are server error codes.  

  • Slow Logs: These logs are specific to API requests that take longer than 2 seconds to complete.

Once selected, you must enter a URL Path. You can enter an API endpoint, like GetSubmissions, or even a module ID. Every call that includes that part of the URL will populate in the Logs Dashboard.

To create a Log Monitor:

1. Set Log as the Type.
2. Select either Error or Slow from the Log Type drop-down.
3. Enter a portion of an API URL to monitor in the URL Path field.
4. Enter a numerical time in the Threshold Timing field.
5. Select time measurement from the Threshold Timing drop-down. You can select seconds, minutes, or days.
6. Enter the number of API requests you want to monitor in the Alert Threshold field.
7. Enter a unique name for your monitor in the Name field.
8. Select a priority from the Priority drop-down.

NOTE  Remember, this is the level of risk you assign to your monitor. The highest priority is P1 and the lowest is P5.

9. Click Add Recipient.
10. Enter the email address of the person you want to send alert emails to.
11. Click Save.

NOTE  To add more recipients, click the Add Recipient button again and add another email address.

12. Click Create Monitor.

NOTE  If you don't see your new monitor appear on the Alerts Dashboard in a few seconds, refresh the page.

Viewing and Sharing a Monitor's Details

Now that you know how to create a monitor, let's view its details. When you return to the Alerts Dashboard, you'll see all your environment's monitors. To the right of each monitor, you'll see a View button. Click this button to see the details of your monitor.

The pop-up also lets you edit or delete the monitor. We'll get to that soon.

To view your monitor's details:

1. Use the Alerts Dashboard's filters to find your monitor.
2. Click the View button to the right of your monitor.

Again, the kinds of data you'll see depends on if it's a Metric or Log Monitor. So, let's look at them individually.

Viewing a Metric Monitor's Details

There are a variety of performance metrics to monitor. You can watch CPU usage, disk space, or even the network traffic of your applications. To see more details about performance metrics, use Unqork's Metrics Dashboard tool.

TIP  To learn more about performance metrics, search Metrics Dashboard Tool in our In-Product Help.

When you click the View button, you'll see:

Attribute Description

Name

This is the monitor's name.

Priority

This is the monitor's level of risk. The highest priority is P1, and the lowest is P5.

Status

This is the current status of the monitor. The different statuses are:

  • OK: A triggered monitor that returns to normal operating conditions.

  • Alert: A triggered monitor. The metric still exceeds the set threshold.

  • No Data: A monitor that has yet to trigger. The metric hasn't crossed the set threshold.

Metric

This is the specific application or database performance metric being monitored. You'll see one of the following metrics:

  • App - CPU: The time the CPU spent running your environment's applications.

  • App - Memory: The amount of physical RAM used versus the total amount of RAM available.

  • App - Network In: The amount of network throughput entering your applications.

  • App - Network Out: The amount of network throughput leaving your applications.

  • DB - CPU: The time the CPU spent running in your environment.

  • DB - Memory: The amount of RAM in use.

  • DB - Disk Space: The amount of disk space used.

  • DB - Connections: The total number of queries executed by Unqork's database.

Type

This is the type of monitor. You'll only see metric here.

Alert Threshold

When a metric crosses this threshold, the status changes to Alert and the monitor sends an email to the recipient.

Threshold Timing

The duration the monitor watches for a metric to cross the set threshold. Thresholds can be measured in seconds, minutes, or days.

Preview Window

Lets you view the metric performance of the last 4 hours. The Alert Threshold appears as a red, horizontal line.

Recipient

When a metric crosses the Alert Threshold, this recipient will receive an email.

Delete Monitor Button

Clicking this button deletes the monitor.

Edit Monitor Button

Click this button to edit portions of the monitor.

Metrics Dashboard Link

Click this link to open the Metrics Dashboard tool in your environment.

Clicking the (X) at the top-right side of the pop-up returns your focus to the Alerts Dashboard.

Here's an example of how this pop-up looks:

Exporting and Sharing Your Performance Metrics

You can also export or print your performance metrics. In the preview window, you'll notice a hamburger button () at the top right of the chart widget. When you click on this button, you get the following options:

  • Print chart

  • Download CSV

  • Download XLS

  • Download PDF document

Let's look at each of these in more detail.

Print Chart

The Print Chart option lets you print data from each chart.

To print a chart:

1. Click the (Hamburger) button at the right of the chart.
2. Select Print Chart.
3. At the print dialog, set your Destination:
a. Save as PDF.
b. A connected printer device.
4. Set the Layout as Portrait or Landscape.
5. Under More Settings, set the Scale as either Default or Custom. The Custom option lets you adjust the chart size to fit the full page.
6. Click Save/Print. The button updates based on your Destination selected earlier.

Download CSV

A CSV (comma-separated values) file is a plain text file that contains a list of data.

To download your chart as a CSV file:

1. Click the (Hamburger) button at the right of the chart.
2. Select Download CSV.
3. Check your Downloads folder for the .csv file. Your file name is similar to that of the chart name. For example, the Connections chart downloads as connections.csv.

Download XLS

XLS is a file extension created by Microsoft for use with Microsoft Excel.

To download your chart as an XLS file:

1. Click the (Hamburger) button at the right of the chart.
2. Select Download XLS.
3. Check your Downloads folder for the .xls file. Your file name is similar to that of the chart name. For example, the Connections chart downloads as connections.xls.

Download PDF Document

PDF stands for Portable Document Format. Using this format prevents modification of your chart file while still allowing sharing and printing.

To download your chart as a PDF file:

1. Click the (Hamburger) button at the right of the chart.
2. Select Download PDF Document.
3. Check your Downloads folder for the .pdf file. Your file name is similar to that of the chart name. For example, the Connections chart downloads as connections.pdf.

Viewing a Log Monitor's Details

You'll use Log Monitors to watch troublesome API requests in your environment. These could be slow requests or requests with 400 and 500 level response codes. To see the full details of a specific API request, use Unqork's Logs Dashboard tool.

TIP  To learn more about Error and Slow Logs, search Logs Dashboard Tool in our In-Product Help.

When you click on the View button of a Log Monitor in the Alerts Dashboard, you'll see:

Attribute Description

Name

This is the monitor's name.

Priority

This is the monitor's level of risk. The highest priority is P1 and the lowest is P5.

Status

This is the current status of the monitor. The different statuses are:

  • OK: A triggered monitor that returns to normal operating conditions.

  • Alert: A triggered monitor. The metric still exceeds the set threshold.

  • No Data: A monitor that has yet to trigger. The metric hasn't crossed the set threshold.

Log Type

This is the type of log being monitored. You'll see the following types:

  • Error: This log is specific to API requests with 400 and 500 level response codes.

  • Slow: This log is specific to API requests that take longer than 2 seconds to complete.

Type

This is the type of monitor created. It can be any of the following types:

  • Log: Monitoring a troublesome API request.

  • Metric: Monitoring a specific metric.

URL Path

The monitor watches all API requests whose URL includes this path.

Alert Threshold

A set number of completed API requests before the status changes Alert.

Threshold Timing

The duration the monitor watches for a metric to cross the set threshold. Thresholds can be measured in seconds, minutes, or days.

Recipient

This is the email address of the person being notified by the monitor.

Delete Monitor Button

Clicking this button deletes this monitor.

Edit Monitor Button

Click this button to edit portions of the monitor.

Logs Dashboard Link

Click this link to open the Logs Dashboard tool in your environment.

Clicking the (X) at the top-right side of the pop-up returns your focus to the Alerts Dashboard.

Here's an example of how this pop-up looks:

Editing a Monitor's Details

The Monitor Details pop-up also gives you the option to edit the monitor. You can update any combination of the following fields:

  • Name

  • Priority

  • Log Type (Log monitor only)

  • URL Path (Log monitor only)

  • Alert Threshold

  • Threshold Timing

  • Recipient

If you want to edit the monitor's Alert Threshold for example:

1. Use the Alerts Dashboard's filters to find your monitor.
2. Click the View button to the right of your monitor.
3. Click Edit Monitor.
4. Enter the threshold value you want in the Alert Threshold field.
5. Enter a numerical value in the Threshold Timing field.
6. Select a time measurement from the Threshold Timing drop-down.
7. Click Save Monitor.

Deleting a Monitor

If you no longer need your monitor, you can delete it. To delete a monitor:

1. Use the Alerts Dashboard's filters to find your monitor.
2. Click the View button to the right of your monitor.
3. Click Delete Monitor.
4. Click Yes.