Manage Alerts

Overview

Alerts are notifications about the NGINX Controller system and your applications' performance.

Alert rules let you specify what you want to be alerted about. This includes which metrics you want to monitor; the trigger conditions and threshold to meet; the instance(s) to monitor; and the email address(es) to use for notifications.

Add an Alert Rule

To add an alert rule:

  1. Open the NGINX Controller user interface and log in.

  2. On the Analytics menu, select Alerts > Alert Rules.

  3. Select Create Alert Rule.

  4. Define your alert rule by providing the following information:

    • Name

    • (Optional) Display Name

    • Metric

    • Condition, Threshold, and Time Period

    • Filter

    • (Optional) Breakout

    • Email Notification Address(es):

      • Select the desired address(es) from the list provided, or

      • Select Manage Email Addresses to add a new address, then take the steps below:

        1. Select Add Email Address.
        2. Provide the desired email address.
        3. Select the submit (plus sign) icon.
        4. Select Done to close the Manage Email Addresses panel.
        Note:
        You will need to verify the email address before it can begin receiving alerts.
  5. (Optional) Select Mute Alert Rule if you want to create the alert rule but not receive any associated notifications.

  6. Select Create.

View Alerts

To view all alerts that are triggered by alert rules:

  1. Open the NGINX Controller user interface and log in.
  2. On the Analytics menu, select Alerts > Alerts.

All alert rules and triggered alerts are displayed on this page. You can use the search bar to filter the alerts that are displayed.

Edit an Alert Rule

To edit an alert:

  1. Open the NGINX Controller user interface and log in.
  2. On the Analytics menu, select Alerts > Alert Rules.
  3. Select the alert rule that you want to edit.
  4. Select the edit (pencil) icon for the alert rule.
  5. Make the desired changes to the alert rule, then select Save.
Important:

When you edit an alert rule, any ongoing alerts which previously met that rule will expire immediately.

If the threshold is still exceeded in the new alert rule configuration, new alerts will be triggered.

Mute or Unmute an Alert Rule

If you want to stop receiving notifications for an alert rule without deleting it, you can mute it. Likewise, you can unmute alert rules for which you want to resume receiving notifications.

To mute or unmute an alert:

  1. Open the NGINX Controller user interface and log in.
  2. On the Analytics menu, select Alerts > Alert Rules.
  3. Select the alert rule that you want to mute or unmute.
  4. Select the mute (volume) icon to mute or unmute the alert rule.

Delete an Alert Rule

To delete an alert rule:

  1. Open the NGINX Controller user interface and log in.
  2. On the Analytics menu, select Alerts > Alert Rules.
  3. Select the alert rule that you want to delete.
  4. Select the delete (trash can) icon to delete the alert rule.
  5. Select Delete in the pop-up box to confirm that you want to proceed.

What’s Next


This documentation applies to the following versions of NGINX Controller Documentation: 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12, 3.13, 3.14, 3.15 and 3.16.