Journaux SMS Azure Communication Services

Article
10/26/2023

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.

Important

Les éléments suivants font référence aux journaux activés par le biais d’Azure Monitor (voir également la FAQ). Pour activer ces journaux pour vos services de communication, consultez : Activer la journalisation dans les paramètres de diagnostic

Conditions préalables

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.

Vous trouverez ci-dessous des instructions sur la configuration de 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 « SMS Opérationnel » pour activer les journaux d’activité pour SMS.

Vue d’ensemble

Les journaux opérationnels SMS sont des enregistrements d’événements et d’activités qui fournissent des insights sur vos demandes d’API SMS. Ils ont capturé des détails sur les performances et les fonctionnalités de la primitive SMS, y compris les détails sur l’état du message qu’ils ont été remis, bloqués ou n’ont pas pu envoyer. Les journaux opérationnels SMS contiennent des informations qui permettent d’identifier les tendances et les modèles, de résoudre les problèmes susceptibles d’avoir un impact sur les performances, telles que les remises de messages ayant échoué ou les problèmes de service. Les journaux incluent les détails suivants :

Messages envoyés.
Message reçu.
Messages remis.
Les messages opt-in & opt-out.

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 des opérations du service de SMS : fournit les informations de base relatives au service de SMS

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é selon laquelle vous pouvez activer ou désactiver des 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 des opérations du service de SMS

Propriété	Description
`TimeGenerated`	Horodatage (UTC) de la génération du journal.
`OperationName`	Opération associée à l’enregistrement du journal.
`CorrelationID`	ID des événements corrélés. Peut être utilisé pour identifier les événements corrélés entre plusieurs tables.
`OperationVersion`	Version d’api 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é selon laquelle vous pouvez activer ou désactiver des 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.
`ResultType`	État de l'opération.
`ResultSignature`	Sous-état de l’opération. Si cette opération correspond à un appel d’API REST, ce champ est le code d’état HTTP de l’appel REST correspondant.
`ResultDescription`	Description textuelle statique de cette opération.
`DurationMs`	Durée de l’opération en millisecondes.
`CallerIpAddress`	Adresse IP de l’appelant, si l’opération correspond à un appel d’API qui provient d’une entité avec une adresse IP disponible publiquement.
`Level`	Niveau de gravité de l’événement.
`URI`	URI de la requête.
`OutgoingMessageLength`	Nombre de caractères dans le message sortant.
`IncomingMessageLength`	Nombre de caractères dans le message entrant.
`DeliveryAttempts`	Nombre de tentatives effectuées pour remettre ce message.
`PhoneNumber`	Numéro de téléphone depuis lequel le message SMS est envoyé.
`SdkType`	Type de SDK utilisé dans la demande.
`PlatformType`	Type de plateforme utilisé dans la demande.
`Method`	Méthode utilisée dans la demande.
`NumberType`	Type de numéro à partir duquel le SMS est envoyé. Il peut s’agir de LongCodeNumber ou ShortCodeNumber ou DynamicAlphaSenderID
`MessageID`	Représente l’ID de message unique généré pour chaque message sortant et entrant. Cela se trouve dans l’objet de réponse de l’API SMS
`Country`	Représenter les pays/régions dans lesquels les sms ont été envoyés ou reçus

Exemple de journal envoyé par SMS


    [
      {
        "TimeGenerated": "2022-09-26T15:58:30.100Z",
        "OperationName": "SMSMessagesSent",
        "CorrelationId": "dDRmubfpNZZZZZnxBtw3Q.0",
        "OperationVersion": "2020-07-20-preview1",
        "Category":"SMSOperational",
        "ResultType": "Succeeded",
        "ResultSignature": 202,
        "DurationMs": 130,
        "CallerIpAddress": "127.0.0.1",
        "Level": "Informational",
        "URI": "https://sms-e2e-prod.communication.azure.com/sms?api-version=2020-07-20-preview1",
        "OutgoingMessageLength": 151,
        "IncomingMessageLength": 0,
        "DeliveryAttempts": 0,
        "PhoneNumber": "+18445791704",
        "NumberType": "LongCodeNumber",
        "SdkType": "azsdk-net-Communication.Sms",
        "PlatformType": "Microsoft Windows 10.0.17763",
        "Method": "POST",
        "MessageId": "Outgoing_20230118181300ff00e5c9-876d-4958-86e3-4637484fe5bd_noam",
        "Country": "US"
      }
    ]

Exemple de journal de rapport de remise SMS


    [
      {
        "TimeGenerated": "2022-09-26T15:58:30.200Z",
        "OperationName": "SMSDeliveryReportsReceived",
        "CorrelationId": "tl8WpUTESTSTSTccYadXJm.0",
        "Category":"SMSOperational",
        "ResultType": "Succeeded",
        "ResultSignature": 200,
        "DurationMs": 130,
        "CallerIpAddress": "127.0.0.1",
        "Level": "Informational",
        "URI": "https://global.smsgw.prod.communication.microsoft.com/rtc/telephony/sms/DeliveryReport",
        "OutgoingMessageLength": 0,
        "IncomingMessageLength": 0,
        "DeliveryAttempts": 1,
        "PhoneNumber": "+18445791704",
        "NumberType": "LongCodeNumber",
        "SdkType": "",
        "PlatformType": "",
        "Method": "POST",
        "MessageId": "Outgoing_20230118181300ff00e5c9-876d-4958-86e3-4637484fe5bd_noam",
        "Country": "US"
      }
    ]

Exemple de journal reçu SMS


    [
      {
        "TimeGenerated": "2022-09-27T15:58:30.200Z",
        "OperationName": "SMSMessagesReceived",
        "CorrelationId": "e2KFTSTSTI/5PTx4ZZB.0",
        "Category":"SMSOperational",
        "ResultType": "Succeeded",
        "ResultSignature": 200,
        "DurationMs": 130,
        "CallerIpAddress": "127.0.0.1",
        "Level": "Informational",
        "URI": "https://global.smsgw.prod.communication.microsoft.com/rtc/telephony/sms/inbound",
        "OutgoingMessageLength": 0,
        "IncomingMessageLength": 110,
        "DeliveryAttempts": 0,
        "PhoneNumber": "+18445791704",
        "NumberType": "LongCodeNumber",
        "SdkType": "",
        "PlatformType": "",
        "Method": "POST",
        "MessageId": "Incoming_2023011818121211c6ee31-63fe-477c-8d51-f800543c6694",
        "Country": "US"
      }
    ]

(voir aussi FAQ).