Registros de correo electrónico de Azure Communication Services

Azure Communication Services ofrece funcionalidades de registro que sirven para supervisar y depurar la solución de Communication Services. Estas funcionalidades pueden configurarse mediante Azure Portal.

Requisitos previos

Azure Communications Services proporciona características de supervisión y análisis a través de la introducción a los registros de Azure Monitor y las métricas de Azure Monitor. Cada recurso de Azure necesita su propia configuración de diagnóstico, que establece los siguientes criterios:

  • Categorías de los datos de los registros y las métricas que se envían a los destinos definidos en la configuración. Las categorías disponibles varían para los distintos tipos de recursos.
  • Uno o más destinos para enviar los registros. Los destinos actuales incluyen el área de trabajo de Log Analytics, Event Hubs y Azure Storage.
  • Cada configuración de diagnóstico puede definir un único destino. Si desea enviar datos a más de un tipo de destino determinado (por ejemplo, dos áreas de trabajo de Log Analytics diferentes), cree varias configuraciones. Cada recurso puede tener hasta cinco configuraciones de diagnóstico.

Importante

Debe habilitar una configuración de diagnóstico en Azure Monitor para enviar los datos de registro de las encuestas a un área de trabajo de Log Analytics, Event Hubs o una cuenta de Azure Storage para recibir y analizar los datos de la encuesta. Si no envía datos de automatización de llamadas a una de estas opciones, los datos de la encuesta no se almacenarán y se perderán Las siguientes son instrucciones para configurar el recurso de Azure Monitor para empezar a crear registros y métricas para Communications Services. Para obtener documentación detallada sobre el uso de diagnóstico Configuración en todos los recursos de Azure, consulte: Habilitación del registro en Diagnóstico Configuración

Nota:

En el nombre de la configuración de diagnóstico, seleccione "Registros de actualización del estado de entrega del servicio de correo electrónico", "Registros de interacción de usuario del servicio de correo electrónico" para habilitar los registros de los correos electrónicos.

Screenshot of diagnostic settings for Email.

Categorías del registro de recursos

Communication Services ofrece los siguientes tipos de registros que se pueden habilitar:

  • Usage logs (Registros de uso): proporciona datos de uso asociados a cada oferta de servicio facturada.
  • Registros operativos de envío de correo electrónico: Proporciona información detallada relacionada con las solicitudes de correo de envío del servicio Correo electrónico.
  • Registros operativos de actualización de estado de correo electrónico: Proporciona actualizaciones del estado de entrega a nivel de mensajes y destinatarios, relacionadas con las solicitudes de correo de envío del servicio Correo electrónico.
  • Registros operativos de involucración del usuario de correo electrónico: Proporciona información relacionada con las métricas de interacción del usuario de "apertura" y "clic" para los mensajes enviados desde el servicio Correo electrónico.

Esquema de los registros de uso

Propiedad Descripción
Timestamp Marca de tiempo (UTC) de cuando se generó el registro.
Operation Name Operación asociada al registro.
Operation Version api-version asociada con la operación, si operationName se ha realizado mediante una API. Si no hay ninguna API que corresponda a esta operación, la versión representa la versión de esa operación en caso de que las propiedades asociadas a la operación cambien en el futuro.
Category Categoría de registro del evento. La categoría es la granularidad en la que puede habilitar o deshabilitar los registros en un recurso determinado. Las propiedades que aparecen en el blob de propiedades de un evento son las mismas dentro de una categoría de registro y un tipo de recurso concretos.
Correlation ID Identificador de los eventos correlacionados. Se puede utilizar para identificar eventos correlacionados en varias tablas.
Properties Otros datos aplicables a distintos modos de Communication Services.
Record ID Identificador único de un registro de uso determinado.
Usage Type Modo de uso. (Por ejemplo, chat, RTC, NAT, etc.).
Unit Type Tipo de unidad que se emplea para el uso en un modo determinado. (Por ejemplo, minutos, megabytes, mensajes, etc.).
Quantity Número de unidades usadas o consumidas en este registro.

Registros operativos de envío de correo electrónico

Los registros operativos de envío de correo electrónico proporcionan información valiosa sobre las tendencias de solicitudes de API a lo largo del tiempo. Estos datos le ayudan a detectar análisis de correo electrónico clave, como el número total de correos electrónicos enviados, el tamaño del correo electrónico y el número de correos electrónicos con datos adjuntos. Esta información se puede analizar rápidamente casi en tiempo real y visualizarse de forma fácil de usar para ayudar a impulsar una mejor toma de decisiones.

Propiedad Descripción
TimeGenerated Marca de tiempo (UTC) de cuando se generó el registro.
Location Región donde se procesó la operación.
OperationName Operación asociada al registro.
OperationVersion api-version asociada con la operación, si operationName se realizó mediante una API. Si no hay ninguna API que corresponda a esta operación, la versión representa la versión de esa operación en caso de que las propiedades asociadas a la operación cambien en el futuro.
Category Categoría de registro del evento. La categoría es la granularidad en la que puede habilitar o deshabilitar los registros en un recurso determinado. Las propiedades que aparecen en el blob de propiedades de un evento son las mismas dentro de una categoría de registro y un tipo de recurso concretos.
CorrelationID Identificador de los eventos correlacionados. Se puede utilizar para identificar eventos correlacionados en varias tablas. Para todos los registros operativos de correo electrónico, correlationId se asigna a MessageId, que se devuelve de una solicitud SendMail correcta.
Size Representa el tamaño total del cuerpo del correo electrónico, el asunto, los encabezados y los datos adjuntos en megabytes.
ToRecipientsCount Número total de direcciones de correo electrónico únicas en la línea A.
CcRecipientsCount Número total de direcciones de correo electrónico únicas en la línea Cc.
BccRecipientsCount Número total de direcciones de correo electrónico únicas en la línea Bcc.
UniqueRecipientsCount Este es el recuento total de destinatarios desduplicados para los campos de dirección To, Cc y Bcc.
AttachmentsCount Número total de archivos adjuntos.
TrafficSource Nombre del cliente desde el que se originó la solicitud de correo electrónico.

Muestras

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

Registros operativos de actualización de estado de correo electrónico

Los registros operativos de actualización de estado de correo electrónico proporcionan información detallada sobre las actualizaciones de estado de entrega del nivel de mensaje y destinatario en las solicitudes de la API de sendmail. Estos registros ofrecen detalles específicos del mensaje, como el tiempo de entrega, así como los detalles de nivel de destinatario, como las direcciones de correo electrónico y las actualizaciones de estado de entrega. Al realizar un seguimiento de estos registros, puede garantizar una visibilidad completa del proceso de entrega de correo electrónico, identificando rápidamente los problemas que puedan surgir y tomando medidas correctivas según sea necesario.

Propiedad Descripción
TimeGenerated Marca de tiempo (UTC) de cuando se generó el registro.
Location Región donde se procesó la operación.
OperationName Operación asociada al registro.
OperationVersion api-version asociada con la operación, si operationName se realizó mediante una API. Si no hay ninguna API que corresponda a esta operación, la versión representa la versión de esa operación en caso de que las propiedades asociadas a la operación cambien en el futuro.
Category Categoría de registro del evento. La categoría es la granularidad en la que puede habilitar o deshabilitar los registros en un recurso determinado. Las propiedades que aparecen en el blob de propiedades de un evento son las mismas dentro de una categoría de registro y un tipo de recurso concretos.
CorrelationID Identificador de los eventos correlacionados. Se puede utilizar para identificar eventos correlacionados en varias tablas. Para todos los registros operativos de correo electrónico, correlationId se asigna a MessageId, que se devuelve de una solicitud SendMail correcta.
RecipientId Dirección de correo electrónico del destinatario. Si se trata de un evento a nivel de mensaje, la propiedad estará vacía.
DeliveryStatus Estado del terminal del mensaje.
SmtpStatusCode Código de estado SMTP devuelto desde el servidor de correo electrónico del destinatario en respuesta a una solicitud de envío de correo.
EnhancedSmtpStatusCode Código de estado SMTP mejorado devuelto desde el servidor de correo electrónico del destinatario.
SenderDomain La parte del dominio del SenderAddress usado en el envío de correos electrónicos.
SenderUsername La parte de nombre de usuario de SenderAddress usada en el envío de correos electrónicos.
IsHardBounce Indica si un error de entrega se debe a un problema permanente o temporal. IsHardBounce == true significa un problema de buzón permanente que impide que se entreguen correos electrónicos.

Muestras

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

Registros operativos de involucración del usuario de correo electrónico

Los registros operativos de involucración de usuarios de correo electrónico proporcionan información sobre las tendencias de compromiso de correo electrónico para su sistema de correo electrónico. Estos datos le ayudan a realizar un seguimiento y analizar las métricas clave de correo electrónico, como las tasas de apertura, las tasas de clic a través y las tarifas de cancelación de la suscripción. Estos registros se pueden almacenar y analizar, lo que le permite obtener información más detallada sobre el rendimiento del sistema de correo electrónico y adaptar su estrategia en consecuencia. En general, los registros operativos de Email User Engagement proporcionan una herramienta eficaz para mejorar el rendimiento del sistema de correo electrónico, medir y optimizar proactivamente las campañas de correo electrónico y mejorar la interacción del usuario con el tiempo.

Propiedad Descripción
TimeGenerated Marca de tiempo (UTC) de cuando se generó el registro.
Location Región donde se procesó la operación.
OperationName Operación asociada al registro.
OperationVersion api-version asociada con la operación, si operationName se realizó mediante una API. Si no hay ninguna API que corresponda a esta operación, la versión representa la versión de esa operación en caso de que las propiedades asociadas a la operación cambien en el futuro.
Category Categoría de registro del evento. La categoría es la granularidad en la que puede habilitar o deshabilitar los registros en un recurso determinado. Las propiedades que aparecen en el blob de propiedades de un evento son las mismas dentro de una categoría de registro y un tipo de recurso concretos.
CorrelationID Identificador de los eventos correlacionados. Se puede utilizar para identificar eventos correlacionados en varias tablas. Para todos los registros operativos de correo electrónico, correlationId se asigna a MessageId, que se devuelve de una solicitud SendMail correcta.
RecipientId Dirección de correo electrónico del destinatario. Si se trata de un evento a nivel de mensaje, la propiedad estará vacía.
EngagementType Tipo de evento que se supervisa.
EngagementContext Contexto representa con lo que el usuario ha interactuado.
UserAgent Cadena de agente de usuario del cliente.

Muestras

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