Azure Communication Services Rooms のログ

[アーティクル]
11/08/2023

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

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

概要

Rooms 操作ログは、Rooms API 要求に関する分析情報を提供するイベントとアクティビティの記録です。各 Rooms 要求の状態や追加のプロパティなど、Rooms プリミティブのパフォーマンスと機能に関する詳細をキャプチャします。 Rooms の操作ログには、Rooms の使用状況の傾向とパターンを特定するのに役立つ情報が含まれています。

ログのカテゴリ

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

Rooms 操作ログ - Rooms サービスに関連した基本的な情報を提供します

Rooms 操作ログのスキーマ

プロパティ	説明
`Correlation ID`	要求を表す一意の ID です。
`Level`	イベントの重大度レベル。
`Operation Name`	ログレコードに関連付けられている操作。たとえば、CreateRoom、PatchRoom、GetRoom、ListRooms、DeleteRoom、GetParticipants、UpdateParticipants などです。
`Operation Version`	操作に関連付けられている API バージョン。
`ResultType`	操作の状態。
`ResultSignature`	操作の副状態。この操作が REST API 呼び出しに対応している場合、このフィールドは、対応する REST 呼び出しの HTTP 状態コードです。
.`RoomId`	Room の ID。
`RoomLifeSpan`	Room の有効期間 (分)。
`AddedRoomParticipantsCount`	Room に追加された参加者の数。
`UpsertedRoomParticipantsCount`	Room にアップサートされた参加者の数。
`RemovedRoomParticipantsCount`	Room から削除された参加者の数。
`TimeGenerated`	ログが生成された時刻のタイムスタンプ (UTC)。
`PstnDialOutEnabled`	Room で PSTN 通話を行って会議にユーザーを招待できるかどうかを示します。

CreateRoom ログの例

    [
      {
      "CorrelationId": "Y4x6ZabFE0+E8ERwMpd68w",
      "Level": "Informational",
      "OperationName": "CreateRoom",
      "OperationVersion": "2023-10-30-preview",
      "ResultType": "Succeeded",
      "ResultSignature": 201,
      "RoomId": "99466898241024408",
      "RoomLifespan": 61,
      "AddedRoomParticipantsCount": 4,
      "TimeGenerated": "5/25/2023, 4:32:49.469 AM",
      "PstnDialOutEnabled": false,
      }
    ]

GetRoom ログの例

    [
      {
      "CorrelationId": "CNiZIX7fvkumtBSpFq7fxg",
      "Level": "Informational",
      "OperationName": "GetRoom",
      "OperationVersion": "2023-10-30-preview",
      "ResultType": "Succeeded",
      "ResultSignature": "200",
      "RoomId": "99466387192310000",
      "RoomLifespan": 61,
      "TimeGenerated": "2022-08-19T17:07:30.2400300Z",
      },
    ]

UpdateRoom ログの例

    [
      {
      "CorrelationId": "Bwqzh0pdnkGPDwNcMnBkng",
      "Level": "Informational",
      "OperationName": "UpdateRoom",
      "OperationVersion": "2023-10-30-preview",
      "ResultType": "Succeeded",
      "ResultSignature": "200",
      "RoomId": "99466387192310000",
      "RoomLifespan": 121,
      "TimeGenerated": "2022-08-19T17:07:30.3543160Z",
      "PstnDialOutEnabled": false,
      },
    ]

DeleteRoom ログの例

    [
      {
      "CorrelationId": "x7rMXmihYEe3GFho9T/H2w",
      "Level": "Informational",
      "OperationName": "DeleteRoom",
      "OperationVersion": "2023-10-30-preview",
      "ResultType": "Succeeded",
      "ResultSignature": "204",
      "RoomId": "99466387192310000",
      "RoomLifespan": 121,
      "TimeGenerated": "2022-08-19T17:07:30.5393800Z",
      },
    ]

ListRooms ログの例

	[
	  {
	  "CorrelationId": "KibM39CaXkK+HTInfsiY2w",
	  "Level": "Informational",
	  "OperationName": "ListRooms",
	  "OperationVersion": "2023-10-30-preview",
	  "ResultType": "Succeeded",
	  "ResultSignature": "200",
	  "TimeGenerated": "2022-08-19T17:07:30.5393800Z",
	  },
	]

UpdateParticipants ログの例

    [
      {
      "CorrelationId": "zHT8snnUMkaXCRDFfjQDJw",
      "Level": "Informational",
      "OperationName": "UpdateParticipants",
      "OperationVersion": "2023-10-30-preview",
      "ResultType": "Succeeded",
      "ResultSignature": "200",
      "RoomId": "99466387192310000",
      "RoomLifespan": 121,
      "UpsertedRoomParticipantsCount": 5,
      "RemovedRoomParticipantsCount": 1,
      "TimeGenerated": "2023-04-14T17:07:30.5393800Z",
      },
    ]

(「よくあるご質問」も参照してください)。

次の方法で共有