Definir as configurações do SMTP

Neste guia, você aprenderá a definir configurações SMTP para gerar alertas de email no Azure Managed Grafana. As notificações alertam os usuários quando alguns cenários específicos ocorrem em um painel do Grafana.

As configurações SMTP podem ser habilitadas em uma instância existente do Azure Managed Grafana por meio do portal do Azure e da CLI do Azure. No momento, não há suporte para habilitar configurações SMTP durante a criação de uma nova instância.

Pré-requisitos

Para seguir as etapas deste guia, você deve ter:

• Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
• Uma instância do Azure Managed Grafana no plano Standard. Se você ainda não tiver uma, crie uma nova instância.
• Um servidor SMTP. Se você ainda não tiver um, convém considerar o uso da API de email do Twilio SendGrid para Azure.

Habilitar e definir configurações SMTP

Siga estas etapas para ativar as configurações de SMTP, habilitar notificações por email e configurar um ponto de contato de email no Azure Managed Grafana.

Portal

1. No portal do Azure, abra sua instância do Grafana e, em Configurações, selecione Configuração.

2. Selecione a guia Configurações de e-mail.

3. Ative as Configurações SMTP para que Habilitar seja exibido.

4. As configurações SMTP são exibidas. Preencha o formulário com a seguinte configuração:

   Parâmetro	Exemplo	Descrição
   Host	test.sendgrid.net:587	Digite o nome do host do servidor SMTP com porta.
   Usuário	administrador	Digite o nome do usuário da autenticação SMTP.
   Senha	password	Digite a senha da autenticação SMTP. Se a senha contiver "#" ou ";", coloque-a entre aspas triplas.
   Endereço De	user@domain.com	Digite o endereço de e-mail usado ao enviar e-mails.
   Nome do Remetente	Notificação do Azure Managed Grafana	Digite o nome usado ao enviar e-mails. O padrão é "Azure Managed Grafana Notification" se o parâmetro não for fornecido ou estiver vazio.
   Ignorar verificação	Desabilitar	Essa configuração controla se um cliente verifica a cadeia de certificados e o nome do host do servidor. Se Ignorar verificação for Habilitar, o cliente aceitará qualquer certificado apresentado pelo servidor e qualquer nome de host nesse certificado. Nesse modo, o TLS é suscetível a ataques de máquina no meio, a menos que a verificação personalizada seja usada. O padrão é Desativar (desativado). Mais informações.
   Política StartTLS	OpportunisticStartTLS	Há três opções. Mais informações. OpportunisticStartTLS significa que as transações SMTP são criptografadas se STARTTLS for suportado pelo servidor SMTP. Caso contrário, as mensagens são enviadas de forma clara. É a configuração padrão. MandatoryStartTLS significa que as transações SMTP devem ser criptografadas. As transações SMTP são anuladas, a menos que STARTTLS seja suportado pelo servidor SMTP. NoStartTLS significa que a criptografia está desativada e as mensagens são enviadas de forma clara.

5. Selecione Salvar para salvar as configurações de SMTP. A atualização pode levar alguns minutos.

   

6. Após a conclusão do processo, a mensagem "Atualizando as seleções. Atualização bem-sucedida" é exibida nas Notificações do Azure. Na página Visão geral, o estado de provisionamento da instância se transforma em Atualização e, em seguida, em Êxito quando a atualização é concluída.

CLI do Azure

1. A extensão 1.1 ou superior da CLI do Azure Managed Grafana é necessária para habilitar ou atualizar as configurações de SMTP. Para atualizar sua extensão, execute az extension update --name amg.

2. Execute o comando az grafana update para definir as configurações SMTP para uma determinada instância do Azure Managed Grafana. Substitua os espaços reservados por informações de sua própria instância.

   az grafana update --resource-group <resource-group> \
       --name <azure-managed-grafana-name> \
       --smtp enabled \
       --from-address <from-address> \
       --from-name <from-name> \
       --host "<host>" \
       --user <user> \
       --password "<password>" \
       --start-tls-policy <start-TLS-policy> \
       --skip-verify <true-or-false> \
   

   Parâmetro	Exemplo	Descrição
   --resource-group	my-resource-group	Insira o nome do grupo de recursos da instância do Azure Managed Grafana.
   --name	my-azure-managed-grafana	Insira o nome da instância do Azure Managed Grafana.
   --smtp	Habilitado	Digite habilitado para desabilitar as configurações de SMTP.
   --from-address	user@domain.com	Digite o endereço de e-mail usado ao enviar e-mails.
   --from-name	Notificação do Azure Managed Grafana	Digite o nome usado ao enviar e-mails. O padrão é "Azure Managed Grafana Notification" se o parâmetro não for fornecido ou estiver vazio.
   --host	test.sendgrid.net:587	Digite o nome do host do servidor SMTP com porta.
   --user	administrador	Digite o nome do usuário da autenticação SMTP.
   --password	password	Digite a senha da autenticação SMTP. Se a senha contiver "#" ou ";", coloque-a entre aspas triplas.
   --start-tls-policy	OpportunisticStartTLS	A configuração StartTLSPolicy da configuração SMTP. Há três opções. Mais informações. OpportunisticStartTLS significa que as transações SMTP são criptografadas se STARTTLS for suportado pelo servidor SMTP. Caso contrário, as mensagens são enviadas de forma clara. Esta é a configuração padrão. MandatoryStartTLS significa que as transações SMTP devem ser criptografadas. As transações SMTP são anuladas, a menos que STARTTLS seja suportado pelo servidor SMTP. NoStartTLS significa que a criptografia está desativada e as mensagens são enviadas de forma clara.
   --skip-verify	falso	Essa configuração controla se um cliente verifica a cadeia de certificados e o nome do host do servidor. Se --skip-verify for true, o cliente aceitará qualquer certificado apresentado pelo servidor e qualquer nome de host nesse certificado. Nesse modo, o TLS é suscetível a ataques de máquina no meio, a menos que a verificação personalizada seja usada. O padrão é false. Mais informações.

Dica

Aqui estão algumas dicas para configurar corretamente o SMTP:

• Ao usar uma conta de email comercial, como o Office 365, talvez seja necessário entrar em contato com o administrador de email para habilitar o SMTP AUTH (por exemplo, enable-smtp-auth-for-specific-mailboxes). Você deve ser capaz de criar uma senha de aplicativo depois e usá-la como a configuração de senha SMTP.
• Ao usar uma conta de e-mail pessoal, como o Outlook ou o Gmail, você deve criar uma senha de aplicativo e usá-la como a configuração de senha SMTP. Observe que sua conta não funcionará para notificação por e-mail se estiver configurada com autenticação multifator.
• É recomendável verificar se as configurações SMTP estão funcionando conforme o esperado antes de aplicá-las ao seu espaço de trabalho Grafana Gerenciado. Por exemplo, você pode usar uma ferramenta de código aberto como swaks (canivete suíço para SMTP) para enviar um email de teste usando as configurações SMTP executando o seguinte comando em uma janela de terminal:

  # fill in all the empty values for the following parameters
  host="" # SMTP host name with port separated by a ":", e.g. smtp.office365.com:587
  user="" # email address, e.g. team1@microsoft.com
  password="" # password
  fromAddress="" # source email address (usually the same as user above), e.g. team1@contoso.com
  toAddress="" # destination email address, e.g. team2@contoso.com
  ehlo="" # grafana endpoint, e.g. team1-ftbghja6ekeybng8.wcus.grafana.azure.com
  
  header="Subject:Test"
  body="Testing!"
  
  # test SMTP connection by sending an email
  swaks --auth -tls \
      --server $host \
      --auth-user $user \
      --auth-password $password \
      --from $fromAddress \
      --to $toAddress \
      --ehlo $ehlo \
      --header $header \
      --body $body
  

Configurar pontos de contato do Grafana e enviar um email de teste

A configuração dos pontos de contato da Grafana é feita no portal da Grafana:

1. Em seu espaço de trabalho do Azure Managed Grafana, em Visão geral, selecione a URL do ponto de extremidade .

2. Vá para Pontos de contato de > alerta.

3. Selecione Novo ponto de contato ou Editar ponto de contato para atualizar um ponto de contato existente.

   

4. Adicione ou atualize o tipo Nome e Ponto de contato.

5. Insira um email de destino em Endereços e selecione Testar.

6. Selecione Enviar notificação de teste para enviar a notificação com a mensagem de teste predefinida ou selecione Personalizado para editar a mensagem primeiro.

7. Uma notificação "Alerta de teste enviado" é exibida, o que significa que a configuração do e-mail foi configurada com êxito. O e-mail de teste foi enviado para o endereço de e-mail fornecido. Se houver uma configuração incorreta, uma mensagem de erro será exibida.

Desabilitar configurações SMTP

Para desativar as configurações de SMTP, siga estas etapas.

Portal

1. No portal do Azure, vá para Configurações de Email de Configuração > e desative Configurações de SMTP para que Desabilitar seja exibido.
2. Selecione Salvar para validar e começar a atualizar a instância do Azure Managed Grafana.

CLI do Azure

1. A extensão 1.1 ou superior da CLI do Azure Managed Grafana é necessária para desabilitar as configurações de SMTP. Para atualizar sua extensão, execute az extension update --name amg.

2. Execute o comando az grafana update para definir as configurações SMTP para uma determinada instância do Azure Managed Grafana. Substitua os espaços reservados por informações de sua própria instância.

   az grafana update --resource-group <resource-group> \
       --name <azure-managed-grafana-name> \
       --smtp disabled
   

   Parâmetro	Exemplo	Descrição
   --resource-group	my-resource-group	Insira o nome do grupo de recursos da instância do Azure Managed Grafana.
   --name	my-azure-managed-grafana	Insira o nome da instância do Azure Managed Grafana.
   --smtp	desabilitado	Digite disabled para desativar as configurações de SMTP.

Observação

Quando um usuário desabilita as configurações de SMTP, todas as credenciais SMTP são removidas do back-end. O Azure Managed Grafana não persistirá as credenciais SMTP quando desabilitado.

Grafana alertando mensagens de erro

No portal Grafana, você pode encontrar uma lista de todas as mensagens de erro de alerta do Grafana que ocorreram em Notificações de > alerta.

A seguir estão algumas mensagens de erro comuns que você pode encontrar:

• "Falha na autenticação: a concessão de autorização fornecida é inválida, expirada ou revogada". Grafana não pôde se conectar ao servidor SMTP. Verifique se a senha inserida nas configurações SMTP no portal do Azure está correta.
• "Falha ao enviar alerta de teste: SMTP não configurado". O SMTP está desabilitado. Abra a instância do Azure Managed Grafana no portal do Azure e habilite as configurações de SMTP.

Próximas etapas

Neste guia de instruções, você aprendeu a definir as configurações SMTP do Grafana. Para saber como criar relatórios e enviá-los por email para destinatários, consulte Criar painéis.