Alertes

Créez des règles d'alerte pour envoyer une notification lorsqu'une métrique dépasse un seuil défini. Les alertes peuvent être déclenchées par un warningThreshold ou un criticalThreshold, générant une notification si la valeur de la métrique est inférieure ou supérieure au seuil attendu.

remarque

Pour recevoir l'événement déclenché par une alerte, vous devez pouvoir recevoir les événements d'un flux auquel vous êtes abonné, via un récepteur de votre choix. Les événements déclenchés par une alerte ne sont pas disponibles sur le portail client ni via l'API.

Pour consulter la liste des métriques prises en charge, consultez la page Metrics.

Création d'une alerte

Prérequis: pour ajouter une règle d’alerte, vous devez avoir créé un flux avec des ressources Port et/ou Connexion associées et la mesure activée.

Portal

1. Dans le menu Observabilité, cliquez sur Flux de données.

2. Sélectionnez un flux dans l'Inventaire des flux_.

   

3. Sur la page Détails du flux, dans le menu déroulant Actions, cliquez sur Ajouter des alertes.

   

4. Sur la page Ajouter une alerte, entrez les paramètres de votre règle.

   • Sélectionnez la métrique de connexion ou de port dans la liste déroulante Sélectionnez une mesure.
   • Nommez votre alerte.
   • Ajouter une description de l'alerte (facultatif).
   • Sélectionnez la valeur de l'opérande: ABOVE ou BELOW.
   • Sélectionnez une taille de fenêtre dans le menu déroulant.
   • Définissez la valeur de déclenchement d'un événement d'avertissement dans le champ Seuil d'avertissement.
   • Définissez la valeur de déclenchement d'un événement critique dans le champ Seuil critique.

   

5. Cliquez sur Suivant

6. Sélectionnez dans la liste la connexion ou le port auquel appliquer l'alerte.

   

7. Cliquez sur Soumettre.

À partir de l'écran de confirmation, vous pouvez ajouter des ressources à votre alerte, vous abonner à votre flux pour la recevoir ou créer une autre alerte. Pour voir les détails de votre nouvelle alerte, cliquez sur Afficher les détails de l'alerte.

API

Pour créer une alerte, envoyez une requête POST au point de terminaison /fabric/v4/streams/{streamId}/alertRules.

Exemple de requête cURL:

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_desc>",
    "enabled": "true",
    "metricSelector": {
        "include": [
            "equinix.fabric.port.bandwidth_tx.usage"
        ]
    },
    "resourceSelector": {
        "include": [
            "/fabric/v4/ports/780d384f-2eb6-4c07-ac89-ea106ca12814"
        ]
    },
    "detectionMethod": {
        "type": "THRESHOLD",
        "operand": "ABOVE",
        "windowSize": "PT5M",
        "warningThreshold": 200000,
        "criticalThreshold": 300000
    }
}'

Exemple de réponse:

{
    "href": "https://api.equinix.com/fabric/v4/streams/128cfe7c-e24f-4b1b-8a4f-680cd650c46c/alertRules/28da40d8-09bf-49f2-a02d-af34210f275e",
    "uuid": "128cfe7c-e24f-4b1b-8a4f-680cd650c46c",
    "type": "METRIC_ALERT",
    "name": "<alert_rule_name>",
    "description": "<alert_rule_name>",
    "state": "ACTIVE",
    "enabled": true,
    "metricSelector": {
        "include": [
            "equinix.fabric.port.bandwidth_tx.usage"
        ]
    },
    "resourceSelector": {
        "include": [
            "/fabric/v4/ports/780d384f-2eb6-4c07-ac89-ea106ca12814"
        ]
    },
    "detectionMethod": {
        "type": "THRESHOLD",
        "operand": "ABOVE",
        "windowSize": "PT5M",
        "warningThreshold": 200000,
        "criticalThreshold": 300000
    }
    "changeLog": {
        "createdBy": "testuser",
        "createdDateTime": "2025-02-04T23:17:54.323427936Z"
    }
}

Création d'alertes intelligentes - Latence

Pour les flux auxquels vous avez associé des zones métropolitaines (attached Metros), vous pouvez créer des alertes intelligentes pour les seuils de latence. Ces alertes, basées sur l'IA, analysent les données historiques de latence de vos régions métropolitaines grâce à l'apprentissage automatique afin d'établir des performances de référence et de générer des seuils d'alerte intelligents, éliminant ainsi le besoin de configuration manuelle.

Portal

Pour créer une règle d'alerte intelligente, suivez les mêmes étapes que pour Créer une alerte, et:

1. Sélectionnez la métrique Latence du réseau métropolitain dans le menu déroulant Sélectionnez une mesure.

2. Donnez un nom et une description à votre alerte (facultatif). Cliquez sur Suivant.

   

3. Sélectionnez une ou plusieurs métropoles auxquelles appliquer une règle d'alerte intelligente.

   

4. Cliquez sur Soumettre

Votre alerte apparaît dans la liste des alertes.

API

Pour créer une règle d'alerte intelligente, envoyez une requête POST au point de terminaison /fabric/v4/streams/{streamId}/alertRules.

Spécifiez la métrique spécifique à Metro pour laquelle vous créez l'alerte dans l'objet metricSelector, le Metro associé au flux que vous ajoutez en tant que ressource dans l'objet resourceSelector, et spécifiez detectionMethod.type comme 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"
    }
}'

Récupération de vos alertes

Portal

Pour afficher la liste des alertes pour un flux:

1. Dans le menu Observabilité, cliquez sur Flux de données.

2. Sélectionnez un flux dans l'Inventaire des flux_.

   

3. Cliquez sur Alertes.

   

API

Pour obtenir les détails d'une alerte, envoyez une requête GET au point de terminaison /fabric/v4/streams/{streamId}/alertRules/{alertRuleId}.

Exemple de requête cURL:

curl -X 'GET' 'https://api.equinix.com/fabric/v4/streams/<streamId>/alertRules/<alertRuleId>' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>'

Exemple de réponse:

{
    "href": "https://api.equinix.com/fabric/v4/streams/128cfe7c-e24f-4b1b-8a4f-680cd650c46c/alertRules/28da40d8-09bf-49f2-a02d-af34210f275e",
    "uuid": "128cfe7c-e24f-4b1b-8a4f-680cd650c46c",
    "type": "METRIC_ALERT",
    "name": "<alert_rule_name>",
    "description": "<alert_rule_name>",
    "state": "ACTIVE",
    "enabled": true,
    "metricSelector": {
        "include": [
            "equinix.fabric.port.bandwidth_tx.usage"
        ]
    },
    "resourceSelector": {
        "include": [
            "/fabric/v4/ports/780d384f-2eb6-4c07-ac89-ea106ca12814"
        ]
    },
    "detectionMethod": {
        "type": "THRESHOLD",
        "operand": "ABOVE",
        "windowSize": "PT5M",
        "warningThreshold": 200000,
        "criticalThreshold": 300000
    }
    "changeLog": {
        "createdBy": "testuser",
        "createdDateTime": "2025-02-04T23:17:54.323427936Z"
    }
}

Suppression d'une alerte

Portal

Pour supprimer une alerte:

1. Dans le menu Observabilité, cliquez sur Flux de données.

2. Sélectionnez un flux dans l'Inventaire des flux_.

   

3. Cliquez sur Alertes.

4. Dans la liste des alertes, cliquez sur le menu d'options de celle que vous souhaitez supprimer, puis cliquez sur Supprimer l'alerte.

   

API

Pour supprimer une alerte, envoyez une requête DELETE au point de terminaison /fabric/v4/streams/{streamId}/alertRules/{alertRuleId}.

Exemple de requête cURL:

curl -X DELETE 'https://api.equinix.com/fabric/v4/streams/<streamId>/alertRules/<alertRuleId>' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>'

Exemple de réponse:

{
    "href": "https://api.equinix.com/fabric/v4/streams/128cfe7c-e24f-4b1b-8a4f-680cd650c46c/alertRules/28da40d8-09bf-49f2-a02d-af34210f275e",
    "uuid": "28da40d8-09bf-49f2-a02d-af34210f275e",
    "type": "METRIC_ALERT",
    "name": "<alert_rule_name>",
    "description": "<alert_rule_name>",
    "state": "INACTIVE",
    "enabled": true,
    "metricName": "equinix.fabric.port.bandwidth_tx.usage",
    "resourceSelector": {
        "include": [
            "*/ports/<uuid>"
        ]
    },
    "windowSize": "PT15M",
    "operand": "ABOVE",
    "warningThreshold": "43000000",
    "criticalThreshold": "45000000",
    "changeLog": {
        "createdBy": "testuser",
        "createdDateTime": "2025-02-04T23:17:54.323427936Z"
    }
}