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 tanto por um warningThreshold quanto por um criticalThreshold, disparando um evento de alerta se o valor da métrica ficar abaixo ou ultrapassar o limite esperado.

observação

Para receber o evento disparado por um Alerta, você precisa ser capaz de receber eventos de um fluxo ao qual você esteja inscrito em um coletor de sua escolha. Os eventos disparados por um Alerta não estão disponíveis no Portal do Cliente nem na API.

Para visualizar a lista de métricas suportadas, consulte a página Métricas.

Criar um alerta

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

Portal

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

2. Selecione um fluxo de dados no Inventário de Fluxos.

   

3. Na página Detalhes da Transmissão, no menu suspenso Ações, clique em Adicionar Alertas.

   

4. Na página Adicionar Alerta, insira os parâmetros da sua regra.

   • Selecione a métrica de conexão ou porta na lista suspensa Selecionar uma métrica.
   • Dê um nome ao seu alerta.
   • Adicione uma descrição ao alerta (opcional).
   • Selecione o valor do operando: ACIMA ou ABAIXO.
   • Selecione um tamanho de janela no menu suspenso.
   • 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 Próximo

6. Selecione na lista a conexão ou porta à qual deseja aplicar o alerta.

   

7. Clique em Enviar.

Na tela de confirmação, você pode adicionar mais recursos ao seu alerta, assinar o seu feed para receber alertas ou adicionar um novo alerta. Para ver os detalhes do seu novo alerta, clique em Ver detalhes do alerta.

API

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

Exemplo de solicitação 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
    }
}'

Exemplo de resposta:

{
    "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 Streams onde você tem Metros anexados, você pode criar alertas inteligentes para limites de latência. Esses alertas com inteligência artificial analisam dados históricos de latência em suas localizações de metro usando aprendizado de máquina para estabelecer o desempenho de referência e gerar limites de alerta inteligentes, eliminando a necessidade de configuração manual de alertas.

Portal

Para criar uma regra de alerta inteligente, siga os mesmos passos descritos em Criar um Alerta e:

1. Selecione a métrica Latência da Rede Metropolitana no menu suspenso Selecionar uma Métrica.

2. Dê um nome e uma descrição ao seu alerta (opcional). Clique em Próximo.

   

3. Selecione uma ou mais estações de metrô às quais deseja aplicar uma regra de alerta inteligente.

   

4. Clique em Enviar

Seu alerta aparece na lista de alertas.

API

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

Especifique a métrica específica do Metro para a qual você está criando o alerta no objeto metricSelector, o Metro que está associado ao fluxo que você está adicionando como recurso no objeto resourceSelector 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 fluxo:

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

2. Selecione um fluxo de dados no Inventário de Fluxos.

   

3. Clique em Alertas.

   

API

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

Exemplo de solicitação cURL:

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

Exemplo de resposta:

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

Excluindo um alerta

Portal

Para excluir um alerta:

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

2. Selecione um fluxo de dados no Inventário de Fluxos.

   

3. Clique em Alertas.

4. Na lista de alertas, clique no menu de opções daquele que deseja excluir e clique em Remover alerta.

   

API

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

Exemplo de solicitação cURL:

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

Exemplo de resposta:

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