Journaux de 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 supervision 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 à l’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 de Diagnostic Paramètres sur toutes les ressources Azure, consultez : Activer la journalisation dans Diagnostic Paramètres

Remarque

Sous le nom du paramètre de diagnostic, sélectionnez « Journaux de mise à jour de l’état de remise du service de messagerie électronique », « Journaux d’envoi de courrier électronique des utilisateurs du service de messagerie » pour activer les journaux des e-mails 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 aucune API qui correspond à cette opération, la version représente la version de cette opération au cas où les propriétés associées à l’opération changent à l’avenir.
Category	Catégorie de journal de l’événement. La catégorie est la granularité à laquelle vous pouvez activer ou désactiver les journaux d’activité 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 d’activité d’envoi de courrier électronique fournissent des insights précieux sur les tendances des demandes d’API au fil du temps. Ces données vous aident à découvrir des analyses de messagerie clés, telles que le nombre total d’e-mails envoyés, la taille du courrier électronique et le nombre d’e-mails avec des pièces jointes. Ces informations peuvent être rapidement analysées en quasi-temps réel et visualisées de manière 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 aucune API qui correspond à cette opération, la version représente la version de cette opération au cas où les propriétés associées à l’opération changent à l’avenir.
Category	Catégorie de journal de l’événement. La catégorie est la granularité à laquelle vous pouvez activer ou désactiver les journaux d’activité 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 messagerie, l’ID de corrélation est mappé à l’ID de message, qui est retourné par une requête SendMail réussie.
Size	Représente la taille totale du corps de l’e-mail, de l’objet, des en-têtes et des pièces jointes en mégaoctets.
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	Il s’agit du nombre total de destinataires dédupliqués pour les champs d’adresse To, Cc et Cci.
AttachmentsCount	Nombre total de pièces jointes.
TrafficSource	Nom du client à partir duquel provient la demande 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

Les journaux opérationnels de mise à jour de l’état de l’e-mail fournissent des informations détaillées sur les mises à jour de l’état de remise au niveau du destinataire et des messages sur vos demandes d’API sendmail. Ces journaux offrent des détails spécifiques aux messages, tels que le délai de remise, ainsi que les détails au niveau du destinataire, tels que les adresses e-mail et les mises à jour de l’état de remise. En effectuant le suivi de ces journaux, vous pouvez garantir une visibilité complète de votre processus de remise de courrier, en identifiant rapidement les problèmes qui peuvent survenir et en prenant des mesures correctives si nécessaire.

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 aucune API qui correspond à cette opération, la version représente la version de cette opération au cas où les propriétés associées à l’opération changent à l’avenir.
Category	Catégorie de journal de l’événement. La catégorie est la granularité à laquelle vous pouvez activer ou désactiver les journaux d’activité 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 messagerie, l’ID de corrélation est mappé à l’ID de message, 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.
DeliveryStatus	État du terminal du message.
SmtpStatusCode	Code d’état SMTP retourné par le serveur de messagerie destinataire en réponse à une demande de messagerie d’envoi.
EnhancedSmtpStatusCode	Code d’état SMTP amélioré retourné par le serveur de messagerie du destinataire.
SenderDomain	Partie domaine de l’SenderAddress utilisée dans l’envoi d’e-mails.
SenderUsername	Partie nom d’utilisateur de l’SenderAddress utilisée pour l’envoi d’e-mails.
IsHardBounce	Indique si un échec de livraison était 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 de messagerie fournissent des insights sur les tendances d’engagement par e-mail pour votre système de messagerie. Ces données vous permettent de suivre et d’analyser les métriques de courrier clés telles que les taux d’ouverture, les taux de clic 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 Email User Engagement 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 de messagerie 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 aucune API qui correspond à cette opération, la version représente la version de cette opération au cas où les propriétés associées à l’opération changent à l’avenir.
Category	Catégorie de journal de l’événement. La catégorie est la granularité à laquelle vous pouvez activer ou désactiver les journaux d’activité 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 messagerie, l’ID de corrélation est mappé à l’ID de message, 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"
}