Tutorial: Habilitar a notificação de anomalias no Assistente de Métricas

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.

Neste tutorial, você aprenderá a:

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

Pré-requisitos

Criar um recurso do Assistente de Métricas

Para explorar os recursos do Assistente de Métricas, você precisará para criar um recurso do Assistente de Métricas no portal do Azure para implantar sua instância do Assistente de Métricas.

Criar um gancho no Assistente de Métricas

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

• Gancho de email
• webhook
• Gancho do Teams
• Gancho de DevOps do Azure

Cada tipo de gancho corresponde a um canal específico pelo qual a anomalia será notificada.

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

Aplicativos Lógicos

Enviar uma notificação de email usando Aplicativos Lógicos do Azure

Há duas opções comuns para enviar notificações por email com suporte no Assistente de Métricas. Uma delas é usar os webhooks e os Aplicativos Lógicos do Azure para enviar alertas de email, a outra é 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: Crie um webhook no Assistente de Métricas do Azure

Um webhook é o ponto de entrada de todas as informações disponíveis no serviço do Assistente de Métricas e chama uma API fornecida pelo usuário quando um alerta é disparado. Todos os alertas podem ser enviados com um webhook.

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

Há um parâmetro adicional do ponto de extremidade 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 do artigo Criar um exemplo de fluxo de trabalho de Consumo nos Aplicativos Lógicos. Ao ver que o designer de fluxo de trabalho foi aberto, retorne a este tutorial.

Etapa 3: Adicione um gatilho de Quando uma solicitação HTTP for recebida

• O Aplicativos Lógicos do Azure usa diversas ações para disparar fluxos de trabalho definidos. Para esse caso de uso é usado o gatilho intitulado Quando uma solicitação HTTP é recebida.

• Na caixa de diálogo Quando uma solicitação HTTP é recebida, selecione Use o conteúdo de amostra para gerar o esquema.

  

  Copie o JSON de exemplo a seguir na 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 'POST' e selecione Salvar. Agora, você pode ver a URL de seu gatilho de solicitação HTTP. Selecione o ícone de cópia para copiá-la e preenchê-la novamente no Ponto de extremidade na Etapa 1.

  

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

Os sinais transmitidos por meio do webhook contêm apenas informações limitadas, como carimbo de data/hora, alertID, configurationID etc. As informações detalhadas precisam ser consultadas usando a URL de retorno de chamada fornecida no sinal. Esta etapa consulta informações detalhadas do alerta.

• Escolher o método 'GET'

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

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

• Insira uma chave 'x-api-key' em 'Headers' para fazer isso clicando na guia 'Chaves de API' do espaço de trabalho do Assistente de Métricas. Esta etapa garante que o fluxo de trabalho tenha permissões suficientes para chamadas à 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 email.

Observação

Este tutorial compartilha apenas um exemplo rápido, mas o formato de email final precisa ser projetado de forma adicional.

• Selecione 'Corpo' na lista 'Conteúdo dinâmico' em 'Conteúdo'
• Selecione Usar conteúdo de exemplo para gerar o esquema. Copie o JSON de exemplo a seguir na 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’

Muitas informações foram retornadas da chamada à API, no entanto, dependendo de seus cenários, nem todas elas são úteis. Escolha os itens importantes a serem incluídos no email de alerta.

Veja abaixo um exemplo de tabela HTML que escolhe 'carimbo de data/hora', 'metricGUID' e 'dimensão' para incluir no email de alerta.

Etapa 7: Adicione a etapa final para ‘enviar um email’

Há várias opções para enviar um email, tanto em ofertas hospedadas pela Microsoft quanto por terceiros. O cliente pode precisar de um locatário/conta para a opção escolhida. Por exemplo, ao escolher o 'Office 365 Outlook' como o servidor. O processo de entrada será bombeado para a criação de conexão e a autorização. Uma conexão de API será estabelecida para usar o servidor de email no envio de alertas.

Preencha o conteúdo desejado a ser incluído em 'Corpo', o 'Assunto' do email e preencha um endereço de email em 'Destinatário'.

Canal do Teams

Enviar notificação de anomalias com o canal do Microsoft Teams

Esta seção explica o envio de notificações de anomalias 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 detectadas pelo Assistente de Métricas. O fluxo de trabalho é fácil de configurar e não tem um grande número de pré-requisitos.

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

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

• Na lista suspensa, selecione 'Conectores'. Na nova caixa de diálogo, pesquise 'Webhook de entrada' e clique em 'Adicionar'.

  

• Se você não conseguir exibir a opção 'Conectores', entre em contato com os proprietários do seu grupo do Teams. Escolha "Gerenciar equipe", selecione a guia "Configurações" na parte superior e verifique se a configuração "Permitir que membros criem, atualizem e removam conectores" está marcada.

  

• Insira um nome para o conector e, opcionalmente, carregue uma imagem para ser o avatar. Selecione "Criar" para incluir o conector de webhook de entrada com sucesso no canal. Uma URL será gerada na parte inferior da caixa de diálogo, por isso, certifique-se de selecionar 'Copiar' e clique em 'Concluir'.

  

Etapa 2: Crie um novo 'gancho do Teams' no Assistente de Métricas do Azure

• 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 "Teams", digite um nome e cole a URL copiada na etapa acima.

• Clique em "Salvar".

  

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

Acesse e selecione um dos feeds de dados integrados. Selecione uma métrica no feed e abra a página de detalhes de métricas. É possível criar uma "configuração de alerta" para assinar anomalias detectadas e notificar com um canal do Teams.

Selecione o botão '+', escolha o gancho criado, preencha os outros campos e selecione 'Salvar'. Em seguida, você estará pronto para aplicar um gancho do Teams a uma configuração de alerta. Quaisquer novas anomalias serão notificadas com o canal do Teams.

E-mail SMTP

Enviar notificação por email configurando um servidor SMTP

Esta seção explica como usar um servidor SMTP para enviar notificações por email sobre anomalias detectadas. Certifique-se de ter um servidor SMTP acessível e permissão suficiente para obter parâmetros como o nome da conta e a senha.

Etapa 1: Atribua sua conta como a função de 'Administrador do Assistente de Métricas do Azure de Serviços Cognitivos'

• Um usuário com privilégios de administrador de assinatura ou de grupo de recursos precisa navegar até o recurso do Assistente de Métricas criado no portal do Azure e selecionar a guia Controle de acesso (IAM).
• Selecione 'Adicionar atribuições de função'.
• Escolha a função de 'Administrador do Assistente de Métricas dos Serviços Cognitivos' e selecione sua conta, como ilustrado na imagem abaixo.
• Clique no botão 'Salvar' e você terá sido adicionado como administrador do recurso do Assistente de Métricas. Observe que todas as ações acima precisam ser executadas pelo administrador de assinatura ou de grupo de recursos. Pode levar até um minuto para que as permissões sejam propagadas.

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

Depois de concluir as etapas acima e ter sido adicionado com sucesso como administrador do recurso Assistente de Métricas. Pode levar alguns minutos para que as permissões sejam propagadas. Em seguida, entre no espaço de trabalho do Assistente de Métricas e uma nova guia chamada "Configuração de email" será exibida no painel de navegação à esquerda. Selecione-a para continuar 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 é escrita no formato "smtp.domain.com" ou "mail.domain.com". Por exemplo, o Office365 seria definido como "smtp.office365.com".
• Porta do servidor SMTP (obrigatório) : a porta 587 é a porta padrão para envio de SMTP na Web moderna. Embora outras portas possam ser usadas para envio (elas serão abordadas posteriormente), comece sempre com o padrão da porta 587 e use uma porta diferente somente se as circunstâncias determinarem isso (como bloqueio da porta 587 pelo host por algum motivo).
• Remetentes de email (obrigatório): essa é a conta de email real que assume a responsabilidade de enviar emails. Pode ser necessário preencher o nome da conta e a senha do remetente. É possível definir um limite de cota para o número máximo de emails de alerta enviados por minuto para uma conta. Você poderá definir muitos remetente se houver a possibilidade de 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 muitos remetentes configurados, mas quiser que os emails de alerta pareçam ser enviados de uma só conta. É possível usar esse campo para alinhá-los. No entanto, observe que pode ser necessário conceder permissão aos remetentes para permitir o envio de emails em nome da conta deles.
• CC padrão (opcional): para definir um endereço de email padrão que será copiado em todos os alertas de email.

Veja abaixo um exemplo de um servidor SMTP configurado:

Etapa 3: Crie um gancho de email no Assistente de Métricas do Azure

Depois de configurar um servidor SMTP com sucesso, você criará um 'gancho de email' na guia 'Ganchos' do Assistente de Métricas. Para obter mais informações sobre como criar um 'gancho de email', confira o artigo sobre alertas e siga as etapas até a conclusão.

Etapa 4: Aplicar o gancho de email a uma configuração de alerta

Acesse e selecione um dos feeds de dados integrados, selecione uma métrica no feed e abra a página de detalhes de métricas. É possível criar uma "configuração de alerta" para assinar as anomalias que foram detectadas e enviadas por emails.

Selecione o botão '+', escolha o gancho criado, preencha os outros campos e selecione 'Salvar'. Agora, você configurou com sucesso um gancho de email com uma configuração de alerta personalizada e quaisquer novas anomalias serão escaladas por meio do gancho usando o servidor SMTP.

Próximas etapas

Prossiga para o próximo artigo para saber como realizar a criação.

Escrever uma consulta válida