Skip to content

Commit 3a9ab94

Browse files
committed
Update call-metrics-log-schema.md
1 parent b0bc68e commit 3a9ab94

File tree

1 file changed

+67
-11
lines changed

1 file changed

+67
-11
lines changed

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

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,78 @@ Call Metrics logs contain aggregated calling metrics in daily bins based on attr
2323

2424
## Data Concepts
2525

26-
27-
a separate page that explains "metrics" conceptually
28-
what is metric - Based on thresholds defined in ACSCallingMetrics.Goal how many distinct api calls succeded or failed in a daily bucket for dimentions liek SDK version, make model, subcode etc
29-
what does it measure - Failure and success count for a particualr api call or a complex condition like UFD recovering (count of good UFD>= count of bad UFD)
30-
what is success/what is failure
31-
explain failures - high level - that somebody should review subcodes and go to subcode page etc..
32-
failure - an api call failing with unexpected error or a complex condition failing like getting a bd UFD in a call.
33-
34-
To learn more about UFDs please see: [User Facing Diagnostics](../../voice-video-calling/user-facing-diagnostics.md)
35-
36-
3726
> [!IMPORTANT]
3827
>You must collect logs if you want to analyze them. To learn more see: **[How do I store logs?](#how-do-i-store-logs)**
3928
>
4029
>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.
4130
31+
## Public Facing Metrics Definitions
32+
33+
### API Metrics
34+
35+
These metrics measure both the successes and failures (dcount) of our public APIs (e.g., mute, join, etc.).
36+
37+
- reliability/api/CreateView/Local
38+
- reliability/api/Join
39+
- reliability/api/StartVideo
40+
- reliability/api/AcceptIncomingCall
41+
- reliability/api/CreateView/Remote
42+
- reliability/api/StopVideo
43+
- reliability/api/CallAgentInit
44+
- reliability/api/StartCall
45+
46+
### User Facing Diagnostics (UFD) Metrics
47+
48+
- To learn more about UFDs please see: [User Facing Diagnostics](../../voice-video-calling/user-facing-diagnostics.md)
49+
50+
#### User Facing Diagnostics (UFD) Metrics (dcount of participants (legs) that had at least one bad UFD)
51+
52+
- reliability/leg/UFD/NetworkReconnect
53+
- reliability/leg/UFD/CameraStoppedUnexpectedly
54+
- reliability/leg/UFD/MicrophoneMuteUnexpectedly
55+
- reliability/leg/UFD/NetworkReceiveQuality
56+
- reliability/leg/UFD/MicrophonePermissionDenied
57+
- reliability/leg/UFD/MicrophoneNotFunctioning
58+
- reliability/leg/UFD/NoMicrophoneDevicesEnumerated
59+
- reliability/leg/UFD/CameraPermissionDenied
60+
- reliability/leg/UFD/CameraStartFailed
61+
- reliability/leg/UFD/CapturerStoppedUnexpectedly
62+
- reliability/leg/UFD/CapturerStartFailed
63+
- reliability/leg/UFD/CameraStartTimedOut
64+
- reliability/leg/UFD/NoSpeakerDevicesEnumerated
65+
- reliability/leg/UFD/CameraFreeze
66+
- reliability/leg/UFD/CameraStartFailed *(Note: appears twice)*
67+
- reliability/leg/UFD/NetworkRelaysNotReachable
68+
- reliability/leg/UFD/SpeakingWhileMicrophoneIsMuted
69+
- reliability/leg/UFD/NoNetwork
70+
- reliability/leg/UFD/NetworkSendQuality
71+
- reliability/leg/UFD/ScreenshareRecordingDisabled
72+
73+
#### User Facing Diagnostics (UFD) Metrics (dcount of occurrences that had an issue but subsequently recovered
74+
*(i.e., count of good UFD ≥ count of bad UFD)*):
75+
76+
- reliability/api/UFD/recovery/NetworkReceiveQuality
77+
- reliability/api/UFD/recovery/NetworkReconnect
78+
- reliability/api/UFD/recovery/CameraStoppedUnexpectedly
79+
- reliability/api/UFD/recovery/NetworkSendQuality
80+
- reliability/api/UFD/recovery/MicrophoneMuteUnexpectedly
81+
- reliability/api/UFD/recovery/MicrophoneNotFunctioning
82+
- reliability/api/UFD/recovery/CapturerStoppedUnexpectedly
83+
- reliability/api/UFD/recovery/CameraFreeze
84+
- reliability/api/UFD/recovery/CameraStartFailed
85+
- reliability/api/UFD/recovery/NoMicrophoneDevicesEnumerated
86+
- reliability/api/UFD/recovery/MicrophonePermissionDenied
87+
- reliability/api/UFD/recovery/CameraPermissionDenied
88+
- reliability/api/UFD/recovery/NoSpeakerDevicesEnumerated
89+
- reliability/api/UFD/recovery/CapturerStartFailed
90+
- reliability/api/UFD/recovery/ScreenshareRecordingDisabled
91+
- reliability/api/UFD/recovery/NoNetwork
92+
- reliability/api/UFD/recovery/CameraStartTimedOut
93+
- reliability/api/UFD/recovery/SpeakingWhileMicrophoneIsMuted
94+
- reliability/api/UFD/recovery/CameraStartFailed *(Note: appears twice)*
95+
- reliability/api/UFD/recovery/NetworkRelaysNotReachable
96+
97+
4298
## Data Definitions
4399

44100
### Call metrics log schema

0 commit comments

Comments
 (0)