Skip to main content

Alerts

Create alert rules to send an alert event when a metric crosses a defined threshold value. Alerts can trigger on both a warningThreshold and a criticalThreshold, triggering an alert event if the metric value falls below or exceeds the expected threshold.

note

In order to receive the event triggered by an Alert, you need to be able to receive events from a stream you have a subscription to in a sink of your choice. The events triggered by an Alert are not available in the Customer Portal or the API.

To view the list of supported metrics, refer to the Metrics page.

Creating an Alert​

Prerequisite: In order to add an alert rule, you should have a stream created with Port and/or Connection resources attached and metric enabled

  1. From the Observability menu, click Data Streams.

  2. Select a Stream from the Stream Inventory.

  3. On the Stream Details page, from the Actions drop-down menu, click Add Alerts.

  4. On the Add Alert page, enter your rule's parameters.

    • Select the Connection or Port Metric from the Select a Metric drop-down.
    • Give your Alert a name.
    • Add an Alert description (optional).
    • Select the operand value: ABOVE or BELOW.
    • Select a window size from the drop-down.
    • Set the value for triggering a warning event in the Warning Threshold field.
    • Set the value for triggering a critical event in the Critical Threshold field.

  5. Click Next

  6. Select the Connection or Port to apply the Alert to from the list.

  7. Click Submit.

From the confirmation screen, you can add more resources to your alert, add a subscription to your stream to receive your alert, or add another alert. To see the details of your new alert, click View Alert Details.

Creating Smart Alerts - Latency​

For Streams where you have attached Metros, you can create smart alerts for latency thresholds. These AI-powered alerts analyze historical latency data across your metro locations using machine learning to establish baseline performance and generate smart alert thresholds, eliminating the need for manual alert configuration.

To create a smart alert rule, send a POST request to the /fabric/v4/streams/{streamId}/alertRules endpoint.

Specify the Metro-specific metric you are creating the alert for in the metricSelector object, the Metro that is attached to the stream that you are adding as a resource in the resourceSelector object, and specify the detectionMethod.type as OUTLIER.

curl -X 'POST' 'https://api.equinix.com/fabric/v4/streams/<streamId>/alertRules' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
    "type": "METRIC_ALERT",
    "name": "<alert_rule_name>",
    "description": "<alert_rule_description>",
    "enabled": "true",
    "metricSelector": {
        "include": [
            "equinix.fabric.metro.<metro_code>_<metro_code>.latency"
        ]
    },
    "resourceSelector": {
        "include": [
            "/fabric/v4/metros/{metro_code}"
        ]
    },
    "detectionMethod": {
        "type": "OUTLIER"
    }
}'

Retrieving Your Alerts​

To see the list of Alerts for a Stream:

  1. From the Observability menu, click Data Streams.

  2. Select a Stream from the Stream Inventory.

  3. Click on Alerts.

Deleting an Alert​

To delete an Alert:

  1. From the Observability menu, click Data Streams.

  2. Select a Stream from the Stream Inventory.

  3. Click on Alerts.

  4. From the list of Alerts, click the options menu of the one you want to delete, click Remove Alert.