SMS-Protokolle für Azure Communication Services

Artikel
10/26/2023

Azure Communication Services bietet Protokollierungsfunktionen, mit denen Sie Ihre Communication Services-Lösung überwachen und debuggen können. Diese Funktionen können über das Azure-Portal konfiguriert werden.

Wichtig

Die folgenden Ausführungen beziehen sich auf Protokolle, die über Azure Monitor (siehe auch FAQ). Um diese Protokolle für Ihre Kommunikationsdienste zu aktivieren, siehe: Protokollierung in den Diagnoseeinstellungen aktivieren

Voraussetzungen

Azure Communications Services bietet Überwachungs- und Analysefeatures über Azure Monitor-Protokolle – Übersicht und Azure Monitor-Metriken. Jede Azure-Ressource erfordert eine eigene Diagnoseeinstellung, die folgende Kriterien definiert:

Kategorien der Protokolle und Metrikdaten, die an die in der Einstellung definierten Ziele gesendet werden. Die verfügbaren Kategorien sind je nach Ressourcentyp verschieden.
Ein oder mehrere Ziele zum Senden der Protokolle. Zu den aktuellen Zielen gehören der Log Analytics-Arbeitsbereich, Event Hubs und Azure Storage.
Mit einer einzelnen Diagnoseeinstellung kann maximal eines der Ziele definiert werden. Wenn Sie Daten an mehrere Ziele eines bestimmten Typs senden möchten (z.B. zwei verschiedene Log Analytics-Arbeitsbereiche), dann erstellen Sie mehrere Einstellungen. Jede Ressource kann bis zu fünf Diagnoseeinstellungen haben.

Im Folgenden finden Sie Anweisungen zur Konfiguration Ihrer Azure Monitor-Ressource, damit Sie Protokolle und Metriken für Ihre Kommunikationsdienste erstellen können. Ausführliche Dokumentation zur Verwendung von Diagnose-Einstellungen in allen Azure-Ressourcen finden Sie unter: Aktivieren der Protokollierung in Diagnostic Einstellungen

Hinweis

Wählen Sie unter dem Namen der Diagnoseeinstellung "SMS Operational" aus, um die Protokolle für SMS zu aktivieren.

Übersicht

SMS-Betriebsprotokolle sind Datensätze von Ereignissen und Aktivitäten, die Einblicke in Ihre SMS-API-Anforderungen bieten. Sie erfassten Details zur Leistung und Funktionalität des SMS-Grundtyps, einschließlich Details zum Status der Nachricht, ob sie erfolgreich zugestellt, blockiert oder nicht gesendet wurden. SMS-Betriebsprotokolle enthalten Informationen, die helfen, Trends und Muster zu identifizieren, Probleme zu beheben, die sich auf die Leistung solcher fehlgeschlagenen Nachrichtenlieferungen auswirken oder Probleme bereitstellen können. Die Protokolle enthalten die folgenden Details:

Gesendete Nachrichten.
Empfangene Nachricht.
Gesendete Nachrichten.
Nachrichten opt-in & opt-out.

Ressourcenprotokollkategorien

Communication Services bietet die folgenden Protokolltypen, die Sie aktivieren können:

Nutzungsprotokolle – Stellt Nutzungsdaten bereit, die den einzelnen abgerechneten Dienstangeboten zugeordnet sind.
SMS-Betriebsprotokolle: Stellt grundlegende Informationen zum SMS-Dienst bereit.

Schema für Nutzungsprotokolle

Eigenschaft	Beschreibung
`Timestamp`	Der Zeitstempel (UTC), wann das Protokoll generiert wurde.
`Operation Name`	Der mit der Protokollaufzeichnung verbundene Vorgang.
`Operation Version`	Die `api-version`, die dem Vorgang zugeordnet ist, wenn für „operationName“ eine API verwendet wurde. Wenn keine API vorhanden ist, die diesem Vorgang entspricht, stellt die Version die Version dieses Vorgangs dar, falls die eigenschaften, die der Vorgangsänderung zugeordnet sind, in Zukunft geändert werden.
`Category`	Die Protokollkategorie des Ereignisses. „category“ ist die Granularität, mit der Sie Protokolle für eine bestimmte Ressource aktivieren oder deaktivieren können. Die Eigenschaften, die im Eigenschaftenblob eines Ereignisses angezeigt werden, sind für eine bestimmte Protokollkategorie und einen Ressourcentyp gleich.
`Correlation ID`	Die ID für korrelierte Ereignisse. Kann verwendet werden, um korrelierte Ereignisse zwischen verschiedenen Tabellen zu identifizieren.
`Properties`	Andere Daten, die auf verschiedene Communication Services-Modi anwendbar sind.
`Record ID`	Die eindeutige ID für einen angegebenen Nutzungsdatensatz.
`Usage Type`	Die Art der Nutzung. (Beispiel: Chat, PSTN, NAT usw.)
`Unit Type`	Der Typ der Einheit, auf dem die Nutzung für eine bestimmte Nutzungsart basiert. (Beispiel Minuten, Megabyte, Nachrichten usw.)
`Quantity`	Die Anzahl der für diesen Datensatz verwendeten oder verbrauchten Einheiten.

Protokolle zum SMS-Betrieb

Eigenschaft	Beschreibung
`TimeGenerated`	Der Zeitstempel (UTC), wann das Protokoll generiert wurde.
`OperationName`	Der mit der Protokollaufzeichnung verbundene Vorgang.
`CorrelationID`	Die ID für korrelierte Ereignisse. Kann verwendet werden, um korrelierte Ereignisse zwischen verschiedenen Tabellen zu identifizieren.
`OperationVersion`	Die API-Version, die dem Vorgang zugeordnet ist, wenn für „operationName“ eine API verwendet wurde. Wenn keine API vorhanden ist, die diesem Vorgang entspricht, stellt die Version die Version dieses Vorgangs dar, falls die eigenschaften, die der Vorgangsänderung zugeordnet sind, in Zukunft geändert werden.
`Category`	Die Protokollkategorie des Ereignisses. „category“ ist die Granularität, mit der Sie Protokolle für eine bestimmte Ressource aktivieren oder deaktivieren können. Die Eigenschaften, die im Eigenschaftenblob eines Ereignisses angezeigt werden, sind für eine bestimmte Protokollkategorie und einen Ressourcentyp gleich.
`ResultType`	Der Status des Vorgangs.
`ResultSignature`	Der Unterstatus des Vorgangs. Wenn dieser Vorgang einem REST-API-Aufruf entspricht, ist dieses Feld der HTTP-Statuscode des entsprechenden REST-Aufrufs.
`ResultDescription`	Die statische Textbeschreibung dieses Vorgangs.
`DurationMs`	Die Dauer des Vorgangs in Millisekunden.
`CallerIpAddress`	Die IP-Adresse des Aufrufers, wenn der Vorgang einem API-Aufruf entspricht, der von einer Entität mit einer öffentlich verfügbaren IP-Adresse stammt.
`Level`	Der Schweregrad des Ereignisses.
`URI`	Der URI der Anforderung.
`OutgoingMessageLength`	Die Anzahl der Zeichen in der ausgehenden Nachricht.
`IncomingMessageLength`	Die Anzahl der Zeichen in der eingehenden Nachricht.
`DeliveryAttempts`	Die Anzahl der Versuche, die unternommen wurden, um diese Nachricht zuzustellen.
`PhoneNumber`	Die Telefonnummer, von der die SMS-Nachricht gesendet wird.
`SdkType`	Der in der Anforderung verwendete SDK-Typ.
`PlatformType`	Der in der Anforderung verwendete Plattformtyp.
`Method`	Die in der Anforderung verwendete Methode.
`NumberType`	Der Nummerntyp, von dem die SMS-Nachricht gesendet wird. Es kann entweder LongCodeNumber oder ShortCodeNumber oder DynamicAlphaSenderID sein.
`MessageID`	Stellt die eindeutige messageId dar, die für jede ausgehende und eingehende Nachricht generiert wird. Dies finden Sie im SMS-API-Antwortobjekt.
`Country`	Stellen Sie die Länder/Regionen dar, in denen die SMS-Nachrichten an oder empfangen wurden.

Beispiel für ein gesendetes SMS-Protokoll


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

Beispiel für ein SMS-Übermittlungsberichtsprotokoll


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

Beispiel für ein empfangenes SMS-Protokoll


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

(siehe auch Häufig gestellte Fragen( FAQ)

Freigeben über