Azure Communication Services email logs

Azure Communication Services offers logging capabilities that you can use to monitor and debug your Communication Services solution. These capabilities can be configured through the Azure portal.

Prerequisites

Azure Communications Services provides monitoring and analytics features via Azure Monitor Logs overview and Azure Monitor Metrics. Each Azure resource requires its own diagnostic setting, which defines the following criteria:

• Categories of logs and metric data sent to the destinations defined in the setting. The available categories will vary for different resource types.
• One or more destinations to send the logs. Current destinations include Log Analytics workspace, Event Hubs, and Azure Storage.
• A single diagnostic setting can define no more than one of each of the destinations. If you want to send data to more than one of a particular destination type (for example, two different Log Analytics workspaces), then create multiple settings. Each resource can have up to five diagnostic settings.

Resource log categories

Communication Services offers the following types of logs that you can enable:

• Usage logs - provides usage data associated with each billed service offering
• Email Send Mail operational logs - provides detailed information related to the Email service send mail requests.
• Email Status Update operational logs - provides message and recipient level delivery status updates related to the Email service send mail requests.
• Email User Engagement operational logs - provides information related to 'open' and 'click' user engagement metrics for messages sent from the Email service.

Usage logs schema

Email Send Mail operational logs

Email Send Mail Operational logs provide valuable insights into API request trends over time. This data helps you discover key email analytics, such as the total number of emails sent, email size, and number of emails with attachments. This information can be quickly analyzed in near-real-time and visualized in a user-friendly way to help drive better decision-making.

Samples

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

Email Status Update operational logs

Email status update operational logs provide in-depth insights into message-level and recipient-level delivery status updates on your sendmail API requests.

• Message-level status updates provide the status of the long-running email send operation (similar to the status updates you receive through calling our GET APIs). These are marked by the absence of RecipientId property because these updates are for the entire message and not applicable to a specific recipient in that message request. DeliveryStatus property contains the message-level delivery status. Possible values for DeliveryStatus for this type of event are Dropped, OutForDelivery, and Queued.
• Recipient-level status updates provide the status of email delivery for each individual recipient to whom the email was sent in a single message. These contain a RecipientId property with the recipient's email address. Recipient-level delivery status is provided in the DeliveryStatus property. Possible values for DeliveryStatus for this type of event are Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressed, and Bounced. By tracking these logs, you can ensure full visibility into your email delivery process, quickly identifying any issues that may arise and taking corrective action as necessary.

Samples

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

Email User Engagement operational logs

Email user engagement operational logs provide insights into email engagement trends for your email system. This data helps you track and analyze key email metrics such as open rates, click-through rates, and unsubscribe rates. These logs can be stored and analyzed, allowing you to gain deeper insights into your email system's performance, and adapt your strategy accordingly. Overall, Email User Engagement operational logs provide a powerful tool for improving your email system's performance, proactively measuring, and optimizing your email campaigns, and improving user engagement over time.

Samples

{
    "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"
}