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 Información general de registros de Azure Monitor y 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 los datos de automatización de llamadas a una de estas opciones, los datos de la encuesta no se almacenarán y se perderán A continuación encontrará instrucciones para configurar el recurso de Azure Monitor para empezar a crear registros y métricas para Communications Services. Puede encontrar documentación detallada sobre el uso de Configuración de diagnóstico en todos los recursos de Azure en Habilitación del registro en Configuración de diagnóstico

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 envío de correo del servicio de correo electrónico", "Registros de interacción del usuario del servicio de correo electrónico" para habilitar los registros de los correos electrónicos

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 con la operación cambien en el futuro.
Category	Categoría de registro del evento. La categoría es la granularidad con la que se pueden 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 sencilla para ayudar a tomar mejores 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 con la operación cambien en el futuro.
Category	Categoría de registro del evento. La categoría es la granularidad con la que se pueden 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 al 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 número total de destinatarios desduplicados para los campos de dirección A, Cc y Bcc.
AttachmentsCount	Número total de archivos adjuntos.
TrafficSource	El 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 a nivel de mensaje y destinatario en las solicitudes de la API de sendmail.

• Las actualizaciones de estado a nivel de mensaje proporcionan el estado de la operación de envío de correo electrónico de larga duración (similar a las actualizaciones de estado que recibe a través de llamadas a nuestras API de GET). Estos están marcados por la ausencia de la propiedad RecipientId porque estas actualizaciones son para todo el mensaje y no son aplicables a un destinatario específico en esa solicitud de mensaje. La propiedad DeliveryStatus contiene el estado de entrega de nivel de mensaje. Los valores posibles para DeliveryStatus para este tipo de evento son Dropped, OutForDelivery y Queued.
• Las actualizaciones de estado de nivel de destinatario proporcionan el estado de entrega de correo electrónico para cada destinatario individual al que se envió el correo electrónico en un único mensaje. Contienen una propiedad RecipientId con la dirección de correo electrónico del destinatario. El estado de entrega a nivel de destinatario se proporciona en la propiedad DeliveryStatus. Los valores posibles de DeliveryStatus para este tipo de evento son Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressed y Bounced. 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 con la operación cambien en el futuro.
Category	Categoría de registro del evento. La categoría es la granularidad con la que se pueden 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 al MessageId, que se devuelve de una solicitud SendMail correcta.
RecipientId	Dirección de correo electrónico del destinatario. Solo está presente para eventos a nivel de destinatario. Si se trata de un evento a nivel de mensaje, la propiedad estará vacía.
DeliveryStatus	Estado del terminal del mensaje. Los valores posibles para el evento a nivel de mensaje son: Dropped, OutForDelivery, Queued. Los valores posibles para un evento a nivel de destinatario son: Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressed, Bounced.
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 que existe un problema permanente en el buzón 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 del usuario en el correo electrónico proporcionan información sobre las tendencias de interacción con el correo electrónico para su sistema de correo electrónico. Estos datos le ayudan a realizar un seguimiento y analizar las métricas clave del correo electrónico, como las tasas de apertura, de clics y de cancelación de suscripciones. 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 la involucración del usuario en el correo electrónico proporcionan una herramienta eficaz para mejorar el rendimiento del sistema de correo electrónico, medir y optimizar de forma proactiva las campañas de correo electrónico y mejorar la involucració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 con la operación cambien en el futuro.
Category	Categoría de registro del evento. La categoría es la granularidad con la que se pueden 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 al 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"
}