Journaux de la messagerie Azure Communication Services

Azure Communication Services offre des fonctionnalités de journalisation que vous pouvez utiliser pour superviser et déboguer votre solution Communication Services. Ces fonctionnalités peuvent être configurées à l’aide du portail Azure.

Prérequis

Azure Communications Services fournit des fonctionnalités de surveillance et d’analytique via la vue d’ensemble des journaux Azure Monitor et les métriques Azure Monitor. Chaque ressource Azure requiert son propre paramètre de diagnostic, qui définit les critères suivants :

• Catégories de journaux et données de métriques envoyées aux destinations définies dans le paramètre. Les catégories disponibles varient en fonction des types de ressources.
• Une ou plusieurs destinations auxquelles envoyer les journaux. Les destinations actuelles sont l’espace de travail Log Analytics, Event Hubs et le Stockage Azure.
• Un seul paramètre de diagnostic ne peut pas définir plus d’une destination. Si vous souhaitez envoyer des données à plus d’un type de destination (par exemple, deux espaces de travail Log Analytics), créez plusieurs paramètres. Chaque ressource peut avoir jusqu’à cinq paramètres de diagnostic.

Important

L'activation d'un paramètre de diagnostic dans Azure Monitor est nécessaire pour envoyer les données de journal de vos enquêtes à un espace de travail Log Analytics, à Event Hubs ou encore à un compte de stockage Azure afin de recevoir et d'analyser les données de vos enquêtes. Si vous n’envoyez pas de données d’automatisation des appels à une de ces options, vos données d’enquête ne seront pas stockées et seront perdues. Les instructions suivantes permettent de configurer votre ressource Azure Monitor pour commencer à créer des journaux et des métriques pour vos services de communication. Pour obtenir une documentation détaillée sur l’utilisation des paramètres de diagnostic pour toutes les ressources Azure, consultez Activer la journalisation dans les paramètres de diagnostic.

Remarque

Sous le nom du paramètre de diagnostic, sélectionnez « Journaux de mise à jour de l’état de remise du service de messagerie », « Journaux d’envoi des messages du service de messagerie » et « Journaux d’engagement des utilisateurs du service de messagerie » pour activer les journaux pour les e-mails.

Catégories de journaux de ressources

Communication Services propose les types de journaux suivants que vous pouvez activer :

• Journaux d’utilisation : fournit les données d’utilisation associées à chaque offre de service facturée
• Journaux opérationnels Email Send Mail : fournissent des informations détaillées sur l’envoi de requêtes d’envoi d’e-mails.
• Journaux opérationnels Email Status Update : fournissent des mises à jour d’état de remise au niveau du destinataire et des messages liées aux requêtes d’e-mails du service de messagerie.
• Journaux opérationnels Email User Engagement : fournissent des informations relatives aux métriques d’engagement utilisateur « ouverts » et « cliqués » pour les messages envoyés à partir du service de messagerie.

Schéma des journaux d’utilisation

Propriété	Description
Timestamp	Horodatage (UTC) de la génération du journal.
Operation Name	Opération associée à l’enregistrement du journal.
Operation Version	api-version associée à l’opération, si operationName a été effectuée à l’aide d’une API. S’il n’existe pas d’API correspondant à cette opération, la version représente la version de cette opération pour le cas où les propriétés associées à l’opération viendraient à changer dans le futur.
Category	Catégorie de journal de l’événement. La catégorie est la granularité selon laquelle vous pouvez activer ou désactiver des journaux sur une ressource particulière. Les propriétés qui apparaissent dans l’objet blob de propriétés d’un événement sont les mêmes au sein d’un type de ressource et d’une catégorie de journal spécifique.
Correlation ID	ID des événements corrélés. Peut être utilisé pour identifier les événements corrélés entre plusieurs tables.
Properties	Autres données applicables aux différents modes de Communication Services.
Record ID	ID unique d’un enregistrement d’utilisation donné.
Usage Type	Mode d’utilisation. (par exemple, conversation, RTC, NAT, etc.)
Unit Type	Type d’unité sur lequel l’utilisation est basée pour un mode d’utilisation donné. (par exemple, minutes, mégaoctets, messages, etc.)
Quantity	Nombre d’unités utilisées ou consommées pour cet enregistrement.

Journaux opérationnels Email Send Mail

Les journaux opérationnels d’envoi de courrier de la messagerie fournissent des informations précieuses sur les tendances des requêtes d’API au fil du temps. Ces données vous aident à découvrir des éléments clés de l’analytique de la messagerie, comme le nombre total d’e-mails envoyés, la taille des e-mails et le nombre d’e-mails avec des pièces jointes. Ces informations peuvent être analysées rapidement en quasi-temps réel et visualisées de façon conviviale pour faciliter la prise de décision.

Propriété	Description
TimeGenerated	Horodatage (UTC) de la génération du journal.
Location	Région où l’opération a été traitée.
OperationName	Opération associée à l’enregistrement de journal.
OperationVersion	api-version associée à l’opération, si operationName a été effectuée à l’aide d’une API. S’il n’existe pas d’API correspondant à cette opération, la version représente la version de cette opération pour le cas où les propriétés associées à l’opération viendraient à changer dans le futur.
Category	Catégorie de journal de l’événement. La catégorie est la granularité selon laquelle vous pouvez activer ou désactiver des journaux sur une ressource particulière. Les propriétés qui apparaissent dans l’objet blob de propriétés d’un événement sont les mêmes au sein d’un type de ressource et d’une catégorie de journal spécifique.
CorrelationID	ID des événements corrélés. Peut être utilisé pour identifier les événements corrélés entre plusieurs tables. Pour tous les journaux opérationnels de la messagerie, CorrelationId est mappé au MessageId, qui est retourné par une requête SendMail réussie.
Size	Représente la taille totale en mégaoctets du corps, de l’objet, des en-têtes et des pièces jointes des e-mails.
ToRecipientsCount	Nombre total d’adresses e-mail uniques sur la ligne À.
CcRecipientsCount	Nombre total d’adresses e-mail uniques sur la ligne Cc.
BccRecipientsCount	Nombre total d’adresses e-mail uniques sur la ligne CCi.
UniqueRecipientsCount	C’est le nombre total de destinataires dédupliqués pour les champs d’adresse À, Cc et Cci.
AttachmentsCount	Nombre total de pièces jointes.
TrafficSource	Le nom du client dont provient la requête d’e-mail.

Exemples

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

Journaux opérationnels Email Status Update

Journaux opérationnels de mise à jour de l’état des e-mails fournissent des insights détaillés sur les mises à jour de l’état de remise au niveau des messages et des destinataires sur vos requêtes d’API SendMail.

• Les mises à jour d’état au niveau du message fournissent l’état des opérations d’envoi d’e-mail de longue durée (similaires aux mises à jour d’état que vous recevez via l’appel de nos API GET). Celles-ci sont marquées par l’absence de la propriété RecipientId, car ces mises à jour concernent l’intégralité du message et ne s’appliquent pas à un destinataire spécifique dans cette requête de message. La propriété DeliveryStatus contient l’état de remise au niveau du message. Les valeurs possibles de DeliveryStatus pour ce type d’événement sont Dropped, OutForDelivery et Queued.
• Les mises à jour d’état au niveau du destinataire fournissent l’état de la remise de l’e-mail pour chaque destinataire individuel auquel l’e-mail a été envoyé dans un seul message. Celles-ci contiennent une propriété RecipientId avec l’adresse e-mail du destinataire. L’état de la remise au niveau du destinataire est fourni dans la propriété DeliveryStatus. Les valeurs possibles de DeliveryStatus pour ce type d’événement sont Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressed et Bounced. En effectuant le suivi de ces journaux, vous pouvez offrir une visibilité complète de votre processus de remise des e-mails, en identifiant rapidement les problèmes qui peuvent survenir et en prenant si nécessaire des mesures correctives.

Propriété	Description
TimeGenerated	Horodatage (UTC) de la génération du journal.
Location	Région où l’opération a été traitée.
OperationName	Opération associée à l’enregistrement de journal.
OperationVersion	api-version associée à l’opération, si operationName a été effectuée à l’aide d’une API. S’il n’existe pas d’API correspondant à cette opération, la version représente la version de cette opération pour le cas où les propriétés associées à l’opération viendraient à changer dans le futur.
Category	Catégorie de journal de l’événement. La catégorie est la granularité selon laquelle vous pouvez activer ou désactiver des journaux sur une ressource particulière. Les propriétés qui apparaissent dans l’objet blob de propriétés d’un événement sont les mêmes au sein d’un type de ressource et d’une catégorie de journal spécifique.
CorrelationID	ID des événements corrélés. Peut être utilisé pour identifier les événements corrélés entre plusieurs tables. Pour tous les journaux opérationnels de la messagerie, CorrelationId est mappé au MessageId, qui est retourné par une requête SendMail réussie.
RecipientId	Adresse e-mail du destinataire ciblé. Il présent seulement pour les événements au niveau du destinataire. S’il s’agit d’un événement au niveau du message, la propriété est vide.
DeliveryStatus	État du terminal du message. Les valeurs possibles pour un événement au niveau du message sont : Dropped, OutForDelivery et Queued. Les valeurs possibles pour un événement au niveau du destinataire sont : Delivered, Expanded, Failed, Quarantined, FilteredSpam, Suppressed et Bounced.
SmtpStatusCode	Code d’état SMTP retourné par le serveur de messagerie du destinataire en réponse à une requête d’envoi de message.
EnhancedSmtpStatusCode	Code d’état SMTP amélioré retourné par le serveur de messagerie du destinataire.
SenderDomain	La partie « domaine » de la SenderAddress utilisée dans l’envoi d’e-mails.
SenderUsername	La partie « nom d’utilisateur » de la SenderAddress utilisée dans l’envoi d’e-mails.
IsHardBounce	Indique si un échec de remise est dû à un problème permanent ou temporaire. IsHardBounce == true signifie qu’un problème de boîte aux lettres permanent empêche la remise des e-mails.

Exemples

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

Journaux opérationnels Email User Engagement

Les journaux opérationnels d’engagement des utilisateurs par e-mail fournissent des insights sur les tendances d’engagement par e-mail pour votre système de messagerie. Ces données vous permettent de faire le suivi et d’analyser des métriques de messagerie clés comme les taux d’ouverture, les taux de clics et les taux de désabonnement. Ces journaux peuvent être stockés et analysés, ce qui vous permet d’obtenir des insights plus approfondis sur les performances de votre système de messagerie et d’adapter votre stratégie en conséquence. Dans l’ensemble, les journaux opérationnels d’engagement des utilisateurs par e-mail fournissent un outil puissant permettant d’améliorer les performances de votre système de messagerie, de mesurer et d’optimiser de manière proactive vos campagnes par e-mail et d’améliorer l’engagement des utilisateurs au fil du temps.

Propriété	Description
TimeGenerated	Horodatage (UTC) de la génération du journal.
Location	Région où l’opération a été traitée.
OperationName	Opération associée à l’enregistrement de journal.
OperationVersion	api-version associée à l’opération, si operationName a été effectuée à l’aide d’une API. S’il n’existe pas d’API correspondant à cette opération, la version représente la version de cette opération pour le cas où les propriétés associées à l’opération viendraient à changer dans le futur.
Category	Catégorie de journal de l’événement. La catégorie est la granularité selon laquelle vous pouvez activer ou désactiver des journaux sur une ressource particulière. Les propriétés qui apparaissent dans l’objet blob de propriétés d’un événement sont les mêmes au sein d’un type de ressource et d’une catégorie de journal spécifique.
CorrelationID	ID des événements corrélés. Peut être utilisé pour identifier les événements corrélés entre plusieurs tables. Pour tous les journaux opérationnels de la messagerie, CorrelationId est mappé au MessageId, qui est retourné par une requête SendMail réussie.
RecipientId	Adresse e-mail du destinataire ciblé. S’il s’agit d’un événement au niveau du message, la propriété est vide.
EngagementType	Type d’engagement utilisateur suivi.
EngagementContext	Le contexte représente l’élément avec lequel l’utilisateur a interagi.
UserAgent	Chaîne de l’agent utilisateur du client.

Exemples

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