Sms-logboeken van Azure Communication Services

Artikel
10/26/2023

Azure Communication Services biedt mogelijkheden voor logboekregistratie die u kunt gebruiken om uw Communication Services-oplossing te bewaken en fouten op te sporen. Deze mogelijkheden kunnen worden geconfigureerd via de Azure Portal.

Belangrijk

Hieronder wordt verwezen naar logboeken die zijn ingeschakeld via Azure Monitor (zie ook veelgestelde vragen). Als u deze logboeken voor uw Communications Services wilt inschakelen, raadpleegt u: Logboekregistratie in diagnostische instellingen inschakelen

Vereisten

Azure Communications Services biedt bewakings- en analysefuncties via het overzicht van Azure Monitor-logboeken en metrische gegevens van Azure Monitor. Voor elke Azure-resource is een eigen diagnostische instelling vereist, die de volgende criteria definieert:

Categorieën logboeken en metrische gegevens die worden verzonden naar de bestemmingen die in de instelling zijn gedefinieerd. De beschikbare categorieën variëren voor verschillende resourcetypen.
Een of meer bestemmingen voor de logboeken. Huidige bestemmingen omvatten Log Analytics-werkruimte, Event Hubs en Azure Storage.
Eén diagnostische instelling kan niet meer dan één van de bestemmingen definiëren. Als u gegevens wilt verzenden naar meer dan een van een bepaald doeltype (bijvoorbeeld twee verschillende Log Analytics-werkruimten), maakt u meerdere instellingen. Elke resource kan maximaal vijf diagnostische instellingen hebben.

Hieronder volgen instructies voor het configureren van uw Azure Monitor-resource om te beginnen met het maken van logboeken en metrische gegevens voor uw Communications Services. Zie voor gedetailleerde documentatie over het gebruik van diagnostische instellingen voor alle Azure-resources: Logboekregistratie in diagnostische instellingen inschakelen

Notitie

Selecteer onder de naam van de diagnostische instelling 'SMS Operational' om de logboeken voor SMS in te schakelen.

Overzicht

Operationele sms-logboeken zijn records van gebeurtenissen en activiteiten die inzicht bieden in uw SMS-API-aanvragen. Ze hebben details vastgelegd over de prestaties en functionaliteit van de SMS-primitieve, inclusief details over de status van het bericht, ongeacht of ze zijn bezorgd, geblokkeerd of niet verzonden. Operationele sms-logboeken bevatten informatie over het identificeren van trends en patronen, het oplossen van problemen die van invloed kunnen zijn op de prestaties, zoals leveringen van mislukte berichten of problemen. De logboeken bevatten de volgende details:

Verzonden berichten.
Bericht ontvangen.
Berichten bezorgd.
Berichten die zich aanmelden en afmelden.

Categorieën van resourcelogboeken

Communication Services biedt de volgende typen logboeken die u kunt inschakelen:

Gebruikslogboeken - bevat gebruiksgegevens die zijn gekoppeld aan elke gefactureerde serviceaanbieding
Operationele logboeken van sms - bevat basisinformatie met betrekking tot de sms-service

Schema voor gebruikslogboeken

Eigenschappen	Beschrijving
`Timestamp`	De timestamp (UTC) van het moment waarop het logboek werd gegenereerd.
`Operation Name`	De bewerking die aan de logboekrecord is gekoppeld.
`Operation Version`	De `api-version` gekoppeld aan de bewerking, als operationName is uitgevoerd met behulp van een API. Als er geen API is die overeenkomt met deze bewerking, vertegenwoordigt de versie de versie van die bewerking als de eigenschappen die zijn gekoppeld aan de bewerking in de toekomst veranderen.
`Category`	De logboekcategorie van de gebeurtenis. De categorie is de granulariteit waarmee u logboeken voor op een bepaalde resource kunt in- of uitschakelen. De eigenschappen die worden weergegeven in de blob-eigenschappen van een gebeurtenis zijn hetzelfde binnen een bepaalde logboekcategorie en resourcetype.
`Correlation ID`	De id voor gecorreleerde gebeurtenissen. Kan worden gebruikt om gecorreleerde gebeurtenissen tussen meerdere tabellen te identificeren.
`Properties`	Andere gegevens die van toepassing zijn op verschillende modi van Communication Services.
`Record ID`	De unieke id voor een bepaald gebruiksrecord.
`Usage Type`	De modus van gebruik. (bijvoorbeeld chat, PSTN, NAT, enz.)
`Unit Type`	Het type eenheid waarop het gebruik van een bepaalde gebruiksmodus is gebaseerd. (bijvoorbeeld minuten, megabytes, berichten, enz.).
`Quantity`	Het aantal eenheden dat is gebruikt of verbruikt voor deze record.

Operationele logboeken van sms

Eigenschappen	Beschrijving
`TimeGenerated`	De timestamp (UTC) van het moment waarop het logboek werd gegenereerd.
`OperationName`	De bewerking die aan de logboekrecord is gekoppeld.
`CorrelationID`	De id voor gecorreleerde gebeurtenissen. Kan worden gebruikt om gecorreleerde gebeurtenissen tussen meerdere tabellen te identificeren.
`OperationVersion`	De API-versie gekoppeld aan de bewerking, als operationName is uitgevoerd met behulp van een API. Als er geen API is die overeenkomt met deze bewerking, vertegenwoordigt de versie de versie van die bewerking als de eigenschappen die zijn gekoppeld aan de bewerking in de toekomst veranderen.
`Category`	De logboekcategorie van de gebeurtenis. De categorie is de granulariteit waarmee u logboeken voor op een bepaalde resource kunt in- of uitschakelen. De eigenschappen die worden weergegeven in de blob-eigenschappen van een gebeurtenis zijn hetzelfde binnen een bepaalde logboekcategorie en resourcetype.
`ResultType`	De status van de bewerking.
`ResultSignature`	De substatus van de bewerking. Als deze bewerking overeenkomt met een REST API-aanroep, dan is dit veld de HTTP-statuscode van de bijbehorende REST-aanroep.
`ResultDescription`	De statische tekstbeschrijving van deze bewerking.
`DurationMs`	De duur van de bewerking in milliseconden.
`CallerIpAddress`	Het IP-adres van de oproepende functie, als de bewerking overeenkomt met een API-aanroep die afkomstig zou zijn van een entiteit met een openbaar beschikbaar IP-adres.
`Level`	De ernst van de gebeurtenis.
`URI`	De URI van de aanvraag.
`OutgoingMessageLength`	Het aantal tekens in het uitgaande bericht.
`IncomingMessageLength`	Het aantal tekens in het binnenkomende bericht.
`DeliveryAttempts`	Het aantal pogingen dat is gedaan om dit bericht af te leveren.
`PhoneNumber`	Het telefoonnummer van het sms-bericht wordt verzonden.
`SdkType`	Het SDK-type dat in de aanvraag wordt gebruikt.
`PlatformType`	Het platformtype dat in de aanvraag wordt gebruikt.
`Method`	De methode die in de aanvraag wordt gebruikt.
`NumberType`	Het type nummer waaruit het SMS-bericht wordt verzonden. Dit kan LongCodeNumber of ShortCodeNumber of DynamicAlphaSenderID zijn
`MessageID`	Vertegenwoordig de unieke messageId die wordt gegenereerd voor elk uitgaand en binnenkomend bericht. Dit is te vinden in het SMS API-antwoordobject
`Country`	Vertegenwoordig de landen/regio's waar de SMS-berichten zijn verzonden naar of ontvangen van

Voorbeeld van een verzonden sms-logboek


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

Voorbeeld van een rapportlogboek voor sms-bezorging


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

Voorbeeld van een ontvangen sms-logboek


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

(zie ook Veelgestelde vragen).

Delen via