Partilhar via


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

Os Serviços de Comunicação do Azure oferecem recursos de registro em log que você pode usar para monitorar e depurar sua solução de Serviços de Comunicação. Esses recursos podem ser configurados 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, 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 não pode definir mais do que 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 espaço de trabalho 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, os dados da pesquisa não serão armazenados e serão perdidos: A seguir estão instruções para configurar seu recurso do Azure Monitor para começar a criar logs e métricas para seus Serviços de Comunicações. Para obter documentação detalhada sobre como usar as Configurações de Diagnóstico em todos os recursos do Azure, consulte: Habilitar o registro em log nas Configurações de Diagnóstico

Nota

Em Nome da configuração de diagnóstico, selecione "Email Service Delivery Status Update Logs", "Email Service Send Mail logs", "Email Service User Engagement Logs" para ativar os logs para e-mails

Captura de ecrã das definições de diagnóstico para Email.

Categorias de log de recursos

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

  • Logs de uso - fornece dados de uso associados a cada oferta de serviço faturada
  • Logs operacionais de envio de e-mail - fornece informações detalhadas relacionadas ao serviço de e-mail enviar solicitações de e-mail.
  • Logs operacionais de Atualização de Status de Email - fornece atualizações de status de entrega no nível de mensagem e destinatário relacionadas às solicitações de envio de e-mail do serviço de email.
  • Logs operacionais do Email User Engagement - fornecem informações relacionadas às métricas de envolvimento do usuário 'abrir' e 'clicar' para mensagens enviadas do serviço de e-mail.

Esquema de logs de uso

Property Description
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 O api-version associado à operação, se o operationName foi executado usando 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 mudem 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 que aparecem no blob de propriedades de um evento são as mesmas dentro de uma categoria de log e tipo de recurso específicos.
Correlation ID A ID para eventos correlacionados. Pode ser usado para identificar eventos correlacionados entre várias tabelas.
Properties Outros dados aplicáveis a vários modos de Serviços de Comunicação.
Record ID A ID exclusiva para um determinado registro de uso.
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 determinado modo de uso. (por exemplo, minutos, megabytes, mensagens, etc.).
Quantity O número de unidades utilizadas ou consumidas para este registo.

Logs operacionais de envio de e-mail

Os logs operacionais de envio de e-mail 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 impulsionar uma melhor tomada de decisão.

Property Description
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 O api-version associado com a operação, se o operationName foi executado usando 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 mudem 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 que aparecem no blob de propriedades de um evento são as mesmas dentro de uma categoria de log e tipo de recurso específicos.
CorrelationID A ID para eventos correlacionados. Pode ser usado para identificar eventos correlacionados entre várias tabelas. Para todos os logs operacionais de e-mail, 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 total # de endereços de e-mail exclusivos na linha Para.
CcRecipientsCount O total # de endereços de e-mail exclusivos na linha Cc.
BccRecipientsCount O # total de endereços de e-mail exclusivos na linha Bcc.
UniqueRecipientsCount Esta é a contagem total de destinatários desduplicados para os campos de endereço Para, Cc e Cco.
AttachmentsCount O 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 de atualização de status de e-mail

Os logs operacionais de atualização de status de e-mail fornecem informações detalhadas sobre atualizações de status de entrega no nível da mensagem e no nível do destinatário em suas solicitações de API de sendmail.

  • As atualizações de status no nível da mensagem fornecem o status da operação de envio de e-mail de longa duração (semelhante às atualizações de status que você recebe ao ligar para nossas APIs GET). Eles são marcados pela ausência de propriedade porque essas atualizações são para toda a mensagem e não se aplicam a um destinatário específico nessa solicitação de RecipientId mensagem. DeliveryStatus contém o status de entrega no nível da mensagem. Os valores possíveis para DeliveryStatus este tipo de evento são Dropped, OutForDeliverye Queued.
  • As atualizações de status no nível do destinatário fornecem o status da entrega de e-mail para cada destinatário individual para quem o e-mail foi enviado em uma única mensagem. Estes contêm uma RecipientId propriedade com o endereço de e-mail do destinatário. O status de entrega no nível do destinatário é fornecido na DeliveryStatus propriedade. Os valores possíveis para DeliveryStatus este tipo de evento são Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressede Bounced. 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.
Property Description
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 O api-version associado com a operação, se o operationName foi executado usando 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 mudem 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 que aparecem no blob de propriedades de um evento são as mesmas dentro de uma categoria de log e tipo de recurso específicos.
CorrelationID A ID para eventos correlacionados. Pode ser usado para identificar eventos correlacionados entre várias tabelas. Para todos os logs operacionais de e-mail, o CorrelationId é mapeado para o MessageId, que é retornado de uma solicitação SendMail bem-sucedida.
RecipientId O endereço de e-mail do destinatário alvo. Ele está presente apenas para eventos no nível do destinatário. Se este for um evento no nível da mensagem, a propriedade estará vazia.
DeliveryStatus O status do terminal da mensagem. Os valores possíveis para o evento de nível de mensagem são: Dropped, OutForDelivery, Queued. Os valores possíveis para um evento de nível de destinatário são: Delivered, Expanded, Failed, Quarantined, FilteredSpam, , SuppressedBounced.
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 e-mail do destinatário.
SenderDomain A parte do domínio do SenderAddress usado no envio de e-mails.
SenderUsername A parte do nome de usuário do SenderAddress usado 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 na 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 do Email User Engagement

Os logs operacionais de envolvimento do usuário de e-mail fornecem informações sobre as tendências de engajamento de e-mail para seu sistema de e-mail. Esses dados ajudam você a acompanhar e analisar as principais métricas de e-mail, como taxas de abertura, taxas de cliques e taxas de cancelamento de assinatura. Esses logs 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.

Property Description
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 O api-version associado com a operação, se o operationName foi executado usando 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 mudem 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 que aparecem no blob de propriedades de um evento são as mesmas dentro de uma categoria de log e tipo de recurso específicos.
CorrelationID A ID para eventos correlacionados. Pode ser usado para identificar eventos correlacionados entre várias tabelas. Para todos os logs operacionais de e-mail, o CorrelationId é mapeado para o MessageId, que é retornado de uma solicitação SendMail bem-sucedida.
RecipientId O endereço de e-mail do destinatário alvo. Se este for um evento no nível da mensagem, a propriedade estará vazia.
EngagementType O tipo de envolvimento do usuário que está sendo rastreado.
EngagementContext O contexto representa com o que o usuário interagiu.
UserAgent A cadeia de caracteres do agente do 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"
}