Logs de email dos Serviços de Comunicação do Azure

Os Serviços de Comunicação do Azure oferecem funcionalidades de log que você pode usar para monitorar e depurar sua solução dos Serviços de Comunicação. Essas funcionalidades podem ser configuradas por meio do portal do Azure.

Pré-requisitos

Os Serviços de Comunicação do Azure fornecem recursos de monitoramento e análise por meio da visão geral dos Logs do Azure Monitor e das Métricas do Azure Monitor. Cada recurso do Azure requer sua própria configuração de diagnóstico, o que define os seguintes critérios:

• Categorias de logs e dados métricos enviados para os destinos definidos na configuração. As categorias disponíveis variam para diferentes tipos de recursos.
• Um ou mais destinos para enviar os logs. Os destinos atuais incluem o espaço de trabalho do Log Analytics, Hubs de Eventos e Armazenamento do Azure.
• Uma única configuração de diagnóstico pode definir apenas um de cada um dos destinos. Se você quiser enviar dados para mais de um tipo de destino específico (por exemplo, dois espaços de trabalho diferentes do Log Analytics), crie várias configurações. Cada recurso pode ter até cinco configurações de diagnóstico.

Importante

Você deve habilitar uma Configuração de Diagnóstico no Azure Monitor para enviar os dados de log de suas pesquisas para um workspace do Log Analytics, Hubs de Eventos ou uma conta de armazenamento do Azure para receber e analisar os dados da pesquisa. Se você não enviar dados de automação de chamadas para uma dessas opções, seus dados de pesquisa não serão armazenados e serão perdidos: Veja a seguir instruções para configurar seu recurso do Monitor do Azure para começar a criar logs e métricas para seus Serviços de Comunicação. Para obter documentação detalhada sobre como usar as Configurações de Diagnóstico em todos os recursos do Azure, consulte: Habilitar o log nas Configurações de Diagnóstico

Observação

Em Nome da configuração de diagnóstico, selecione "Logs de Atualização de Status de Entrega do Serviço de Email", "Logs de Envio de Email do Serviço de Email", "Logs de Engajamento do Usuário do Serviço de Email" para habilitar os logs de e-mails

Categorias de log de recursos

Os Serviços de Comunicação seguintes tipos de logs que você pode habilitar:

• Logs de uso: fornecem dados de uso associados a cada oferta de serviço cobrada
• Logs operacionais de email de envio de email - fornece informações detalhadas relacionadas às solicitações de envio de email do serviço de email.
• Logs operacionais da atualização de status de email - fornece atualizações de status de entrega no nível da mensagem e do destinatário relacionadas às solicitações de envio de email do serviço de email.
• Logs operacionais de participação do usuário de email - fornece informações relacionadas às métricas de participação de usuário 'em aberto' e 'clique' para mensagens enviadas a partir do serviço email.

Esquema de logs de uso

Propriedade	Descrição
Timestamp	O carimbo de data/hora (UTC) de quando o log foi gerado.
Operation Name	A operação associada ao registro de log.
Operation Version	A api-version associada à operação, caso a operationName tenha sido executada com uma API. Se não houver nenhuma API que corresponda a essa operação, a versão representará a versão dessa operação caso as propriedades associadas à operação sejam alteradas no futuro.
Category	A categoria de log do evento. A categoria é a granularidade na qual você pode habilitar ou desabilitar logs em um recurso específico. As propriedades exibidas no blob de propriedades de um evento são as mesmas em uma categoria de log e um tipo de recurso específicos.
Correlation ID	A ID de eventos correlacionados. Pode ser usada para identificar os eventos correlacionados entre várias tabelas.
Properties	Outros dados aplicáveis a vários modos dos Serviços de Comunicação.
Record ID	A ID exclusiva de um registro de uso especificado.
Usage Type	O modo de uso. (por exemplo, chat, PSTN, NAT etc.)
Unit Type	O tipo de unidade em que o uso se baseia para um modo de uso especificado. (por exemplo, minutos, megabytes, mensagens etc.).
Quantity	O número de unidades usadas ou consumidas para este registro.

Logs operacionais de email de envio de email

Enviar e-mail Os logs operacionais fornecem informações valiosas sobre as tendências de solicitação de API ao longo do tempo. Esses dados ajudam você a descobrir as principais análises de e-mail, como o número total de e-mails enviados, o tamanho do e-mail e o número de e-mails com anexos. Essas informações podem ser rapidamente analisadas quase em tempo real e visualizadas de forma amigável para ajudar a conduzir uma melhor tomada de decisão.

Propriedade	Descrição
TimeGenerated	O carimbo de data/hora (UTC) de quando o log foi gerado.
Location	A região onde a operação foi processada.
OperationName	A operação associada ao registro de log.
OperationVersion	A api-version associada à operação, caso o operationName tenha sido executado com uma API. Se não houver nenhuma API que corresponda a essa operação, a versão representará a versão dessa operação caso as propriedades associadas à operação sejam alteradas no futuro.
Category	A categoria de log do evento. A categoria é a granularidade na qual você pode habilitar ou desabilitar logs em um recurso específico. As propriedades exibidas no blob de propriedades de um evento são as mesmas em uma categoria de log e um tipo de recurso específicos.
CorrelationID	A ID de eventos correlacionados. Pode ser usada para identificar os eventos correlacionados entre várias tabelas. Para todos os logs operacionais de email, o CorrelationId é mapeado para o MessageId, que é retornado de uma solicitação SendMail bem-sucedida.
Size	Representa o tamanho total do corpo do e-mail, assunto, cabeçalhos e anexos em megabytes.
ToRecipientsCount	O número total de endereços de email exclusivos na linha Para.
CcRecipientsCount	O número total de endereços de email exclusivos na linha Cc.
BccRecipientsCount	O número total de endereços de email exclusivos na linha Cco.
UniqueRecipientsCount	Essa é a contagem total de destinatários desduplicados para os campos Para, Cc e Endereço Cco.
AttachmentsCount	O número total de anexos.
TrafficSource	O nome do cliente de onde a solicitação de e-mail se originou.

Amostras

{
  "OperationType":"SendMail", 
  "OperationCategory":"EmailSendMailOperational",
  "Size":0.026019,
  "ToRecipientsCount":2,
  "CcRecipientsCount":3, 
  "BccRecipientsCount":1, 
  "UniqueRecipientsCount":6, 
  "AttachmentsCount":0,
  "TrafficSource":"Email .NET SDK"
}

Logs operacionais da atualização de status de email

Os logs operacionais de atualização de status de e-mail fornecem insights detalhados sobre atualizações de status de entrega em nível de mensagem e destinatário em suas solicitações de API de envio de mensagens. Esses logs oferecem detalhes específicos da mensagem, como o horário de entrega, bem como detalhes no nível do destinatário, como endereços de email e atualizações de status de entrega. Ao rastrear esses registros, você pode garantir visibilidade total do seu processo de entrega de e-mails, identificando rapidamente quaisquer problemas que possam surgir e tomando medidas corretivas conforme necessário.

Propriedade	Descrição
TimeGenerated	O carimbo de data/hora (UTC) de quando o log foi gerado.
Location	A região onde a operação foi processada.
OperationName	A operação associada ao registro de log.
OperationVersion	A api-version associada à operação, caso o operationName tenha sido executado com uma API. Se não houver nenhuma API que corresponda a essa operação, a versão representará a versão dessa operação caso as propriedades associadas à operação sejam alteradas no futuro.
Category	A categoria de log do evento. A categoria é a granularidade na qual você pode habilitar ou desabilitar logs em um recurso específico. As propriedades exibidas no blob de propriedades de um evento são as mesmas em uma categoria de log e um tipo de recurso específicos.
CorrelationID	A ID de eventos correlacionados. Pode ser usada para identificar os eventos correlacionados entre várias tabelas. Para todos os logs operacionais de email, o CorrelationId é mapeado para o MessageId, que é retornado de uma solicitação SendMail bem-sucedida.
RecipientId	O endereço de email do destinatário de destino. Se esse for um evento no nível da mensagem, a propriedade estará vazia.
DeliveryStatus	O status do terminal da mensagem.
SmtpStatusCode	Código de status SMTP retornado do servidor de email do destinatário em resposta a uma solicitação de envio de email.
EnhancedSmtpStatusCode	Código de status SMTP aprimorado retornado do servidor de email do destinatário.
SenderDomain	A parte de domínio do SenderAddress usada no envio de e-mails.
SenderUsername	A parte do nome de usuário do SenderAddress usada no envio de e-mails.
IsHardBounce	Significa se uma falha na entrega foi devido a um problema permanente ou temporário. IsHardBounce == true significa um problema permanente de caixa de correio que impede que os e-mails sejam entregues.

Amostras

{
  "OperationType":"DeliveryStatusUpdate", 
  "OperationCategory":"EmailStatusUpdateOperational", 
  "RecipientId":"user@email.com", 
  "DeliveryStatus":"Delivered", 
  "SenderDomain":"contoso.com", 
  "SenderUsername":"donotreply", 
  "IsHardBounce":false
}

Logs operacionais de participação do usuário de email

Os registros operacionais de engajamento do usuário de e-mail fornecem insights sobre as tendências de engajamento de e-mail para seu sistema de e-mail. Esses dados ajudam a rastrear e analisar as principais métricas de e-mail, como taxas de abertura, taxas de cliques e taxas de cancelamento de assinatura. Esses registros podem ser armazenados e analisados, permitindo que você obtenha insights mais profundos sobre o desempenho do seu sistema de e-mail e adapte sua estratégia de acordo. No geral, os logs operacionais do Email User Engagement fornecem uma ferramenta poderosa para melhorar o desempenho do seu sistema de e-mail, medir e otimizar proativamente suas campanhas de e-mail e melhorar o envolvimento do usuário ao longo do tempo.

Propriedade	Descrição
TimeGenerated	O carimbo de data/hora (UTC) de quando o log foi gerado.
Location	A região onde a operação foi processada.
OperationName	A operação associada ao registro de log.
OperationVersion	A api-version associada à operação, caso o operationName tenha sido executado com uma API. Se não houver nenhuma API que corresponda a essa operação, a versão representará a versão dessa operação caso as propriedades associadas à operação sejam alteradas no futuro.
Category	A categoria de log do evento. A categoria é a granularidade na qual você pode habilitar ou desabilitar logs em um recurso específico. As propriedades exibidas no blob de propriedades de um evento são as mesmas em uma categoria de log e um tipo de recurso específicos.
CorrelationID	A ID de eventos correlacionados. Pode ser usada para identificar os eventos correlacionados entre várias tabelas. Para todos os logs operacionais de email, o CorrelationId é mapeado para o MessageId, que é retornado de uma solicitação SendMail bem-sucedida.
RecipientId	O endereço de email do destinatário de destino. Se esse for um evento no nível da mensagem, a propriedade estará vazia.
EngagementType	O tipo de participação do usuário que está sendo acompanhado.
EngagementContext	O contexto representa com o que o usuário interagiu.
UserAgent	A cadeia de caracteres do agente de usuário do cliente.

Amostras

{
    "OperationType": "UserEngagementUpdate",
    "OperationCategory": "EmailUserEngagementOperational",
    "EngagementType": "View",
    "UserAgent": "Mozilla/5.0"
}

{
  "OperationType":"UserEngagementUpdate", 
  "OperationCategory":"EmailUserEngagementOperational",
  "EngagementType":"Click",
  "EngagementContext":"https://www.contoso.com/support?id=12345", 
  "UserAgent":"Mozilla/5.0"
}