Creating custom alert rules

You can create custom alert rules to define your own conditions for triggering alerts.

Before you begin

About this task

StorageGRID does not validate custom alerts. If you decide to create custom alert rules, follow these general guidelines:

Steps

  1. Select Alarms. Then, in the Alerts (Preview) section of the menu, select Rules.
    The Alert Rules page appears.
  2. Select Create custom rule.
    The Create Custom Rule dialog box appears.
    Alerts > Create Custom Rule
  3. Select or unselect the Enabled check box to determine if this alert rule is currently enabled.

    If an alert rule is disabled, its expressions are not evaluated and no alerts are triggered.

  4. Enter the following information:
    Field Description
    Unique Name A unique name for this rule.

    The alert rule name is shown on the Alerts page and is also the subject for email notifications. Names for alert rules can be between 1 and 64 characters.

    Description A description of the problem that is occurring.

    The description is the alert message shown on the Alerts page and in email notifications. Descriptions for alert rules can be between 1 and 128 characters.

    Recommended Actions Optionally, the recommended actions to take when this alert is triggered.

    Enter recommended actions as plain text (no formatting codes). Recommended actions for alert rules can be between 0 and 1,024 characters.

  5. In the Conditions section, enter a Prometheus expression for one or more of the alert severity levels.
    A basic expression is usually of the form:
    [metric] [operator] [value]

    Expressions can be any length, but appear on a single line in the user interface. At least one expression is required.

    To see available metrics and to test Prometheus expressions, click the help icon question mark icon and follow the link to the Metrics section of the Grid Management API.

    To learn about using the Grid Management API, see the instructions for administering StorageGRID. For details on the syntax of Prometheus queries, see the documentation for Prometheus 2.3.

    Example
    This expression causes an alert to be triggered if the amount of installed RAM for a node is less than 24,000,000,000 bytes (24 GB).
    node_memory_MemTotal < 24000000000
  6. In the Duration field, enter the amount of time a condition must continuously remain in effect before the alert is triggered, and select a unit of time.
    To trigger an alert immediately when a condition becomes true, enter 0. Increase this value to prevent temporary conditions from triggering alerts.
    The default is 5 minutes.
  7. Click Save.
    The dialog box closes, and the new custom alert rule appears in the Alert Rules table.