Alertes

Créez des règles d'alerte pour envoyer un événement d'alerte lorsqu'une mesure dépasse une valeur de seuil définie. Les alertes peuvent se déclencher sur un warningThreshold et un criticalThreshold, déclenchant un événement d'alerte si la valeur de la mesure tombe en dessous ou dépasse le seuil attendu.

note

Afin de recevoir l'événement déclenché par une alerte, vous devez être en mesure de recevoir des événements d'un flux auquel vous êtes abonné dans un puits de votre choix. Les événements déclenchés par une alerte ne sont pas disponibles sur le Portail client ou le API.

Pour afficher la liste des métriques prises en charge, reportez-vous à la pagemétriques.

Créer une alerte

Condition préalable : Pour ajouter une règle d'alerte, vous devez avoir créé un flux avec des ressources de port et/ou de connexion associées et une métrique 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, saisissez les paramètres de votre règle.

   • Dans la liste déroulante sélectionner une mesure de connexion ou de port.
   • Donnez un nom à votre Alert.
   • Ajoutez 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.
   • Dans le champ _seuil d'_avertissement, définissez la valeur de déclenchement d'un événement d'avertissement.
   • Dans le champ seuil critique, définissez la valeur de déclenchement d'un événement critique.

   

5. Cliquez sur suivant

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

   

7. Cliquez sur Envoyer.

À partir de l'écran de confirmation, vous pouvez ajouter d'autres ressources à votre alerte, ajouter un abonnement à votre flux pour recevoir votre alerte ou ajouter une autre alerte. Pour afficher les détails de votre nouvelle alerte, cliquez sur Afficher les détails de l'alerte .

API

Pour créer une alerte, envoyez POSTune demande au /fabric/v4/streams/{streamId}/alertRulespoint final.

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 rattaché des Metros, vous pouvez créer des alertes intelligentes pour les seuils de latence. Ces alertes basées sur l'IA analysent les données de latence historiques sur vos sites métropolitains à l'aide de l'apprentissage automatique pour établir les performances de base et générer des seuils d'alerte SMART, éliminant ainsi le besoin de configuration manuelle des alertes.

Portal

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

1. Dans le menu déroulant sélectionner une mesure, sélectionnez la mesure de latence Fabric Metro.

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

   

3. Sélectionnez un ou plusieurs métros auxquels appliquer une règle d'alerte intelligente.

   

4. Cliquez sur Envoyer

Votre alerte apparaît dans la liste des alertes.

API

Pour créer une règle d'alerte intelligente, envoyez une POST demande au /fabric/v4/streams/{streamId}/alertRulespoint final.

Dans l'objet, spécifiez la mesure spécifique à la zone métropolitaine pour laquelle vous créez l'alertemetricSelector, la zone métropolitaine associée au flux que vous ajoutez en tant que ressource dans l'resourceSelectorobjet, puis spécifiez la detectionMethod.type zone 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 voir 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 GET demande au /fabric/v4/streams/{streamId}/alertRules/{alertRuleId}terminal.

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 sur Supprimer l'alerte.

   

API

Pour supprimer une alerte, envoyez DELETEune demande au /fabric/v4/streams/{streamId}/alertRules/{alertRuleId}point final.

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"
    }
}