Share via

Azure Communication Services SMS のログ

  • [アーティクル]

Azure Communication Services には、Communication Services ソリューションの監視とデバッグに使用できるログ機能が用意されています。 これらの機能は、Azure portal で構成することができます。

重要

以下では、Azure Monitor を使用して有効化するログについて言及しています (「FAQ」も参照)。 Communications Services 用にこれらのログを有効化する方法については、診断設定でのログの有効化に関するページを参照してください。

前提条件

Azure Communication Services では、Azure Monitor ログと Azure Monitor メトリックを介して、監視と分析の機能を提供しています。 各 Azure リソースには、次の条件を定義する独自の診断設定が必要です。

  • 設定で定義されている送信先に送信されるログとメトリック データのカテゴリ。 使用できるカテゴリは、リソースの種類によって異なります。
  • ログを送信する 1 つ以上の送信先。 現在の送信先には、Log Analytics ワークスペース、Event Hubs、Azure Storage が含まれます。
  • 1 つの診断設定では、各宛先を 1 つだけ定義することができます。 特定の種類の複数の送信先 (たとえば、2 つの異なる Log Analytics ワークスペース) にデータを送信する場合は、複数の設定を作成します。 各リソースには、最大 5 つの診断設定を作成できます。

Azure Monitor リソースを構成して、Communications Services のログとメトリックの作成を開始する手順について以下で説明します。 すべての Azure リソースで診断設定を使用する方法の詳細については、「診断設定のログ記録の有効化」を参照してください

Note

診断設定名の下の [SMS 操作] を選択して SMS のログを有効にしてください。

概要

SMS 操作ログは、SMS API 要求に関する分析情報を提供するイベントとアクティビティの記録です。 これらでは、SMS プリミティブのパフォーマンスと機能に関する詳細 (正常に配信されたか、ブロックされたか、送信に失敗したかに関するメッセージの状態に関する詳細を含む) をキャプチャします。 SMS 操作ログには、傾向とパターンを特定し、メッセージの配信の失敗や配信の問題など、パフォーマンスに影響を与える可能性がある問題を解決するのに役立つ情報が含まれています。 ログには、次の詳細が含まれます。

  • 送信されたメッセージ。
  • 受信したメッセージ。
  • 配信されたメッセージ。
  • メッセージのオプトインとオプトアウト。

リソース ログのカテゴリ

Communication Services には、有効にできる次のログが用意されています。

  • 利用状況ログ - 課金の対象となる各サービス内容に関連付けられた利用状況データを提供します。
  • SMS 操作ログ - SMS サービスに関連した基本的な情報を提供します。

利用状況ログのスキーマ

プロパティ 説明
Timestamp ログが生成された時刻のタイムスタンプ (UTC)。
Operation Name ログ レコードに関連付けられている操作。
Operation Version API を使用して operationName が実行された場合は、操作に関連付けられている api-version。 この操作に対応する API がない場合、その操作に関連付けられているプロパティが今後変更される場合に備えて、バージョンはその操作のバージョンを表します。
Category イベントのログ カテゴリ。 カテゴリは細分化されており、これを使用して、特定のリソースのログを有効または無効にすることができます。 イベントのプロパティ BLOB 内に表示されるプロパティは、特定のログ カテゴリとリソースの種類内のものと同じです。
Correlation ID 相関性があるイベントの ID。 複数のテーブル間で相関性のあるイベントを特定する際に使用できます。
Properties Communication Services の各種モードに該当するその他のデータ。
Record ID 特定の利用状況レコードの一意の ID。
Usage Type 使用モード (チャット、PSTN、NAT など)。
Unit Type 特定の使用モードに関する使用量の基準となる単位の種類 (分、メガバイト、メッセージ数など)。
Quantity そのレコードに関して使用または消費された単位の数。

SMS 操作ログ

プロパティ 説明
TimeGenerated ログが生成された時刻のタイムスタンプ (UTC)。
OperationName ログ レコードに関連付けられている操作。
CorrelationID 相関性があるイベントの ID。 複数のテーブル間で相関性のあるイベントを特定する際に使用できます。
OperationVersion operationName が API を使用して実行された場合は、操作に関連付けられている api-version。 この操作に対応する API がない場合、その操作に関連付けられているプロパティが将来変更された場合に備えて、バージョンはその操作のバージョンを表します。
Category イベントのログ カテゴリ。 カテゴリは細分化されており、これを使用して、特定のリソースのログを有効または無効にすることができます。 イベントのプロパティ BLOB 内に表示されるプロパティは、特定のログ カテゴリとリソースの種類内のものと同じです。
ResultType 操作の状態。
ResultSignature 操作の副状態。 この操作が REST API 呼び出しに対応している場合、このフィールドは、対応する REST 呼び出しの HTTP 状態コードです。
ResultDescription この操作を説明する静的テキスト。
DurationMs 操作時間 (ミリ秒)。
CallerIpAddress 操作が、一般的に利用できる IP アドレスを持つエンティティからの API 呼び出しに対応している場合は、呼び出し元 IP アドレス。
Level イベントの重大度レベル。
URI 要求の URI。
OutgoingMessageLength 送信メッセージに含まれる文字数。
IncomingMessageLength 受信メッセージに含まれる文字数。
DeliveryAttempts このメッセージの配信試行回数。
PhoneNumber 携帯ショートメール (SMS) メッセージの送信元である電話番号。
SdkType 要求で使用された SDK の種類。
PlatformType 要求で使用されたプラットフォームの種類。
Method 要求で使用されたメソッド。
NumberType 携帯ショートメール (SMS) メッセージの送信元である電話番号の型。 LongCodeNumber または ShortCodeNumber または DynamicAlphaSenderID のいずれかを指定できます。
MessageID すべての送信および受信メッセージに対して生成される一意の messageId を表します。 これは SMS API 応答オブジェクトにあります
Country SMS メッセージが送信されたまたは受信された国/地域を表します

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

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

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

(よく寄せられる質問に関するページも参照してください)。