Azure Communication Services SMS-naplók

Cikk
11/06/2024

Az Azure Communication Services naplózási képességeket kínál, amelyekkel monitorozhat és hibakeresést végezhet a Communication Services-megoldásban. Ezek a képességek az Azure Portalon konfigurálhatók.

Fontos

Az alábbiak az Azure Monitoron keresztül engedélyezett naplókra vonatkoznak (lásd még a gyakori kérdéseket). Ha engedélyezni szeretné ezeket a naplókat a Communications Servicesben, olvassa el a következőt: Naplózás engedélyezése a diagnosztikai beállításokban

Előfeltételek

Az Azure Communications Services monitorozási és elemzési funkciókat biztosít az Azure Monitor-naplók áttekintésében és az Azure Monitor-metrikákban. Minden Azure-erőforráshoz saját diagnosztikai beállítás szükséges, amely a következő feltételeket határozza meg:

A naplók és a metrikaadatok kategóriái, amelyeket a beállításban meghatározott célhelyekre küldtek. A rendelkezésre álló kategóriák eltérőek lesznek a különböző erőforrástípusok esetében.
Egy vagy több célhely a naplók elküldéséhez. Az aktuális célhelyek közé tartozik a Log Analytics-munkaterület, az Event Hubs és az Azure Storage.
Egyetlen diagnosztikai beállítás legfeljebb egy célhelyet definiálhat. Ha több céltípusba (például két különböző Log Analytics-munkaterületre) szeretne adatokat küldeni, hozzon létre több beállítást. Minden erőforrás legfeljebb öt diagnosztikai beállításokkal rendelkezhet.

Az alábbiakban útmutatást talál az Azure Monitor-erőforrás konfigurálásához, hogy naplókat és metrikákat hozzon létre a Communications Serviceshez. A diagnosztikai beállítások az összes Azure-erőforráson való használatával kapcsolatos részletes dokumentációt a következő témakörben találja: Naplózás engedélyezése a diagnosztikai beállításokban

Feljegyzés

A diagnosztikai beállítás neve alatt válassza az "SMS Operational" lehetőséget az SMS-naplók engedélyezéséhez.

Áttekintés

Az SMS működési naplói olyan események és tevékenységek rekordjai, amelyek betekintést nyújtanak az SMS API-kérésekbe. Rögzítették az SMS primitív teljesítményének és funkcióinak részleteit, beleértve az üzenet állapotával kapcsolatos részleteket, függetlenül attól, hogy sikeresen kézbesítették, blokkolták vagy nem sikerült elküldeni őket. Az SMS működési naplói olyan információkat tartalmaznak, amelyek segítenek azonosítani a trendeket és a mintákat, elhárítani a teljesítményre esetlegesen hatással lehetó problémákat, például a sikertelen üzenetek kézbesítését vagy a problémák kiszolgálását. A naplók a következő adatokat tartalmazzák:

Elküldött üzenetek.
Üzenet érkezett.
Kézbesített üzenetek.
Üzenetek – opt-in > opt-out.

Erőforrásnapló-kategóriák

A Communication Services a következő típusú naplókat kínálja, amelyeket engedélyezhet:

Használati naplók – az egyes számlázott szolgáltatásajánlatokhoz társított használati adatokat biztosítja
SMS működési naplók – az SMS szolgáltatással kapcsolatos alapvető információkat nyújt

Használati naplók sémája

Tulajdonság	Leírás
`Timestamp`	A napló létrehozásának időbélyege (UTC).
`Operation Name`	A naplórekordhoz társított művelet.
`Operation Version`	A `api-version` művelethez társított művelet, ha a műveletnév API-val lett végrehajtva. Ha nincs a műveletnek megfelelő API, a verzió a művelet verzióját jelöli, ha a művelethez társított tulajdonságok a jövőben megváltoznak.
`Category`	Az esemény naplókategóriája. A kategória az a részletesség, amely lehetővé teszi vagy letilthatja a naplókat egy adott erőforráson. Az esemény tulajdonságok blobjában megjelenő tulajdonságok megegyeznek egy adott naplókategórián és erőforrástípuson belül.
`Correlation ID`	A korrelált események azonosítója. Több tábla közötti korrelált események azonosítására használható.
`Properties`	A kommunikációs szolgáltatások különböző módjaira vonatkozó egyéb adatok.
`Record ID`	Egy adott használati rekord egyedi azonosítója.
`Usage Type`	A használati mód. (például Csevegés, PSTN, NAT stb.)
`Unit Type`	Az egység típusa, amelyet a használat egy adott használati módhoz ki van kapcsolva. (például percek, megabájtok, üzenetek stb.).
`Quantity`	A rekordhoz használt vagy felhasznált egységek száma.

SMS működési naplók

Tulajdonság	Leírás
`TimeGenerated`	A napló létrehozásának időbélyege (UTC).
`OperationName`	A naplórekordhoz társított művelet.
`CorrelationID`	A korrelált események azonosítója. Több tábla közötti korrelált események azonosítására használható.
`OperationVersion`	A művelethez társított API-verzió, ha az operationName api-val történt. Ha nincs a műveletnek megfelelő API, a verzió a művelet verzióját jelöli, ha a művelethez társított tulajdonságok a jövőben megváltoznak.
`Category`	Az esemény naplókategóriája. A kategória az a részletesség, amely lehetővé teszi vagy letilthatja a naplókat egy adott erőforráson. Az esemény tulajdonságok blobjában megjelenő tulajdonságok megegyeznek egy adott naplókategórián és erőforrástípuson belül.
`ResultType`	A művelet állapota.
`ResultSignature`	A művelet alállapota. Ha ez a művelet egy REST API-hívásnak felel meg, ez a mező a megfelelő REST-hívás HTTP-állapotkódja.
`ResultDescription`	A művelet statikus szöveges leírása.
`DurationMs`	A művelet időtartama ezredmásodpercben.
`CallerIpAddress`	A hívó IP-címe, ha a művelet egy olyan API-hívásnak felel meg, amely egy nyilvánosan elérhető IP-címmel rendelkező entitásból származna.
`Level`	Az esemény súlyossági szintje.
`URI`	A kérelem URI-ja.
`OutgoingMessageLength`	A kimenő üzenetben szereplő karakterek száma.
`IncomingMessageLength`	A bejövő üzenetben szereplő karakterek száma.
`DeliveryAttempts`	Az üzenet kézbesítésére tett kísérletek száma.
`PhoneNumber`	Az SMS-üzenetet küldő telefonszám.
`SdkType`	A kérelemben használt SDK-típus.
`PlatformType`	A kérelemben használt platformtípus.
`Method`	A kérelemben használt módszer.
`NumberType`	A szám típusa, az SMS-üzenet küldése folyamatban van. Lehet LongCodeNumber vagy ShortCodeNumber vagy DynamicAlphaSenderID
`MessageID`	Az összes kimenő és bejövő üzenethez létrehozott egyedi messageId azonosítót jelöli. Ez az SMS API válaszobjektumában található
`Country`	Azokat az országokat/régiókat jelöli, amelyekbe az SMS-üzeneteket küldték vagy fogadták

Példa SMS-ben küldött naplóra


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

Példa SMS-kézbesítési jelentésnaplóra


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

Példa SMS-ben kapott naplóra


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

(lásd még :GYIK).

Megosztás a következőn keresztül: