Skip to content

Commit 91d78a2

Browse files
Update call-automation-logs.md to add Adding Streaming Usage logs
Adding Real-time streaming usage information log category and table definition to wiki.
1 parent f5fabf6 commit 91d78a2

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

articles/communication-services/concepts/analytics/logs/call-automation-logs.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ Azure Communication Services provides monitoring and analytics features via [Azu
3030
3131
The following instructions configure your Azure Monitor resource to start creating logs and metrics for your Communication Services instance. For detailed documentation about using diagnostic settings across all Azure resources, see [Enable logging in diagnostic settings](../enable-logging.md).
3232

33-
Under the diagnostic setting name, select **Operation Call Automation Logs** and **Call Automation Events Summary Logs** to enable the logs for Call Automation.
33+
Under the diagnostic setting name, select the following to enable the logs for Call Automation:
34+
* **Operation Call Automation Logs**
35+
* **Call Automation Events Summary Logs**
36+
* **Call Automation Media Streaming features usage information Logs**
3437

3538
:::image type="content" source="..\media\log-analytics\call-automation-log.png" alt-text="Screenshot of diagnostic settings for Call Automation.":::
3639

@@ -41,6 +44,7 @@ Communication Services offers the following types of logs that you can enable:
4144
* **Usage logs**: Provide usage data associated with each billed service offering.
4245
* **Call automation operational logs**: Provide operational information on Call Automation API requests. You can use these logs to identify failure points and query all requests made in a call (by using the correlation ID or server call ID).
4346
* **Call Automation media summary logs**: Provide information about the outcome of media operations. These logs come to you asynchronously when you're making media requests by using Call Automation APIs. You can use these logs to help identify failure points and possible patterns on how users interact with your application.
47+
* **Call Automation Media Streaming features usage information Logs**: Provide usage information about real-time streaming features such as Media Streaming and Transcription. These logs come to you asynchronously when any real-time streaming has stopped or completed. You can use these logs to help identify calls with real-time streaming enabled, participants being streamed in unmixed streaming cases, streaming start-times, durations and possible streaming trends being used in your application.
4448

4549
## Usage log schema
4650

@@ -148,6 +152,36 @@ Here's an example of a Call Automation media summary log:
148152

149153
````
150154

155+
## Call Automation Media Streaming features usage information Logs
156+
157+
| Property | Description |
158+
| -------- | ---------------|
159+
| `TimeGenerated` | The time stamp (UTC) of the event.|
160+
| `CorrelationId` | Identify correlated requests made by using Call Automation. |
161+
| `CallConnectionId` | The ID that represents the call connection, if available. This ID is different for each participant and is used to identify their connection to the call. |
162+
| `StreamingModality` | The type of real-time streaming (eg. AudioStreamingUnmixed, AudioStreamingMixed, Transcription) that this event represents. |
163+
| `StreamingStartTime` | The time stamp (UTC) at which the real-time streaming session started. |
164+
| `StreamingDurationInMs` | The duration of the real-time streaming session in milliseconds. |
165+
| `StreamingSessionId` | Unique identifier for each real-time streaming session which is defined as the time between the start and end of a single modality of real-time streaming in any given call. |
166+
| `ParticipantId` | Unique identifier for each participant who was present in the streaming session identified by `StreamingSessionId` whose streaming started at `StreamingStartTime` and lasted a duration of `StreamingDurationInMs`. This only applies to the `StreamingModality` AudioStreamingUnmixed and Transcription where each participant is represented with their own record in this table. |
167+
168+
Here's an example of a Call Automation Media Streaming features usage information Logs:
169+
170+
```json
171+
[
172+
{
173+
"TimeGenerated [UTC]": "5/24/2023, 7:57:40.480 PM",
174+
"CorrelationId": "bbbb1111-cc22-3333-44dd-555555eeeeee",
175+
"CallConnectionId": "401f3500-fcb6-4b84-927e-81cd6372560b",
176+
"StreamingModality": "AudioStreamingUnmixed",
177+
"StreamingStartTime [UTC]": "5/24/2023, 7:57:45.480 PM",
178+
"StreamingDurationInMs": "1172487.9394",
179+
"StreamingSessionId": "8dc674eb-0313-46e1-8326-326ea71c7a45",
180+
"ParticipantId": "7a5ae46f-efb0-4abb-bc9f-c1f1ccfd1470"
181+
}
182+
183+
````
184+
151185
## Next steps
152186

153187
- Learn about the [insights dashboard to monitor Call Automation logs and metrics](/azure/communication-services/concepts/analytics/insights/call-automation-insights).

0 commit comments

Comments
 (0)