Alertes

Créez des règles d'alerte pour envoyer un événement d'alerte lorsqu'une métrique franchit une valeur seuil définie. Les alertes peuvent se déclencher à la fois sur un warningThreshold et un criticalThreshold, déclenchant un événement d'alerte si la valeur de la métrique est inférieure ou supérieure au seuil attendu.

note

Pour recevoir l'événement déclenché par une alerte, vous devez être en mesure de recevoir les é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 dans le portail client ou l'API.

Pour consulter la liste des mesures prises en charge, reportez-vous à la page Metrics.

Créer une alerte

Prérequis : Pour ajouter une règle d'alerte, vous devez avoir créé un flux avec des ressources de port et/ou de connexion attachées et une métrique activée.

Portal

1. Dans le menu Observabilité, cliquez sur Data Streams.

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 Add Alert, entrez les paramètres de votre règle.

   • Sélectionnez la métrique de connexion ou de port dans le menu déroulant Select a Metric.
   • 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.
   • Définissez la valeur de déclenchement d'un événement d'alerte dans le champ Warning Threshold (seuil d'alerte).
   • Définissez la valeur de déclenchement d'un événement critique dans le champ Critical Threshold.

   

5. Cliquez sur Suivant

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

   

7. Cliquez sur Soumettez.

À 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 voir les détails de votre nouvelle alerte, cliquez sur View Alert Details.

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 pour lesquels vous avez attached Metros, vous pouvez créer des alertes intelligentes pour les seuils de latence. Ces alertes alimentées par l'IA analysent les données historiques de latence à travers vos emplacements métropolitains à l'aide de l'apprentissage automatique pour établir la performance de base et générer des seuils d'alerte intelligents, éliminant ainsi le besoin d'une configuration manuelle des alertes.

Portal

Pour créer une règle d'alerte intelligente, suivez les mêmes étapes que pour la [Création d'une alerte] (#creating-an-alert), et :

1. Sélectionnez la métrique Fabric Metro Latency dans le menu déroulant Select a Metric.

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

   

3. Sélectionnez un ou plusieurs métros auxquels 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 au métro pour laquelle vous créez l'alerte dans l'objet metricSelector, le métro qui est attaché au flux que vous ajoutez comme ressource dans l'objet resourceSelector, et spécifiez le 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 voir la liste des alertes pour un flux :

1. Dans le menu Observabilité, cliquez sur Data Streams.

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 Data Streams.

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 l'alerte que vous souhaitez supprimer, 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"
    }
}