Send alert events to EventBridge - Application Real-Time Monitoring Service: Central de Documentação do Alibaba Cloud

Como funciona

O ARMS publica eventos de alerta no seu barramento de eventos personalizado do EventBridge por meio de uma integração de notificação.
Cada evento segue a especificação CloudEvents 1.0 e é compatível com o formato de webhook do Alertmanager open source.
Consuma os eventos do EventBridge para conectar-se a plataformas de terceiros e implementar correções automatizadas ou integrar sistemas de chamados.

Etapa 1: Criar recursos do EventBridge

Antes de configurar a integração do ARMS, configure um barramento de eventos e uma origem de eventos no EventBridge.

Crie um barramento de eventos personalizado. Para mais detalhes, consulte Manage custom event buses. Após criar o barramento de eventos, copie o endpoint público na página Event Bus Overview. Você precisará desse valor na Etapa 2.
Adicione uma origem de eventos personalizada ao barramento de eventos. Para mais detalhes, consulte Manage custom event sources. Anote o nome da origem de eventos. Você também precisará desse valor na Etapa 2.

Etapa 2: Configurar a integração do EventBridge no ARMS

Faça login no console do ARMS.
No painel de navegação à esquerda, escolha Alert Management > Integrations.
Clique em Notification Integration e clique em EventBridge.

Na caixa de diálogo Add Integration, configure os parâmetros a seguir e clique em Save.

Parâmetro	Descrição	Exemplo
Name	Nome de exibição desta integração.	`EventBridge integration`
Description	Opcional. Breve descrição da integração.	--
Endpoint	Endpoint público do barramento de eventos criado na Etapa 1.	`https://xxxx.eventbridge.cn-hangzhou.aliyuncs.com`
AccessKey	AccessKey ID da sua conta Alibaba Cloud. Para mais detalhes, consulte Obtain an AccessKey pair.	`LTAI5tXxx`
AccessKey Secret	AccessKey secret da sua conta Alibaba Cloud. Para mais detalhes, consulte Obtain an AccessKey pair.	`xXxXxXx`
Message Bus Name	Nome do barramento de eventos criado na Etapa 1.	`armstest`
regionId	ID da região onde reside o barramento de eventos.	`cn-hangzhou`
Event Source Name	Nome da origem de eventos criada na Etapa 1.	`arms`

Etapa 3: Configurar uma política de notificação

Vincule a integração do EventBridge a uma política de notificação para encaminhar os alertas correspondentes ao EventBridge.

No console do ARMS, acesse a configuração da política de notificação.
Crie ou edite uma política de notificação. No campo Ticket System, selecione a integração do EventBridge criada na Etapa 2.

Para mais detalhes, consulte Create and manage a notification policy.

Verificar a integração

Após concluir a configuração, confirme se os eventos chegam ao EventBridge:

Faça login no console do EventBridge.
Abra o barramento de eventos personalizado e verifique a chegada de eventos. Para mais detalhes, consulte Query events.
Clique em Event Detail na coluna Actions para inspecionar o payload do evento.

Tipos de eventos

O ARMS envia um evento para cada ação do ciclo de vida do alerta. Cada evento utiliza um valor distinto para type.

Código do evento	Ação do alerta
`aliyun:arms:alarm:create`	Alerta disparado
`aliyun:arms:alarm:claim`	Alerta assumido
`aliyun:arms:alarm:comment`	Comentário adicionado ao alerta
`aliyun:arms:alarm:close`	Alerta resolvido

As notificações repetidas configuradas em uma política de notificação são enviadas apenas aos destinatários, como um grupo do DingTalk ou um webhook. Essas repetições não acionam uma nova entrega de evento ao EventBridge. O EventBridge entrega um evento somente quando o status de um alerta muda. Uma notificação repetida reflete o estado contínuo do mesmo alerta, e não uma alteração de status.

Referência de payload do evento

Todos os eventos seguem a especificação CloudEvents 1.0. O objeto data.data é compatível com o formato de webhook do Alertmanager open source.

Campos de nível superior

Campo	Tipo	Descrição
`id`	string	ID único do evento.
`source`	string	Origem do evento. Sempre `arms`.
`type`	string	Código do evento conforme tabela acima.
`specversion`	string	Versão do CloudEvents. Sempre `1.0`.
`datacontenttype`	string	Tipo de conteúdo. Sempre `application/json`.
`subject`	string	URL única do alerta no console do ARMS.
`aliyuneventbusname`	string	Nome do barramento de eventos de destino.
`aliyunregionid`	string	ID da região do barramento de eventos.
`aliyunaccountid`	string	ID da conta Alibaba Cloud.
`aliyunpublishtime`	string	Timestamp de publicação do evento (ISO 8601).
`aliyunoriginalaccountid`	string	ID original da conta Alibaba Cloud.
`aliyunpublishaddr`	string	Endereço IP do publicador do evento.
`data`	object	Payload específico do evento. Veja abaixo.

Campos do objeto `data`

Campo	Tipo	Presente em	Descrição
`owner`	string	Todos os eventos	Proprietário do alerta (contato especificado na política de notificação).
`handler`	string	claim, comment, close	Responsável pelo tratamento do alerta.
`operator`	string	claim, comment, close	Usuário que executou a ação.
`comment`	string	Apenas comment	Conteúdo do comentário.
`solution`	string	Apenas close	Solução registrada ao resolver o alerta.
`timestamp`	number	Todos os eventos	Timestamp Unix em milissegundos.
`data`	object	Todos os eventos	Payload de alerta compatível com Alertmanager. Veja abaixo.

Campos do objeto `data.data` (compatível com Alertmanager)

Campo	Tipo	Descrição
`status`	string	`firing` ou `resolved`.
`level`	string	Nível de severidade do alerta (por exemplo, `P2`).
`dispatchRuleName`	string	Nome da regra de despacho (por exemplo, `O & M team`).
`startTime`	string	Hora de início do alerta.
`endTime`	string	Hora de término do alerta. Presente apenas quando o alerta é resolvido.
`externalURL`	string	URL da página de detalhes do alerta no console do ARMS.
`receiver`	string	Identificador do receptor.
`alerts`	array	Array de objetos de alerta individuais.
`commonLabels`	object	Rótulos compartilhados por todos os alertas do grupo.
`commonAnnotations`	object	Anotações compartilhadas por todos os alertas do grupo.
`groupLabels`	object	Rótulos usados para agrupamento de alertas.

Campos do objeto `alerts[]`

Campo	Tipo	Descrição
`fingerprint`	string	Hash único que identifica o alerta.
`status`	string	`firing` ou `resolved`.
`startsAt`	string	Hora de início do alerta (ISO 8601).
`endsAt`	string	Hora de término do alerta (ISO 8601).
`labels`	object	Rótulos chave-valor incluindo `severity`, `regionId`, `alertname` e metadados específicos do ARMS.
`annotations`	object	Anotações chave-valor incluindo `message`.

Campos específicos de cada tipo de evento

A estrutura data.data compatível com Alertmanager permanece a mesma em todos os tipos de eventos. Os seguintes campos no objeto data variam conforme o tipo de evento:

Tipo de evento	Campos adicionais em `data`
Alerta disparado (`create`)	`owner`
Alerta assumido (`claim`)	`owner`, `handler`, `operator`
Comentário adicionado (`comment`)	`owner`, `handler`, `operator`, `comment`
Alerta resolvido (`close`)	`owner`, `handler`, `operator`, `solution`

Exemplo: evento de alerta disparado

{
    "datacontenttype": "application/json",
    "aliyunaccountid": "11xxxxxxxxxxx",
    "data": {
        "owner": "xx",  // The owner of the alert. Set the value to the contact that is specified in the notification policy.
        "data": {        // The content of the alert. The alert content is compatible with the event format of the open source Alertmanager. For more information, see the official documentation of Prometheus (https://prometheus.io/docs/alerting/latest/configuration/#webhook_config).
            "alerts": [
                {
                    "fingerprint": "9b115ab3762a47b51a8efcb516d4aa50",
                    "annotations": {
                        "message": "Manually triggered test alert"
                    },
                    "startsAt": "2022-06-07T09:22:01.645000000Z",
                    "endsAt": "2022-06-07T09:27:39.099000000Z",
                    "labels": {
                        "severity": "error",
                        "regionId": "cn-hangzhou",
                        "_aliyun_arms_denoise_code": "0",
                        "_aliyun_arms_integration_name": "Custom integration",
                        "alertname": "Manually triggered alert",
                        "_aliyun_arms_product_type": "CUSTOM",
                        "_aliyun_arms_userid": "11xxxxxxxxxxx",
                        "_aliyun_arms_integration_id": "616",
                        "_aliyun_arms_is_denoise_filtered": "false"
                    },
                    "status": "firing"
                }
            ],
            "commonLabels": {
                "severity": "error",
                "regionId": "cn-hangzhou",
                "_aliyun_arms_denoise_code": "0",
                "_aliyun_arms_integration_name": "Custom integration",
                "alertname": "Manually triggered alert",
                "_aliyun_arms_product_type": "CUSTOM",
                "_aliyun_arms_userid": "11xxxxxxxxxxx",
                "_aliyun_arms_integration_id": "616",
                "_aliyun_arms_is_denoise_filtered": "false"
            },
            "externalURL": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345",
            "groupLabels": {
                "alertname": "Manually triggered alert",
            },
            "receiver": "",
            "level": "P2",
            "dispatchRuleName": "O & M team",
            "startTime": "2022-06-07 17:22:01",
            "commonAnnotations": {
                "message": "Manually triggered test alert"
            },
            "status": "firing"
        },
        "timestamp": 1654593783951
    },
    "subject": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345", // The globally unique URL of the alert.
    "aliyunoriginalaccountid": "11xxxxxxxxxxx",
    "source": "arms",
    "type": "aliyun:arms:alarm:create",
    "aliyunpublishtime": "2022-06-07T09:23:04.003Z",
    "specversion": "1.0",
    "aliyuneventbusname": "armstest",
    "id": "d997f8c775d4d15b05f3346d5863fdc6******_create",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "xx.xx.xx.xx"
}

Exemplo: evento de alerta assumido

{
    "datacontenttype": "application/json",
    "aliyunaccountid": "11xxxxxxxxxxx",
    "data": {
        "owner": "xx", // The owner of the alert.
        "handler": "xx", // The handler of the alert.
        "data": { // The content of the alert. The alert content is compatible with the event format of the open source Alertmanager. For more information, see the official documentation of Prometheus (https://prometheus.io/docs/alerting/latest/configuration/#webhook_config).
            "alerts": [
                {
                    "fingerprint": "9b115ab3762a47b51a8efcb516d4aa50",
                    "annotations": {
                        "message": "Manually triggered test alert"
                    },
                    "startsAt": "2022-06-07T09:20:43.780000000Z",
                    "endsAt": "2022-06-07T09:25:43.780000000Z",
                    "labels": {
                        "severity": "error",
                        "regionId": "cn-hangzhou",
                        "_aliyun_arms_denoise_code": "0",
                        "_aliyun_arms_integration_name": "Custom integration",
                        "alertname": "Manually triggered alert",
                        "_aliyun_arms_product_type": "CUSTOM",
                        "_aliyun_arms_userid": "11xxxxxxxxxxx",
                        "_aliyun_arms_integration_id": "616",
                        "_aliyun_arms_is_denoise_filtered": "false"
                    },
                    "status": "firing"
                }
            ],
            "commonLabels": {
                "severity": "error",
                "regionId": "cn-hangzhou",
                "_aliyun_arms_denoise_code": "0",
                "_aliyun_arms_integration_name": "Custom integration",
                "alertname": "Manually triggered alert",
                "_aliyun_arms_product_type": "CUSTOM",
                "_aliyun_arms_userid": "11xxxxxxxxxxx",
                "_aliyun_arms_integration_id": "616",
                "_aliyun_arms_is_denoise_filtered": "false"
            },
            "externalURL": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345",
            "groupLabels": {
                "alertname": "Manually triggered alert",
            },
            "receiver": "",
            "level": "P2",
            "dispatchRuleName": "O & M team",
            "startTime": "2022-06-07 17:20:43",
            "commonAnnotations": {
                "message": "Manually triggered test alert"
            },
            "status": "firing"
        },
        "operator": "xx", // The operator of the alert.
        "timestamp": 1654593717195
    },
    "subject": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345",
    "aliyunoriginalaccountid": "11xxxxxxxxxxx",
    "source": "arms",
    "type": "aliyun:arms:alarm:claim",
    "aliyunpublishtime": "2022-06-07T09:21:57.362Z",
    "specversion": "1.0",
    "aliyuneventbusname": "armstest",
    "id": "59e174db-f843-473a-9d3e-df3421******",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "118.31.XX.XX"
}

Exemplo: evento de comentário adicionado ao alerta

{
    "datacontenttype": "application/json",
    "aliyunaccountid": "11xxxxxxxxxxx",
    "data": {
        "owner": "xx", // The owner of the alert.
        "handler": "xx", // The handler of the alert.
        "data": {  // The content of the alert. The alert content is compatible with the event format of the open source Alertmanager. For more information, see the official documentation of Prometheus (https://prometheus.io/docs/alerting/latest/configuration/#webhook_config).
            "alerts": [
                {
                    "fingerprint": "9b115ab3762a47b51a8efcb516d4aa50",
                    "annotations": {
                        "message": "Manually triggered test alert"
                    },
                    "startsAt": "2022-06-07T09:20:44.000000000Z",
                    "endsAt": "2022-06-07T09:22:00.000000000Z",
                    "labels": {
                        "severity": "error",
                        "regionId": "cn-hangzhou",
                        "_aliyun_arms_denoise_code": "0",
                        "_aliyun_arms_integration_name": "Custom integration",
                        "alertname": "Manually triggered alert",
                        "_aliyun_arms_product_type": "CUSTOM",
                        "_aliyun_arms_userid": "11xxxxxxxxxxx",
                        "_aliyun_arms_integration_id": "616",
                        "_aliyun_arms_is_denoise_filtered": "false"
                    },
                    "status": "resolved"
                }
            ],
            "commonLabels": {
                "severity": "error",
                "regionId": "cn-hangzhou",
                "_aliyun_arms_denoise_code": "0",
                "_aliyun_arms_integration_name": "Custom integration",
                "alertname": "Manually triggered alert",
                "_aliyun_arms_product_type": "CUSTOM",
                "_aliyun_arms_userid": "11xxxxxxxxxxx",
                "_aliyun_arms_integration_id": "616",
                "_aliyun_arms_is_denoise_filtered": "false"
            },
            "externalURL": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345",
            "groupLabels": {
                "alertname": "Manually triggered alert",
            },
            "receiver": "",
            "level": "P2",
            "dispatchRuleName": "O & M team",
            "startTime": "2022-06-07 17:20:44",
            "endTime": "2022-06-07 17:22:00",
            "commonAnnotations": {
                "message": "Manually triggered test alert"
            },
            "status": "resolved"
        },
        "comment": "Solution: False positive", // The content of the comment.
        "operator": "xx", // The operator of the alert.
        "timestamp": 1654593720385
    },
    "subject": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345",
    "aliyunoriginalaccountid": "11xxxxxxxxxxx",
    "source": "arms",
    "type": "aliyun:arms:alarm:comment",
    "aliyunpublishtime": "2022-06-07T09:22:00.435Z",
    "specversion": "1.0",
    "aliyuneventbusname": "armstest",
    "id": "ef38ca1b-89cb-4c7c-9052-b73e15******",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "118.31.XX.XX"
}

Exemplo: evento de alerta resolvido

{
    "datacontenttype": "application/json",
    "aliyunaccountid": "11xxxxxxxxxxx",
    "data": {
        "owner": "xx", // The owner of the alert.
        "handler": "xx", // The handler of the alert.
        "data": { // The content of the alert. The alert content is compatible with the event format of the open source Alertmanager. For more information, see the official documentation of Prometheus (https://prometheus.io/docs/alerting/latest/configuration/#webhook_config).
            "alerts": [
                {
                    "fingerprint": "9b115ab3762a47b51a8efcb516d4aa50",
                    "annotations": {
                        "message": "Manually triggered test alert"
                    },
                    "startsAt": "2022-06-07T09:20:44.000000000Z",
                    "endsAt": "2022-06-07T09:22:00.000000000Z",
                    "labels": {
                        "severity": "error",
                        "regionId": "cn-hangzhou",
                        "_aliyun_arms_denoise_code": "0",
                        "_aliyun_arms_integration_name": "Custom integration",
                        "alertname": "Manually triggered alert",
                        "_aliyun_arms_product_type": "CUSTOM",
                        "_aliyun_arms_userid": "11xxxxxxxxxxx",
                        "_aliyun_arms_integration_id": "616",
                        "_aliyun_arms_is_denoise_filtered": "false"
                    },
                    "status": "resolved"
                }
            ],
            "commonLabels": {
                "severity": "error",
                "regionId": "cn-hangzhou",
                "_aliyun_arms_denoise_code": "0",
                "_aliyun_arms_integration_name": "Custom integration",
                "alertname": "Manually triggered alert",
                "_aliyun_arms_product_type": "CUSTOM",
                "_aliyun_arms_userid": "11xxxxxxxxxxx",
                "_aliyun_arms_integration_id": "616",
                "_aliyun_arms_is_denoise_filtered": "false"
            },
            "externalURL": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345",
            "groupLabels": {
                "alertname": "Manually triggered alert",
            },
            "receiver": "",
            "level": "P2",
            "dispatchRuleName": "O&M team",
            "startTime": "2022-06-07 17:20:44",
            "endTime": "2022-06-07 17:22:00",
            "commonAnnotations": {
                "message": "Manually triggered test alert"
            },
            "status": "resolved"
        },
        "solution": "", // The solution of the alert.
        "operator": "xx", // The operator of the alert.
        "timestamp": 1654593720279
    },
    "subject": "https://arms.console.alibabacloud.com/#/alarm/alert/detail/12345",
    "aliyunoriginalaccountid": "11xxxxxxxxxxx",
    "source": "arms",
    "type": "aliyun:arms:alarm:close",
    "aliyunpublishtime": "2022-06-07T09:22:00.352Z",
    "specversion": "1.0",
    "aliyuneventbusname": "armstest",
    "id": "d997f8c775d4d15b05f3346d5863fdc6******_close",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "xx.xx.xx.xx"
}

Próximos passos

What is EventBridge? -- Conheça os conceitos e a arquitetura do EventBridge.