Skip to content

Commit c350718

Browse files
committed
update
1 parent fdc6010 commit c350718

8 files changed

+63
-37
lines changed

articles/communication-services/concepts/analytics/logs/call-client-media-statistics-log-schema.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,30 @@ data on the audio, video, and screen share media steams between
2121
participants with a default 10-seconds aggregation interval. The logs contain granular time series information about media stream type, direction, codec, and bitrate properties (for example, max, min, average).
2222

2323

24-
This log provides more detailed information than the Call Diagnostic log
24+
This log provides more detailed information than the Call Diagnostics log
2525
to understand the quality of media steams between participants. It can be used to
2626
visualize and investigate quality issues for your calls through Call
2727
Diagnostics for your Azure Communication Services Resource. [Learn more about Call Diagnostics](../../voice-video-calling/call-diagnostics.md)
2828

2929

30+
## Data Concepts
31+
3032
> [!IMPORTANT]
3133
>You must collect logs if you want to analyze them. To learn more see: **[How do I store logs?](#how-do-i-store-logs)**
3234
>
3335
>Azure doesn't store your call log data unless you enable these specific Diagnostic Settings. Your call data is not retroactively available. You accumulate data once you set up the Diagnostic Settings.
3436
35-
## Log structure
37+
## Data Definitions
38+
39+
### Call client metrics log schema
3640

3741
The table below describes each property.
3842

3943

4044
| Property | Description |
4145
|--- |--- |
4246
| `OperationName` | The operation associated with the log record. |
43-
| `CallId` | The unique ID for a call. It identifies correlated events from all of the participants and endpoints that connect during a single call, and you can use it to join data from different logs. It's similar to the correlationId in call summary log and call diagnostic log. |
47+
| `CallId` | The unique ID for a call. It identifies correlated events from all of the participants and endpoints that connect during a single call, and you can use it to join data from different logs. It's similar to the correlationId in call summary log and call diagnostics log. |
4448
| `CallClientTimeStamp` | The timestamp when the media stats is recorded. |
4549
| `MetricName` | The name of the media statistics, such as `Bitrate`, `JitterInMs`, `PacketsPerSecond`, and so on. |
4650
| `Count`| The number of data points sampled at a given timestamp. |

articles/communication-services/concepts/analytics/logs/call-client-operations-log-schema.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,21 @@ ms.subservice: calling
1414

1515
# Call Client Operations Log Schema
1616

17+
1718
The **call client operations** log provides client-side information about the calling endpoints and participants involved in a call. These logs are currently in preview and show client events that occurred in a call and which actions a customer takes during a call.
1819

1920
This log provides detailed information on actions taken during a call and can be used to visualize and investigate call issues by using Call Diagnostics for your Azure Communication Services Resource. [Learn more about Call Diagnostics](../../voice-video-calling/call-diagnostics.md)
2021

22+
## Data Concepts
23+
2124
> [!IMPORTANT]
2225
>You must collect logs if you want to analyze them. To learn more see: **[How do I store logs?](#how-do-i-store-logs)**
2326
>
2427
>Azure doesn't store your call log data unless you enable these specific Diagnostic Settings. Your call data is not retroactively available. You accumulate data once you set up the Diagnostic Settings.
2528
26-
## Log structure
29+
## Data Definitions
30+
31+
### Call client operations log schema
2732

2833
The table below describes each property.
2934

@@ -32,7 +37,7 @@ The table below describes each property.
3237
|--- |--- |
3338
| `CallClientTimeStamp` | The timestamp for when on operation occurred on the SDK in UTC. |
3439
| `OperationName` | The name of the operation triggered on the calling SDK. |
35-
| `CallId` | The unique ID for a call. It identifies correlated events from all of the participants and endpoints that connect during a single call, and you can use it to join data from different logs. It's similar to the correlationId in call summary log and call diagnostic log. |
40+
| `CallId` | The unique ID for a call. It identifies correlated events from all of the participants and endpoints that connect during a single call, and you can use it to join data from different logs. It's similar to the correlationId in call summary log and call diagnostics log. |
3641
| `ParticipantId` | The unique identifier for each call leg (in Group calls) or call participant (in Peer to Peer calls). This ID is the main correlation point between CallSummary, CallDiagnostic, CallClientOperations, and CallClientMediaStats logs. |
3742
| `OperationType` | Call Client Operation. |
3843
| `OperationId` | A unique GGUID identifying an SDK operation. |

articles/communication-services/concepts/analytics/logs/call-diagnostics-log-schema.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Azure Communication Services Call Diagnostic Log Schema
2+
title: Azure Communication Services Call Diagnostics Log Schema
33
titleSuffix: An Azure Communication Services concept article
4-
description: Learn about the Voice and Video Call Diagnostic Logs.
4+
description: Learn about the Voice and Video Call Diagnostics Logs.
55
author: amagginetti
66
services: azure-communication-services
77

@@ -12,20 +12,23 @@ ms.service: azure-communication-services
1212
ms.subservice: calling
1313
---
1414

15-
# Call Diagnostic Log Schema
15+
# Call Diagnostics Log Schema
1616

1717

18-
Call diagnostic logs provide important information about the endpoints and the media transfers for each participant. They also provide measurements that help you understand quality problems.
18+
Call diagnostics logs provide important information about the endpoints and the media transfers for each participant. They also provide measurements that help you understand quality problems.
1919

20-
For each endpoint within a call, a distinct call diagnostic log is created for outbound media streams (audio or video, for example) between endpoints. In a P2P call, each log contains data that relates to each of the outbound streams associated with each endpoint. In group calls, `participantId` serves as a key identifier to join the related outbound logs into a distinct participant connection. Call diagnostic logs remain intact and are the same regardless of the participant tenant.
20+
For each endpoint within a call, a distinct call diagnostics log is created for outbound media streams (audio or video, for example) between endpoints. In a P2P call, each log contains data that relates to each of the outbound streams associated with each endpoint. In group calls, `participantId` serves as a key identifier to join the related outbound logs into a distinct participant connection. Call diagnostics logs remain intact and are the same regardless of the participant tenant.
2121

22+
## Data Concepts
2223

2324
> [!IMPORTANT]
2425
>You must collect logs if you want to analyze them. To learn more see: **[How do I store logs?](#how-do-i-store-logs)**
2526
>
2627
>Azure doesn't store your call log data unless you enable these specific Diagnostic Settings. Your call data is not retroactively available. You accumulate data once you set up the Diagnostic Settings.
2728
28-
## Log structure
29+
## Data Definitions
30+
31+
### Call diagnostics log schema
2932

3033
The table below describes each property.
3134

@@ -77,17 +80,17 @@ Here are shared fields for all logs in a P2P call:
7780
"correlationId": "aaaa0000-bb11-2222-33cc-444444dddddd",
7881
```
7982

80-
#### Call diagnostic logs
83+
#### Call diagnostics logs
8184

82-
Call diagnostic logs share operation information:
85+
Call diagnostics logs share operation information:
8386

8487
```json
8588
"operationName": "CallDiagnostics",
8689
"operationVersion": "1.0",
8790
"category": "CallDiagnostics",
8891
```
8992

90-
Here's a diagnostic log for an audio stream from VoIP endpoint 1 to VoIP endpoint 2:
93+
Here's a diagnostics log for an audio stream from VoIP endpoint 1 to VoIP endpoint 2:
9194

9295
```json
9396
"properties": {
@@ -107,7 +110,7 @@ Here's a diagnostic log for an audio stream from VoIP endpoint 1 to VoIP endpoin
107110
}
108111
```
109112

110-
Here's a diagnostic log for an audio stream from VoIP endpoint 2 to VoIP endpoint 1:
113+
Here's a diagnostics log for an audio stream from VoIP endpoint 2 to VoIP endpoint 1:
111114

112115
```json
113116
"properties": {
@@ -127,7 +130,7 @@ Here's a diagnostic log for an audio stream from VoIP endpoint 2 to VoIP endpoin
127130
}
128131
```
129132

130-
Here's a diagnostic log for a video stream from VoIP endpoint 1 to VoIP endpoint 2:
133+
Here's a diagnostics log for a video stream from VoIP endpoint 1 to VoIP endpoint 2:
131134

132135
```json
133136
"properties": {
@@ -149,7 +152,7 @@ Here's a diagnostic log for a video stream from VoIP endpoint 1 to VoIP endpoint
149152

150153
### Group call
151154

152-
Data for a group call is generated in three call summary logs and six call diagnostic logs. Here are shared fields for all logs in the call:
155+
Data for a group call is generated in three call summary logs and six call diagnostics logs. Here are shared fields for all logs in the call:
153156

154157
```json
155158
"time": "2021-07-05T06:30:06.402Z",
@@ -159,17 +162,17 @@ Data for a group call is generated in three call summary logs and six call diagn
159162

160163

161164

162-
#### Call diagnostic logs
165+
#### Call diagnostics logs
163166

164-
Call diagnostic logs share operation information:
167+
Call diagnostics logs share operation information:
165168

166169
```json
167170
"operationName": "CallDiagnostics",
168171
"operationVersion": "1.0",
169172
"category": "CallDiagnostics",
170173
```
171174

172-
Here's a diagnostic log for an audio stream from VoIP endpoint 1 to a server endpoint:
175+
Here's a diagnostics log for an audio stream from VoIP endpoint 1 to a server endpoint:
173176

174177
```json
175178
"properties": {
@@ -189,7 +192,7 @@ Here's a diagnostic log for an audio stream from VoIP endpoint 1 to a server end
189192
}
190193
```
191194

192-
Here's a diagnostic log for an audio stream from a server endpoint to VoIP endpoint 1:
195+
Here's a diagnostics log for an audio stream from a server endpoint to VoIP endpoint 1:
193196

194197
```json
195198
"properties": {
@@ -209,7 +212,7 @@ Here's a diagnostic log for an audio stream from a server endpoint to VoIP endpo
209212
}
210213
```
211214

212-
Here's a diagnostic log for an audio stream from VoIP endpoint 3 to a server endpoint:
215+
Here's a diagnostics log for an audio stream from VoIP endpoint 3 to a server endpoint:
213216

214217
```json
215218
"properties": {
@@ -229,7 +232,7 @@ Here's a diagnostic log for an audio stream from VoIP endpoint 3 to a server end
229232
}
230233
```
231234

232-
Here's a diagnostic log for an audio stream from a server endpoint to VoIP endpoint 3:
235+
Here's a diagnostics log for an audio stream from a server endpoint to VoIP endpoint 3:
233236

234237
```json
235238
"properties": {

articles/communication-services/concepts/analytics/logs/call-metrics-log-schema.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,16 @@ ms.service: azure-communication-services
1212
ms.subservice: calling
1313
---
1414

15-
This document is intended as a reference for the ACSCallingMetrics logs. Use these logs to gain a clearer understanding of daily aggregated calling metrics across various dimensions for your communication workloads.
1615

1716
# Call Metrics Log Schema
1817

19-
This log contains aggregated calling metrics in daily bins based on attributes such as SDK Version, OS name, and Error Subcode. These logs are used in the **[Voice and video Insights Dashboard](../insights/voice-and-video-insights.md)** to visualize long term graphs of reliability, quality, and performance based on count of succeeded and failed Calling SDK api calls of various operations. You can also set up automated alerts when a metric falls. **ankesh please explain how to do alerts**
18+
This document explains the ACSCallingMetrics logs available to you through Azure Monitor in the form of [Resource Logs](/azure/azure-monitor/data-sources.md#azure-resources).
2019

21-
EXPLAIN METRICS CONCEPTUALLY
20+
Call Metrics logs are used in the **[Voice and video Insights Dashboard](../insights/voice-and-video-insights.md)** to visualize long term graphs of reliability, quality, and performance based on count of succeeded and failed Calling SDK api calls of various operations. Use these logs to gain a clearer understanding of daily aggregated calling metrics across various dimensions for your communication workloads. You can also set up automated alerts when a metric falls. **ankesh please explain how to do alerts**
21+
22+
Call Metrics logs contain aggregated calling metrics in daily bins based on attributes such as SDK Version, OS name, and Error Subcode.
23+
24+
## Data Concepts
2225

2326

2427

@@ -34,7 +37,9 @@ failure - an api call failing with unexpected error or a complex condition faili
3437
>
3538
>Azure doesn't store your call log data unless you enable these specific Diagnostic Settings. Your call data is not retroactively available. You accumulate data once you set up the Diagnostic Settings.
3639
37-
## Log structure
40+
## Data Definitions
41+
42+
### Call metrics log schema
3843

3944
The table below describes each property.
4045

articles/communication-services/concepts/analytics/logs/call-summary-log-schema.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,17 @@ ms.subservice: calling
1717
The call summary log contains data to help you identify key properties of all calls. A different call summary log is created for each `participantId` (or `endpointId` for peer-to-peer [P2P] calls) value in the call.
1818

1919

20+
## Data Concepts
21+
2022
> [!IMPORTANT]
2123
>You must collect logs if you want to analyze them. To learn more see: **[How do I store logs?](#how-do-i-store-logs)**
2224
>
2325
>Azure doesn't store your call log data unless you enable these specific Diagnostic Settings. Your call data is not retroactively available. You accumulate data once you set up the Diagnostic Settings.
2426
2527

26-
## Log Structure
28+
## Data Definitions
29+
30+
### Call summary log schema
2731

2832
> [!IMPORTANT]
2933
> Participant information in the call summary log varies based on the participant tenant. The SDK version and OS version are redacted if the participant is not within the same tenant (also called *cross-tenant*) as the Communication Services resource. Cross-tenant participants are classified as external users invited by a resource tenant to join and collaborate during a call.
@@ -172,7 +176,7 @@ Here's a call summary for a PSTN call:
172176
```
173177
### Group calls
174178

175-
Data for a group call is generated in three call summary logs and six call diagnostic logs. Here are shared fields for all logs in the call:
179+
Data for a group call is generated in three call summary logs and six call diagnostics logs. Here are shared fields for all logs in the call:
176180

177181
```json
178182
"time": "2021-07-05T06:30:06.402Z",

articles/communication-services/concepts/analytics/logs/end-of-call-survey-logs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ In addition to the above, the optional tags in the responses offer further insig
4949

5050
By analyzing the data captured in the End of Call Survey logs, you can pinpoint areas that require improvement, thereby enhancing the overall user experience.
5151

52+
5253
## Resource log categories
5354

5455
Communication Services offers the following types of logs that you can enable:

articles/communication-services/concepts/analytics/logs/usage-log-schema.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,16 @@ ms.subservice: calling
1515
# Usage Log Schema
1616
The usage log schema is used to.....
1717

18+
## Data Concepts
19+
1820
> [!IMPORTANT]
1921
>You must collect logs if you want to analyze them. To learn more see: **[How do I store logs?](#how-do-i-store-logs)**
2022
>
2123
>Azure doesn't store your call log data unless you enable these specific Diagnostic Settings. Your call data is not retroactively available. You accumulate data once you set up the Diagnostic Settings.
2224
23-
## Log structure
25+
## Data Definitions
26+
27+
### Usage log schema
2428

2529
The table below describes each property.
2630

0 commit comments

Comments
 (0)