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 de Logs do Azure Monitor e 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:

• As categorias de logs e os dados de métrica enviados aos destinos definidos na configuração. As categorias disponíveis irão variar para diferentes tipos de recursos.
• Um ou mais destinos para enviar os logs. Os destinos atuais incluem o workspace do Log Analytics, os Hubs de Eventos e o Armazenamento do Microsoft 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 workspaces do Log Analytics diferentes), 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. As instruções a seguir são para configurar o recurso do Azure Monitor para começar a criar logs e métricas para seus Serviços de Comunicação. Para ver a documentação detalhada sobre como usar Configurações de Diagnóstico em todos os recursos do Azure, consulte Habilitar o registro em log em 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 participação do usuário do serviço de email” para habilitar os logs de emails

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 determinado recurso. 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

Os logs operacionais de envio de email fornecem insights valiosos sobre as tendências de solicitação de API ao longo do tempo. Esses dados ajudam você a descobrir as principais análises de email, como o número total de emails enviados, o tamanho do email e o número de emails com anexos. Essas informações podem ser analisadas rapidamente quase em tempo real e visualizadas de maneira amigável para ajudar a impulsionar 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 determinado recurso. 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, a CorrelationId é mapeada para a MessageId, que é retornada de uma solicitação SendMail bem-sucedida.
Size	Representa o tamanho total do corpo, assunto, cabeçalhos e anexos do email 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 com eliminação de duplicação para os campos de endereço Para, Cc e Cco.
AttachmentsCount	O número total de anexos.
TrafficSource	O nome do cliente do qual a solicitação de email 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 email fornecem insights aprofundados 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 fornece o status da operação de envio de email de longa execução (semelhante às atualizações de status que você recebe por meio da chamada de nossas APIs GET). Elas são marcadas pela ausência da propriedade RecipientId 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 mensagem. A propriedade DeliveryStatus contém o status de entrega no nível da mensagem. Os valores possíveis para DeliveryStatus para esse tipo de evento são Dropped, OutForDelivery e Queued.
• As atualizações de status no nível do destinatário fornece o status da entrega de email para cada destinatário individual para o qual o email foi enviado em uma única mensagem. Elas contêm uma propriedade RecipientId com o endereço de email do destinatário. O status de entrega no nível do destinatário é fornecido na propriedade DeliveryStatus. Os valores possíveis para DeliveryStatus para esse tipo de evento são Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressed e Bounced. Ao acompanhar esses logs, você pode garantir a visibilidade total do processo de entrega de email, identificando rapidamente todos os problemas que possam surgir e realizando ações 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 determinado recurso. 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, a CorrelationId é mapeada para a MessageId, que é retornada de uma solicitação SendMail bem-sucedida.
RecipientId	O endereço de email do destinatário de destino. Só está presente para eventos no nível do destinatário. Se esse 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 no nível da mensagem são: Dropped, OutForDelivery, Queued. Os valores possíveis para um evento no nível do destinatário são: Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressed, Bounced.
SmtpStatusCode	O código de status de SMTP retornado do servidor de email do destinatário em resposta a uma solicitação de envio de email.
EnhancedSmtpStatusCode	Código de status de SMTP aprimorado retornado do servidor de email do destinatário.
SenderDomain	A parte do domínio de SenderAddress usada no envio de emails.
SenderUsername	A parte do nome de usuário de SenderAddress usada no envio de emails.
IsHardBounce	Significa se uma falha de entrega ocorreu devido a um problema permanente ou temporário. IsHardBounce == true significa que um problema de caixa de correio permanente está impedindo que emails 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 logs operacionais de participação do usuário por email fornecem insights sobre tendências de participação do usuário por email para seu sistema de email. Esses dados ajudam você a acompanhar e analisar as principais métricas de email, como taxas de abertura, taxas de cliques e taxas de cancelamento de inscrição. Esses logs podem ser armazenados e analisados, permitindo que você obtenha insights aprofundados sobre o desempenho do sistema de email e adapte sua estratégia adequadamente. No geral, os logs operacionais de participação do usuário por email fornece uma ferramenta poderosa para melhorar o desempenho do sistema de email, otimizar e medir de forma proativa suas campanhas de email e melhorar a participação 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 determinado recurso. 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, a CorrelationId é mapeada para a MessageId, que é retornada 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"
}