Alertas

Crie regras de alerta para enviar um evento de alerta quando uma métrica ultrapassar um valor limite definido. Os alertas podem ser acionados em um warningThreshold e em um criticalThreshold, acionando um evento de alerta se o valor da métrica cair abaixo ou exceder o limite esperado.

observação

Para receber o evento acionado por um Alerta, você precisa ser capaz de receber eventos de um fluxo para o qual você tem uma assinatura em um coletor de sua escolha. Os eventos acionados por um Alerta não estão disponíveis no Portal do Cliente ou na API.

Para visualizar a lista de métricas compatíveis, consulte a páginaMétricas.

Criando um alerta

Pré-requisito: Para adicionar uma regra de alerta, você deve ter um fluxo criado com os recursos de Porta e/ou Conexão anexados e a métrica ativada

Portal

1. No menu Observabilidade, clique em Fluxos de dados.

2. Selecione um fluxo no Stream Inventory.

   

3. Na página Stream Details, no menu suspenso Actions, clique em Add Alerts.

   

4. Na página Add Alert, insira os parâmetros da regra.

   • Selecione a métrica de conexão ou porta no menu suspenso Select a Metric.
   • Dê um nome ao seu Alerta.
   • Adicione uma Descrição do alerta (opcional).
   • Selecione o valor do operando: ABOVE Ou BELOW.
   • Selecione um tamanho de janela na lista suspensa.
   • Defina o valor para acionar um evento de aviso no campo Limite de aviso.
   • Defina o valor para acionar um evento crítico no campo Limite crítico.

   

5. Clique em Avançar.

6. Selecione a Conexão ou Porta para aplicar o Alerta na lista.

   

7. 5. Clique em Submeter.

Na tela de confirmação, você pode adicionar mais recursos ao seu alerta, adicionar uma assinatura à sua transmissão para receber seu alerta ou adicionar outro alerta. Para ver os detalhes do seu novo alerta, clique em Ver detalhes do alerta.

API

Para criar um alerta, envie uma POST solicitação para o /fabric/v4/streams/{streamId}/alertRules endpoint.

Solicitação de ondulação de amostra:

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

Resposta da amostra:

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

Criando alertas inteligentes - latência

Para fluxos em que você conectou Metrôs, você pode criar alertas inteligentes para limites de latência. Esses alertas alimentados por IA analisam os dados históricos de latência em seus locais metropolitanos usando aprendizado de máquina para estabelecer o desempenho da linha de base e gerar limites de alerta inteligentes, eliminando a necessidade de configuração manual de alertas.

Portal

Para criar uma regra de alerta inteligente, siga as mesmas etapas para Criar um Alerta e:

1. Selecione a métrica Fabric Metro Latency no menu suspenso Select a Metric.

2. Dê ao alerta um nome e uma descrição (opcional). Clique em Avançar.

   

3. Selecione um Metrô ou Metrôs para aplicar uma regra de alerta inteligente.

   

4. 5. Clique em Submeter.

Seu alerta aparece na lista de alertas.

API

Para criar uma regra de alerta inteligente, envie uma POST solicitação para o /fabric/v4/streams/{streamId}/alertRules endpoint.

Especifique a métrica específica do Metro para a qual você está criando o alerta no metricSelectorobjeto, o Metro que está anexado ao fluxo que você está adicionando como um recurso no resourceSelectorobjeto e especifique o detectionMethod.type como 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"
    }
}'

Recuperando seus alertas

Portal

Para ver a lista de Alertas de um Stream:

1. No menu Observabilidade, clique em Fluxos de dados.

2. Selecione um fluxo no Stream Inventory.

   

3. Clique em Alertas.

   

API

Para obter os detalhes de um alerta, envie uma GET solicitação para o /fabric/v4/streams/{streamId}/alertRules/{alertRuleId} endpoint.

Solicitação de ondulação de amostra:

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

Resposta da amostra:

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

Excluir um alerta

Portal

Para excluir um alerta:

1. No menu Observabilidade, clique em Fluxos de dados.

2. Selecione um fluxo no Stream Inventory.

   

3. Clique em Alertas.

4. Na lista de Alertas, clique no menu de opções do que você deseja excluir, clique em Remover Alerta.

   

API

Para excluir um Alerta, envie uma DELETE solicitação para o /fabric/v4/streams/{streamId}/alertRules/{alertRuleId} endpoint.

Solicitação de ondulação de amostra:

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

Resposta da amostra:

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