Skip to content

Commit bd95278

Browse files
committed
Update call-metrics-log-schema.md
1 parent c6de66d commit bd95278

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,7 @@ ms.subservice: calling
1717

1818
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).
1919

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-
To learn how to setup automated alerts off of these logs please see: https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/tutorial-log-alert
23-
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.
2421
Call Metrics logs contain aggregated calling metrics in daily bins based on attributes such as SDK Version, OS name, and Error Subcode.
2522

2623
## Data Concepts
@@ -31,13 +28,17 @@ Call Metrics logs contain aggregated calling metrics in daily bins based on attr
3128
>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.
3229
3330

34-
In the log schema there is a property called `MetricName` that details the various metrics that are sent in this schema. The metrics are broken down into two main caetgoreies API Metrics and UFD metrics. UFD metrics are further broken down into two groups that explain the volume of UFD occurences how well they recovered during a call. categories which are detailed below.
31+
These metrics are visualized in the **[Voice and video Insights Dashboard](../insights/voice-and-video-insights.md)**, we recommend reviewing these visuals to understand how you can leverage these data if you want build your own dashboard or customize the existing dashboards. To understand how the visuals are generated in the Insights Dashboard you can edit the existing workbook to see the queries behind each visual.
3532

36-
## Public Facing Metrics Definitions
3733

38-
### API Metrics
34+
In the log schema there is a property called `MetricName` that details the various metrics that are sent in this schema. The metrics are broken down into two main caetgoreies, **API Metrics** and **User Facing Diagnostics (UFD) metrics**. UFD metrics are further broken down into two groups that explain the **volume** of UFD occurences and how well UFDs **recovered** from those occurences during calls.
35+
36+
Since these metrics give you an overview of your entire calling resource you can set up automated alerts if a metric falls. To learn how to set up automated alerts please see: [Tutorial: Create a log search alert for an Azure resource](/azure/azure-monitor/alerts/tutorial-log-alert)
3937

40-
- These UFDs are visualized in the Voice idiiddi insights dashboard in the UFD tab. To see how you can leverage these data learn more please seee: link to Inisghts page. To understand how the visuals are generated you can edit the existing workbook and see the queries behind the visuals.
38+
39+
## Metric categories
40+
41+
### API Metrics
4142

4243
These metrics measure both the successes and failures (dcount) of the calling SDK public APIs (e.g., mute, join, etc.).
4344

@@ -52,8 +53,6 @@ These metrics measure both the successes and failures (dcount) of the calling SD
5253

5354
### User Facing Diagnostics (UFD) Metrics
5455

55-
- These UFDs are visualized in the Voice idiiddi insights dashboard in the UFD tab. To see how you can leverage these data learn more please seee: link to Inisghts page. To understand how the visuals are generated you can edit the existing workbook and see the queries behind the visuals.
56-
5756
- To learn more about UFDs please see: [User Facing Diagnostics](../../voice-video-calling/user-facing-diagnostics.md)
5857

5958
#### User Facing Diagnostics (UFD) leg metrics: (dcount of participants (legs) that had at least one bad UFD during a call)
@@ -82,7 +81,7 @@ Provides counts of how many participant were impacted by a UFD in a call.
8281

8382
#### User Facing Diagnostics (UFD) API recovery metrics: (dcount of occurrences that had an issue but subsequently recovered during a call)
8483

85-
Provides counts of how many UFDs were triggered during a call by the calling SDK, but subsequently recovered during the call. For example, the network reconnect UFD was triggered one time in a call, but the network succesfully recovered during the call. Therefore the count of good UFD is ≥ the count of bad UFDs in the call. Then the recovery rate of that UFD would be 100%.
84+
Provides counts of how many UFDs were triggered during a call by the calling SDK, but subsequently recovered during the call. For example, if the `NetworkReconnect` UFD was triggered one time in a call, but the network succesfully recovered during the call. In this example the count of good API recovery UFD is ≥ the count of bad UFD leg metric. You could calculate a UFD recovery rate of 100%.
8685

8786

8887
- reliability/api/UFD/recovery/NetworkReceiveQuality

0 commit comments

Comments
 (0)