Tutorial: Ativar a notificação de anomalia no Consultor de Métricas

Importante

A partir de 20 de setembro de 2023, você não poderá criar novos recursos do Consultor de Métricas. O serviço de Consultor de Métricas será desativado no dia 1º de outubro de 2026.

Neste tutorial, irá aprender a:

• Criar um gancho no Consultor de Métricas
• Enviar notificações com os Aplicativos Lógicos do Azure
• Enviar notificações para o Microsoft Teams
• Enviar notificações via servidor SMTP

Pré-requisitos

Criar um recurso do Consultor de Métricas

Para explorar os recursos do Metrics Advisor, talvez seja necessário criar um recurso do Metrics Advisor no portal do Azure para implantar sua instância do Metrics Advisor.

Criar um gancho no Consultor de Métricas

Um gancho no Metrics Advisor é uma ponte que permite que o cliente assine anomalias de métricas e envie notificações por meio de diferentes canais. Há quatro tipos de ganchos no Metrics Advisor:

• Gancho de e-mail
• Webhook
• Equipas gancho
• Gancho do Azure DevOps

Cada tipo de gancho corresponde a um canal específico através do qual a anomalia será notificada.

Enviar notificações com Aplicativos Lógicos do Azure, Teams e SMTP

Aplicações Lógicas

Enviar notificação por email usando os Aplicativos Lógicos do Azure

Há duas opções comuns para enviar notificações por e-mail que são suportadas no Metrics Advisor. Um é usar webhooks e Aplicativos Lógicos do Azure para enviar alertas de email, o outro é configurar um servidor SMTP e usá-lo para enviar alertas de email diretamente. Esta seção se concentrará na primeira opção, que é mais fácil para clientes que não têm um servidor SMTP disponível.

Etapa 1: Criar um webhook no Metrics Advisor

Um webhook é o ponto de entrada para todas as informações disponíveis no serviço Metrics Advisor e chama uma API fornecida pelo usuário quando um alerta é acionado. Todos os alertas podem ser enviados através de um webhook.

Selecione a guia Ganchos no espaço de trabalho do Consultor de Métricas e selecione o botão Criar gancho . Escolha um tipo de gancho de gancho de web. Preencha os parâmetros necessários e selecione OK. Para obter etapas detalhadas, consulte Criar um webhook.

Há um parâmetro extra de Endpoint que precisa ser preenchido, isso pode ser feito depois de concluir a Etapa 3 abaixo.

Etapa 2: Criar um recurso de aplicativo lógico de consumo

No portal do Azure, crie um recurso de aplicativo lógico de consumo com um fluxo de trabalho em branco seguindo as instruções em Criar um fluxo de trabalho de aplicativo lógico de consumo de exemplo. Quando você vir que o designer de fluxo de trabalho é aberto, retorne a este tutorial.

Etapa 3: Adicionar um gatilho de Quando uma solicitação HTTP é recebida

• Os Aplicativos Lógicos do Azure usam várias ações para disparar fluxos de trabalho definidos. Para esse caso de uso, ele usa o gatilho chamado Quando uma solicitação HTTP é recebida.

• Na caixa de diálogo Quando uma solicitação HTTP é recebida, selecione Usar carga útil de exemplo para gerar esquema.

  

  Copie o JSON de exemplo a seguir para a caixa de texto e selecione Concluído.

  {
  "properties": {
      "value": {
          "items": {
              "properties": {
                  "alertInfo": {
                      "properties": {
                          "alertId": {
                              "type": "string"
                          },
                          "anomalyAlertingConfigurationId": {
                              "type": "string"
                          },
                          "createdTime": {
                              "type": "string"
                          },
                          "modifiedTime": {
                              "type": "string"
                          },
                          "timestamp": {
                              "type": "string"
                          }
                      },
                      "type": "object"
                  },
                  "alertType": {
                      "type": "string"
                  },
                  "callBackUrl": {
                      "type": "string"
                  },
                  "hookId": {
                      "type": "string"
                  }
              },
              "required": [
                  "hookId",
                  "alertType",
                  "alertInfo",
                  "callBackUrl"
              ],
              "type": "object"
          },
          "type": "array"
      }
  },
  "type": "object"
   }
  

• Escolha o método como 'POST' e selecione Salvar. Agora você pode ver a URL do seu gatilho de solicitação HTTP. Selecione o ícone de cópia para copiá-lo e preencha-o novamente no Endpoint na Etapa 1.

  

Etapa 4: Adicionar uma próxima etapa usando a ação 'HTTP'

Os sinais que são enviados através do webhook contêm apenas informações limitadas, como carimbo de data/hora, alertID, configurationID, etc. Informações detalhadas precisam ser consultadas usando o URL de retorno de chamada fornecido no sinal. Esta etapa é consultar informações detalhadas do alerta.

• Escolha um método de 'GET'

• Selecione 'callBackURL' na lista 'Conteúdo dinâmico' em 'URI'.

• Digite uma chave de 'Content-Type' em 'Headers' e insira um valor de 'application/json'

• Insira uma chave de 'x-api-key' em 'Cabeçalhos' e obtenha isso clicando na guia 'Chaves de API' no espaço de trabalho do Consultor de Métricas. Esta etapa é para garantir que o fluxo de trabalho tenha permissões suficientes para chamadas de API.

  

Etapa 5: Adicione uma próxima etapa para 'analisar JSON'

Você precisa analisar a resposta da API para facilitar a formatação do conteúdo do e-mail.

Nota

Este tutorial compartilha apenas um exemplo rápido, o formato de e-mail final precisa ser mais projetado.

• Selecione 'Corpo' na lista 'Conteúdo dinâmico' em 'Conteúdo'
• selecione Usar carga útil de exemplo para gerar esquema. Copie o JSON de exemplo a seguir para a caixa de texto e selecione Concluído.

{
    "properties": {
        "@@nextLink": {},
        "value": {
            "items": {
                "properties": {
                    "properties": {
                        "properties": {
                            "IncidentSeverity": {
                                "type": "string"
                            },
                            "IncidentStatus": {
                                "type": "string"
                            }
                        },
                        "type": "object"
                    },
                    "rootNode": {
                        "properties": {
                            "createdTime": {
                                "type": "string"
                            },
                            "detectConfigGuid": {
                                "type": "string"
                            },
                            "dimensions": {
                                "properties": {
                                },
                                "type": "object"
                            },
                            "metricGuid": {
                                "type": "string"
                            },
                            "modifiedTime": {
                                "type": "string"
                            },
                            "properties": {
                                "properties": {
                                    "AnomalySeverity": {
                                        "type": "string"
                                    },
                                    "ExpectedValue": {}
                                },
                                "type": "object"
                            },
                            "seriesId": {
                                "type": "string"
                            },
                            "timestamp": {
                                "type": "string"
                            },
                            "value": {
                                "type": "number"
                            }
                        },
                        "type": "object"
                    }
                },
                "required": [
                    "rootNode",
                    "properties"
                ],
                "type": "object"
            },
            "type": "array"
        }
    },
    "type": "object"
}

Etapa 6: Adicione uma próxima etapa para 'criar tabela HTML'

Um monte de informações foi retornado da chamada de API, no entanto, dependendo dos seus cenários, nem todas as informações podem ser úteis. Escolha os itens que lhe interessam e que gostariam de incluir no e-mail de alerta.

Abaixo está um exemplo de uma tabela HTML que escolhe 'timestamp', 'metricGUID' e 'dimension' para ser incluída no e-mail de alerta.

Passo 7: Adicione o passo final para "enviar um e-mail"

Existem várias opções para enviar e-mails, tanto hospedadas pela Microsoft quanto ofertas de terceiros. O cliente pode precisar ter um inquilino/conta para a opção escolhida. Por exemplo, ao escolher 'Office 365 Outlook' como o servidor. O processo de login será bombeado para conexão e autorização do edifício. Uma conexão API será estabelecida para usar o servidor de e-mail para enviar alerta.

Preencha o conteúdo que você gostaria de incluir para 'Corpo', 'Assunto' no e-mail e preencha um endereço de e-mail em 'Para'.

Canal Teams

Enviar notificação de anomalia através de um canal do Microsoft Teams

Esta seção explicará a prática de enviar notificações de anomalia por meio de um canal do Microsoft Teams. Isso pode ajudar a habilitar cenários em que os membros da equipe estão colaborando na análise de anomalias detetadas pelo Consultor de Métricas. O fluxo de trabalho é fácil de configurar e não tem um grande número de pré-requisitos.

Etapa 1: adicionar um conector 'Webhook de entrada' ao seu canal do Teams

• Navegue até o canal do Teams para o qual você deseja enviar notificação, selecione '•••'(Mais opções).

• Na lista suspensa, selecione 'Conectores'. Dentro da nova caixa de diálogo, procure por 'Incoming Webhook' e clique em 'Add'.

  

• Se não conseguir ver a opção 'Conectores', contacte os proprietários do seu grupo do Teams. Selecione 'Gerir equipa', depois selecione o separador 'Definições' na parte superior e verifique se a definição de 'Permitir que os membros criem, atualizem e removam conectores' está marcada.

  

• Insira um nome para o conector e você também pode carregar uma imagem para torná-lo como o avatar. Selecione 'Criar' e, em seguida, o conector Webhook de entrada é adicionado com êxito ao seu canal. Será gerado um URL na parte inferior da caixa de diálogo, certifique-se de que seleciona 'Copiar' e, em seguida, selecione 'Concluído'.

  

Etapa 2: criar um novo 'gancho do Teams' no Consultor de Métricas

• Selecione a guia 'Ganchos' na barra de navegação esquerda e selecione o botão 'Criar gancho' no canto superior direito da página.

• Escolha o tipo de gancho de 'Teams', insira um nome e cole o URL que você copiou da etapa acima.

• Selecione 'Guardar'.

  

Etapa 3: Aplicar o gancho do Teams a uma configuração de alerta

Vá e selecione um dos feeds de dados que você integrou. Selecione uma métrica no feed e abra a página de detalhes das métricas. Pode criar uma 'configuração de alerta' para subscrever anomalias detetadas e notificar através de um canal do Teams.

Selecione o botão '+' e escolha o gancho que criou, preencha outros campos e selecione 'Guardar'. Em seguida, você está definido para aplicar um gancho do Teams a uma configuração de alerta. Qualquer nova anomalia será notificada através do canal Teams.

SMTP E-mail

Enviar notificação por e-mail configurando um servidor SMTP

Esta seção compartilhará a prática de usar um servidor SMTP para enviar notificações por e-mail sobre anomalias detetadas. Verifique se você tem um servidor SMTP utilizável e tem permissão suficiente para obter parâmetros como nome da conta e senha.

Etapa 1: atribuir sua conta como a função "Administrador do Consultor de Métricas dos Serviços Cognitivos"

• Um usuário com privilégios de administrador de assinatura ou administrador de grupo de recursos precisa navegar até o recurso do Consultor de Métricas que foi criado no portal do Azure e selecionar a guia Controle de acesso (IAM).
• Selecione 'Adicionar atribuições de função'.
• Escolha uma função de 'Administrador do Consultor de Métricas de Serviços Cognitivos', selecione sua conta como na imagem abaixo.
• Selecione o botão 'Salvar' e, em seguida, você foi adicionado com sucesso como administrador de um recurso do Consultor de Métricas. Todas as ações acima precisam ser executadas por um administrador de assinatura ou administrador de grupo de recursos. Pode levar até um minuto para que as permissões se propaguem.

Etapa 2: Configurar o servidor SMTP no espaço de trabalho do Consultor de Métricas

Depois de concluir as etapas acima e ter sido adicionado com êxito como administrador do recurso do Consultor de Métricas. Aguarde alguns minutos para que as permissões se propaguem. Em seguida, entre no espaço de trabalho do Consultor de Métricas, você poderá visualizar uma nova guia chamada "Configuração de e-mail" no painel de navegação esquerdo. Selecione-o e continue a configuração.

Parâmetros a preencher:

• Nome do servidor SMTP (obrigatório): Preencha o nome do seu provedor de servidor SMTP, a maioria dos nomes de servidor são escritos no formulário "smtp.domain.com" ou "mail.domain.com". Tome o Office365 como exemplo, ele deve ser definido como 'smtp.office365.com'.
• Porta do servidor SMTP (obrigatório): A porta 587 é a porta padrão para envio SMTP na Web moderna. Embora você possa usar outras portas para envio (mais sobre as próximas), você deve sempre começar com a porta 587 como padrão e usar apenas uma porta diferente se as circunstâncias ditarem (como o host bloqueando a porta 587 por algum motivo).
• Remetente(s) de e-mail(s)(obrigatório): Esta é a conta de e-mail real que assume a responsabilidade de enviar e-mails. Poderá ter de preencher o nome da conta e a palavra-passe do remetente. Você pode definir um limite de cota para o número máximo de e-mails de alerta a serem enviados dentro de um minuto para uma conta. Você pode definir vários remetentes se houver a possibilidade de ter um grande volume de alertas a serem enviados em um minuto, mas pelo menos uma conta deve ser definida.
• Enviar em nome de (opcional): se você tiver vários remetentes configurados, mas quiser que os e-mails de alerta pareçam ser enviados de uma conta. Você pode usar este campo para alinhá-los. Mas observe que você pode precisar conceder permissão aos remetentes para permitir o envio de e-mails em nome de sua conta.
• CC padrão (opcional): Para definir um endereço de e-mail padrão que será cc'd em todos os alertas de e-mail.

Abaixo está um exemplo de um servidor SMTP configurado:

Etapa 3: Criar um gancho de e-mail no Consultor de Métricas

Depois de configurar com êxito um servidor SMTP, você está configurado para criar um 'gancho de e-mail' na guia 'Ganchos' no Consultor de Métricas. Para obter mais informações sobre como criar um 'gancho de e-mail', consulte o artigo sobre alertas e siga as etapas para conclusão.

Etapa 4: Aplicar o gancho de e-mail a uma configuração de alerta

Vá e selecione um dos feeds de dados que você integrou, selecione uma métrica dentro do feed e abra a página de detalhes das métricas. Pode criar uma 'configuração de alerta' para subscrever as anomalias que foram detetadas e enviadas através de e-mails.

Selecione o botão '+' e escolha o gancho que criou, preencha outros campos e selecione 'Guardar'. Agora você configurou com sucesso um gancho de e-mail com uma configuração de alerta personalizada e quaisquer novas anomalias serão escaladas através do gancho usando o servidor SMTP.

Próximos passos

Avance para o próximo artigo para saber como criar.

Escrever uma consulta válida