Skip to content

Commit bc9abe8

Browse files
Merge pull request #274730 from amagginetti/patch-15
Update voice-and-video-logs.md
2 parents fa864b7 + 0cda87c commit bc9abe8

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

articles/communication-services/concepts/analytics/logs/voice-and-video-logs.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,8 @@ This log provides detailed information on actions taken during a call and can be
147147
| `EndpointId` | The unique ID that represents each endpoint connected to the call, where endpointType defines the endpoint type. When the value is null, the connected entity is the Communication Services server (endpointType = "Server"). <BR><BR> The endpointId value can sometimes persist for the same user across multiple calls (correlationId) for native clients. The number of endpointId values determines the number of call summary logs. A distinct summary log is created for each endpointId value. |
148148
| `OperationPayload` | A dynamic payload that varies based on the operation providing more operation specific details. |
149149

150-
<!-- ### Call client media stats time series log schema
150+
151+
### Call client media stats time series log schema
151152
[!INCLUDE [Public Preview Disclaimer](../../../includes/public-preview-include-document.md)]
152153

153154
The **call client media statistics time series** log provides
@@ -185,7 +186,7 @@ Diagnostics for your Azure Communication Services Resource. [Learn more about Ca
185186
| `RemoteParticipantId` | The unique ID that represents the remote endpoint in the media stream. For example, a user can render multiple video streams for the other users in the same call. Each video stream has a different RemoteParticipantId. |
186187
| `RemoteEndpointId` | Same as EndpointId, but it represents the user on the remote side of the stream. |
187188
| `MediaStreamId` | A unique ID that represents each media stream in the call. MediaStreamId is not currently instrumented in clients. When implemented, it will match the streamId column in CallDiagnostics logs. |
188-
| `AggregationIntervalSeconds` | The time interval for aggregating the media statistics. Currently in calling SDK, the media metrics are sampled every 1 second, and when we report in the log we aggregate all samples every 10 seconds. So each row in this table at most have 10 sampling points. -->
189+
| `AggregationIntervalSeconds` | The time interval for aggregating the media statistics. Currently in calling SDK, the media metrics are sampled every 1 second, and when we report in the log we aggregate all samples every 10 seconds. So each row in this table at most have 10 sampling points.
189190

190191

191192

@@ -214,15 +215,15 @@ Azure Communication Services creates four types of logs:
214215

215216
- **Call client operations logs**: Contain detailed call client events. These log events are generated for each `EndpointId` in a call and the number of event logs generated will depend on the operations the participant performed during the call.
216217

217-
<!-- - **Call client media statistics logs**: Contain detailed media stream values. These logs are generated for each media stream in a call. For each `EndpointId` within a call (including the server), Azure Communication Services creates a distinct log for each media stream (audio or video, for example) between endpoints. The volume of data generated in each log depends on the duration of call and number of media steams in the call.
218+
- **Call client media statistics logs**: Contain detailed media stream values. These logs are generated for each media stream in a call. For each `EndpointId` within a call (including the server), Azure Communication Services creates a distinct log for each media stream (audio or video, for example) between endpoints. The volume of data generated in each log depends on the duration of call and number of media steams in the call.
218219

219-
In a P2P call, each log contains data that relates to each of the outbound streams associated with each endpoint. In a group call, each stream associated with `endpointType` = `"Server"` creates a log that contains data for the inbound streams. All other streams create logs that contain data for the outbound streams for all non-server endpoints. In group calls, use the `participantId` value as the key to join the related inbound and outbound logs into a distinct participant connection. -->
220+
In a P2P call, each log contains data that relates to each of the outbound streams associated with each endpoint. In a group call, each stream associated with `endpointType` = `"Server"` creates a log that contains data for the inbound streams. All other streams create logs that contain data for the outbound streams for all non-server endpoints. In group calls, use the `participantId` value as the key to join the related inbound and outbound logs into a distinct participant connection.
220221

221222
### Example: P2P call
222223

223224
The following diagram represents two endpoints connected directly in a P2P call. In this example, Communication Services creates two call summary logs (one for each `participantID` value) and four call diagnostic logs (one for each media stream).
224225

225-
<!-- For Azure Communication Services (ACS) call client participants there will also be a series of call client operations logs and call client media stats time series logs. The exact number of these logs depend on what kind of SDK operations are called and how long the call is. -->
226+
For Azure Communication Services (ACS) call client participants there will also be a series of call client operations logs and call client media stats time series logs. The exact number of these logs depend on what kind of SDK operations are called and how long the call is.
226227

227228
:::image type="content" source="../media/call-logs-azure-monitor/example-1-p2p-call-same-tenant.png" alt-text="Diagram that shows a P2P call within the same tenant.":::
228229

@@ -232,7 +233,7 @@ The following diagram represents a group call example with three `participantId`
232233

233234
For Azure Communication Services (ACS) call client participants the call client operations logs are the same as P2P calls. For each participant using calling SDK, there will be a series of call client operations logs.
234235

235-
<!-- For Azure Communication Services (ACS) call client participants the call client operations logs and call client media statistics time series logs are the same as P2P calls. For each participant using calling SDK, there will be a series of call client operations logs and call client media statistics time series logs. -->
236+
For Azure Communication Services (ACS) call client participants the call client operations logs and call client media statistics time series logs are the same as P2P calls. For each participant using calling SDK, there will be a series of call client operations logs and call client media statistics time series logs.
236237

237238
:::image type="content" source="../media/call-logs-azure-monitor/example-2-group-call-same-tenant.png" alt-text="Diagram that shows a group call within the same tenant.":::
238239

@@ -638,14 +639,10 @@ Here's a diagnostic log for an audio stream from a server endpoint to VoIP endpo
638639
"jitterMax": "4",
639640
"packetLossRateAvg": "0",
640641
```
641-
### Call client operations logs for P2P and group calls
642-
643-
For call client operations log, there is no difference between P2P and group call scenarios and the number of logs depends on the SDK operations and call duration. The following provide some generic samples that show the schema of these logs.
644-
645642

646-
<!-- ### Call client operations log and call client media statistics logs for P2P and group calls
643+
### Call client operations log and call client media statistics logs for P2P and group calls
647644

648-
For call client operations log and call client media stats time series log, there is no difference between P2P and group call scenarios and the number of logs depends on the SDK operations and call duration. The following provide some generic samples that show the schema of these logs. -->
645+
For call client operations log and call client media stats time series log, there is no difference between P2P and group call scenarios and the number of logs depends on the SDK operations and call duration. The following provide some generic samples that show the schema of these logs.
649646

650647
#### Call client operations log
651648

@@ -675,7 +672,7 @@ Each participant can have many different metrics for a call. The following query
675672

676673
`ACSCallClientOperations | distinct OperationName`
677674

678-
<!-- #### Call client media statistics time series log
675+
#### Call client media statistics time series log
679676

680677
The following is an example of media statistics time series log. It shows the participant's Jitter metric for receiving an audio stream at a specific timestamp.
681678

@@ -704,7 +701,7 @@ The following is an example of media statistics time series log. It shows the pa
704701

705702
Each participant can have many different media statistics metrics for a call. The following query can be run in Log Analytics in Azure Portal to show all possible metrics in this log:
706703

707-
`ACSCallClientMediaStatsTimeSeries | distinct MetricName` -->
704+
`ACSCallClientMediaStatsTimeSeries | distinct MetricName`
708705

709706
### Error codes
710707

@@ -718,4 +715,4 @@ The `participantEndReason` property contains a value from the set of Calling SDK
718715

719716

720717
- Learn how to use call logs to diagnose call quality and reliability
721-
issues with Call Diagnostics, see: [Call Diagnostics](../../voice-video-calling/call-diagnostics.md)
718+
issues with Call Diagnostics, see: [Call Diagnostics](../../voice-video-calling/call-diagnostics.md)

0 commit comments

Comments
 (0)