Como configurar alertas e obter notificações usando um gancho
Importante
A partir de 20 de setembro de 2023, não será mais possível criar novos recursos do Assistente de Métricas. O serviço Assistente de Métricas será desativado no dia 1º de outubro de 2026.
Após uma anomalia ser detectada pelo Assistente de Métricas, uma notificação de alerta será disparada com base nas configurações do alerta usando um gancho. Uma configuração de alerta pode ser usada com várias configurações de detecção e diversos parâmetros estão disponíveis para personalizar sua regra de alerta.
Criar um gancho
O Assistente de Métricas dá suporte a quatro tipos diferentes de ganchos: email, Teams, web hook e Azure DevOps. Escolha o que funciona para seu cenário específico.
Gancho de email
Observação
Os administradores de recursos do Assistente de Métricas precisam definir as configurações de email e inserir informações relacionadas ao SMTP no Assistente de Métricas antes que alertas de anomalias possam ser enviados. O administrador do grupo de recursos ou da assinatura precisa atribuir pelo menos uma função de Administrador do Assistente de Métricas dos Serviços Cognitivos na guia Controle de Acesso do recurso Assistente de Métricas. Saiba mais sobre a definição de configurações de email.
Um gancho de email é o canal para que alertas de anomalias sejam enviados aos endereços de email especificados na seção Email para. Dois tipos de emails de alerta serão enviados: alertas de Feed de dados não disponível e Relatórios de incidentes que contêm uma ou várias anomalias.
Para criar um gancho de email, os seguintes parâmetros estão disponíveis:
| Parâmetro | Descrição |
|---|---|
| Nome | Nome do gancho de email |
| Email para | Endereços de email para os quais enviar alertas |
| Link externo | Campo opcional que habilita um redirecionamento personalizado, por exemplo, para notas de solução de problemas. |
| Título do alerta de anomalia personalizado | O modelo de título dá suporte a ${severity}, ${alertSettingName}, ${datafeedName}, ${metricName}, ${detectConfigName}, ${timestamp}, ${topDimension}, ${incidentCount}, ${anomalyCount} |
Após você selecionar OK, um gancho de email será criado. Use-o em qualquer configuração de alerta para receber alertas de anomalias. Consulte o tutorial de ativar a notificação de anomalia no Assistente de Métricas para obter etapas detalhadas.
Gancho do Teams
Um gancho do Teams é o canal para que os alertas de anomalias sejam enviados a um canal no Microsoft Teams. Um gancho do Teams é implementado por meio de um conector “Webhook de entrada”. Talvez seja necessário criar um conector “Webhook de entrada” à frente no canal do Teams de destino e obter uma URL dele. Em seguida, dinamize para o workspace do Assistente de Métricas.
Selecione a guia “Ganchos” na barra de navegação à esquerda e pressione o botão “Criar gancho” na parte superior direita da página. Escolha o tipo de gancho do “Teams”, os seguintes parâmetros são fornecidos:
| Parâmetro | Descrição |
|---|---|
| Nome | Nome do gancho do Teams |
| URL do conector | A URL que acabou de ser copiada do conector "Webhook de entrada" que foi criado no canal do Teams de destino. |
Após você selecionar OK, um gancho do Teams será criado. Você pode usá-la em qualquer configuração de alerta para notificar os alertas de anomalias para o canal do Teams de destino. Consulte o tutorial de ativar a notificação de anomalia no Assistente de Métricas para obter etapas detalhadas.
Web hook
Um web hook é outro canal de notificação usando um ponto de extremidade que é fornecido pelo cliente. Qualquer anomalia detectada na série temporal será notificada por meio de um web hook. Há várias etapas para habilitar um web hook como canal de notificação de alerta no Assistente de Métricas.
Etapa 1. Habilitar Identidade Gerenciada no recurso do Assistente de Métricas
Uma identidade gerenciada atribuída ao sistema é restrita a uma por recurso e está vinculada ao ciclo de vida deste recurso. Você pode conceder permissões para a identidade gerenciada usando o RBAC do Azure (controle de acesso baseado em função do Azure). A identidade gerenciada é autenticada com o Microsoft Entra ID, portanto, você não precisa armazenar nenhuma credencial no código.
Acesse o recurso do Assistente de Métricas no portal do Azure e selecione “Identidade”, altere-o para “Ativado” e a Identidade Gerenciada está habilitada.
Etapa 2. Criar um web hook no workspace do Assistente de Métricas
Faça logon no workspace e selecione a guia “Ganchos” e, em seguida, selecione o botão “Criar gancho”.
Para criar um web hook, adicione as seguintes informações:
| Parâmetro | Descrição |
|---|---|
| Ponto de extremidade | O endereço da API a ser chamada quando um alerta for disparado. DEVE ser Https. |
| Nome de usuário + senha | Para autenticação no endereço da API. Deixe em branco se a autenticação não for necessária. |
| parâmetro | Cabeçalhos personalizados na chamada à API. |
| Identificador do certificado no Azure Key Vaults | Se o acesso ao ponto de extremidade precisar ser autenticado por um certificado, o certificado deverá ser armazenado no Azure Key Vaults. Insira o identificador aqui. |
Observação
Quando um web hook for criado ou modificado, o ponto de extremidade será chamado como teste, com um corpo de solicitação vazio. Sua API precisa retornar um código HTTP 200 para passar a validação com êxito.
- O método de solicitação é o POST
- Tempo limite de 30s
- Tentar novamente para o erro 5xx, ignore outros erros. Não seguirá a solicitação de redirecionamento 301/302.
- Corpo da solicitação:
{
"value": [{
"hookId": "b0f27e91-28cf-4aa2-aa66-ac0275df14dd",
"alertType": "Anomaly",
"alertInfo": {
"anomalyAlertingConfigurationId": "1bc6052e-9a2a-430b-9cbd-80cd07a78c64",
"alertId": "172536dbc00",
"timestamp": "2020-05-27T00:00:00Z",
"createdTime": "2020-05-29T10:04:45.590Z",
"modifiedTime": "2020-05-29T10:04:45.590Z"
},
"callBackUrl": "https://kensho2-api.azurewebsites.net/alert/anomaly/configurations/1bc6052e-9a2a-430b-9cbd-80cd07a78c64/alerts/172536dbc00/incidents"
}]
}
Etapa3. (opcional) Armazene seu certificado no Azure Key Vaults e obtenha o identificador Conforme mencionado, se o acesso ao ponto de extremidade precisar ser autenticado por um certificado, o certificado deverá ser armazenado no Azure Key Vaults.
- Verifique Definir e recuperar um certificado do Azure Key Vault usando o portal do Azure
- Clique no certificado que você adicionou e, em seguida, você poderá copiar o “Identificador de certificado”.
- Em seguida, selecione “Políticas de acesso” e “Adicionar política de acesso”, conceda permissão “Get” para “Permissões de chave”, “Permissões secretas” e “Permissões de certificado”. Selecione entidade como o nome do recurso do Assistente de Métricas. Selecione o botão "Adicionar" e "Salvar" na página "Políticas de acesso".
Etapa 4. Receber notificação de anomalia Quando uma notificação é enviada por um web hook, você pode buscar dados de incidentes chamando o “callBackUrl” na Solicitação de Webhook. Detalhes desta API:
Usando o web hook e os Aplicativos Lógicos do Azure, é possível enviar uma notificação por email sem um servidor SMTP configurado. Consulte o tutorial de ativar a notificação de anomalia no Assistente de Métricas para obter etapas detalhadas.
Azure DevOps
O Assistente de Métricas também dá suporte à criação automática de um item de trabalho no Azure DevOps para acompanhar problemas/bugs quando uma anomalia é detectada. Todos os alertas podem ser enviados por meio de ganchos do Azure DevOps.
Para criar um gancho do Azure DevOps, adicione as seguintes informações:
| Parâmetro | Descrição |
|---|---|
| Nome | Um nome para o gancho |
| Organização | A organização à qual o DevOps pertence |
| Project | O projeto específico no DevOps. |
| Token de acesso | Um token para autenticação no DevOps. |
Observação
Você precisará conceder permissões de gravação se quiser que o Assistente de Métricas crie itens de trabalho com base em alertas de anomalias. Depois de criar ganchos, você pode usá-los em qualquer uma das configurações de alerta. Gerencie os ganchos na página configurações do gancho.
Adicionar ou editar configurações de alerta
Vá para a página de detalhes de métricas para localizar a seção Configurações de alerta no canto inferior esquerdo da página. Ela lista todas as configurações de alerta que se aplicam à configuração de detecção selecionada. Quando uma configuração de detecção é criada, não há nenhuma configuração de alerta e nenhum alerta será enviado.
Use os ícones adicionar, editar e excluir para modificar as configurações de alerta.
Selecione os botões adicionar ou editar para chegar a uma janela para adicionar ou editar as configurações de alerta.
Nome da configuração de alerta: o nome da configuração de alerta. Ele será exibido no título do email de alerta.
Ganchos: a lista de ganchos para os quais enviar alertas.
A seção marcada na captura de tela acima são as definições de uma configuração de detecção. Use definições de alerta diferentes para configurações de detecção diferentes. Escolha a configuração de destino usando a terceira lista suspensa na janela.
Configurações de filtro
Veja a seguir as configurações de filtro para uma configuração de detecção.
Alerta para tem quatro opções de filtragem de anomalias:
- Anomalias em todas as séries: todas as anomalias serão incluídas no alerta.
- Anomalias no grupo de séries: filtre a série segundo os valores de dimensão. Defina valores específicos para algumas dimensões. As anomalias serão incluídas no alerta apenas quando a série corresponder ao valor especificado.
- Anomalias na série favorita: somente a série marcada como favorita será incluída no alerta. |
- Anomalias nos N maiores de todas as séries: esse filtro é usado no caso em que você só se preocupa com a série cujo valor está nos N maiores. O Assistente de Métricas examinará carimbos de data/hora anteriores e verificará se os valores da série nesses carimbos de data/hora estão nos N maiores. Se a contagem "nos N maiores" for maior que o número especificado, a anomalia será incluída em um alerta. |
Filtrar opções de anomalias é um filtro adicional com as seguintes opções:
- Gravidade: a anomalia só será incluída quando a gravidade dela estiver no intervalo especificado.
- Adiar: parar alertas temporariamente para anomalias nos próximos N pontos (período), quando disparado em um alerta.
- Tipo de adiamento: quando definido como Série, uma anomalia disparada só adiará sua série. Para Métrica, uma anomalia disparada adiará todas as séries nessa métrica.
- Número de adiamento: o número de pontos (períodos) para adiar.
- Redefinir para não sucessivo: quando selecionado, uma anomalia disparada só adiará as próximas n anomalias sucessivas. Se um dos pontos de dados a seguir não for uma anomalia, o adiamento será redefinido desse ponto. Quando não selecionado, uma anomalia disparada adiará os próximos n pontos (períodos), mesmo que os pontos de dados sucessivos não sejam anomalias.
- Valor (opcional): filtrar por valor. Somente anomalias com valores de ponto que atendem à condição serão incluídas. Se você usar o valor correspondente a outra métrica, os nomes de dimensão das duas métricas deverão ser consistentes.
Anomalias não filtradas serão enviadas em um alerta.
Adicionar configurações de métrica cruzada
Selecione + Adicionar configurações de métrica cruzada na página de configurações do alerta para adicionar outra seção.
O seletor de Operador é a relação lógica de cada seção, para determinar se eles enviam um alerta.
| Operador | Descrição |
|---|---|
| AND | Enviar um alerta somente se uma série corresponder a cada seção de alerta e todos os pontos de dados forem anomalias. Se as métricas tiverem nomes de dimensão diferentes, um alerta nunca será disparado. |
| OU | Enviar o alerta se pelo menos uma seção contiver anomalias. |
