Skip to content

Commit 38f2ae8

Browse files
committed
edit pass: quality-and-diagnostics
1 parent 4befce6 commit 38f2ae8

File tree

6 files changed

+21
-22
lines changed

6 files changed

+21
-22
lines changed

articles/communication-services/concepts/includes/best-practices-native.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ You should track the `CallID` value in the telemetry that you configure in your
8686

8787
### Subscribe to User Facing Diagnostics and media quality statistics
8888

89-
You can use these features of Azure Communication Services help improve the user experience:
89+
You can use these features of Azure Communication Services to help improve the user experience:
9090

9191
- [User Facing Diagnostics](../voice-video-calling/user-facing-diagnostics.md): Examine various properties of a call to determine the cause of problems that affect your customers.
9292
- [Media quality statistics](../voice-video-calling/media-quality-sdk.md): Examine the low-level audio, video, and screen-sharing quality metrics for incoming and outgoing call metrics. We recommend that you collect the data and send it to your pipeline ingestion after a call ends.

articles/communication-services/concepts/telephony/troubleshooting-pstn-call-failures.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.topic: troubleshooting
1212
---
1313
# Troubleshoot Azure Communication Services PSTN call failures
1414

15-
When you're troubleshooting Azure Communication Services PSTN call failures, we recommended that you [enable logging](../analytics/enable-logging.md). Then you can use `ResultCategories`, `ParticipantEndReason`, and `ParticipantEndSubCode` values to determine why an individual call ended and whether the system detected any failures.
15+
When you're troubleshooting Azure Communication Services PSTN call failures, we recommend that you [enable logging](../analytics/enable-logging.md). Then you can use `ResultCategories`, `ParticipantEndReason`, and `ParticipantEndSubCode` values to determine why an individual call ended and whether the system detected any failures.
1616

1717
## Use ResultCategories to troubleshoot failures
1818

@@ -41,7 +41,7 @@ This code is based on Session Initiation Protocol (SIP) response codes. For more
4141

4242
A key factor in troubleshooting Azure Communication Services PSTN calls is determining whether the final SIP response code for the call came from a Microsoft process or the user's/operator's session border controller (SBC). An easy way to determine where the code originated is to look at the `ParticipantEndSubCode` response.
4343

44-
If the `ParticipantEndSubCode` value starts with `560`, it indicates that the user's/operator's SBC generated the response code. In that case, you should check your SBC configuration.
44+
If the `ParticipantEndSubCode` value starts with `560`, it indicates that the user's/operator's SBC generated the response code. In that case, you should check the SBC configuration.
4545

4646
For example, if the `ParticipantEndSubCode` value is `560403`, it means that the SBC generated the final response code, and the code is `403`. In that case, you should start troubleshooting the calls by using the SBC logs.
4747

articles/communication-services/concepts/voice-video-calling/call-diagnostics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ After you select a call, its details appear on the **Overview** tab. This tab sh
5959

6060
The **Issues** tab gives you a high-level analysis of any media quality and reliability problems that Call Diagnostics detected during the call.
6161

62-
This tab highlights detected problems commonly known to affect user's call quality, such as poor network conditions, speaking while muted, or device failures during a call. If you want to explore a detected problem, select the highlighted item. A prepopulated view of the related events appears on the **Timeline** tab.
62+
This tab highlights detected problems commonly known to affect a user's call quality, such as poor network conditions, speaking while muted, or device failures. If you want to explore a detected problem, select the highlighted item. A prepopulated view of the related events appears on the **Timeline** tab.
6363

6464
![Screenshot of the Call Diagnostics Issues tab that shows the top problems detected in a selected call.](media/call-diagnostics-call-issues-2.png)
6565

@@ -69,7 +69,7 @@ When call problems are difficult to troubleshoot, you can explore the **Timeline
6969

7070
The timeline view is complex. It's designed for developers who need to explore details of a call and interpret detailed debugging data. In large calls, the timeline view can present an overwhelming amount of information. We recommend that you use filtering to narrow your search results and reduce complexity.
7171

72-
You can view detailed call logs for each participant within a call. Call information might not be present for various reasons, such as privacy constraints between different calling resources.
72+
You can view detailed call logs for each participant within a call. Call information might not be present for various reasons, such as privacy constraints between calling resources.
7373

7474
![Screenshot of the Call Diagnostics Timeline tab that shows detailed events in a timeline view for a selected call.](media/call-diagnostics-call-timeline-2.png)
7575

@@ -79,7 +79,7 @@ AI can help app developers across every step of the development lifecycle: desig
7979

8080
- How do I run network diagnostics in Azure Communication Services VoIP calls?
8181
- How can I optimize my calls for poor network conditions?
82-
- What are the common causes of poor media streams in Azure Communication calls?
82+
- What are the common causes of poor media streams in Azure Communication Services calls?
8383
- The video on my call didn't work. How do I fix the subcode 41048?
8484

8585
![Screenshot of a Call Diagnostics search that shows recent calls for an Azure Communications Services resource and a response from Copilot in Azure.](media/call-diagnostics-all-calls-copilot.png)
@@ -90,7 +90,7 @@ AI can help app developers across every step of the development lifecycle: desig
9090

9191
Follow instructions to add diagnostic settings for your resource in [Enable logs via Diagnostic Settings in Azure Monitor](../analytics/enable-logging.md). We recommend that you initially collect all logs. After you understand the capabilities in Azure Monitor, determine which logs you want to retain and for how long. When you add your diagnostic setting, you're prompted to [select logs](../analytics/enable-logging.md#adding-a-diagnostic-setting). To collect all logs, select **allLogs**.
9292

93-
Your data volume, retention, and Call Diagnostics query usage in Log Analytics within Azure Monitor is billed through existing Azure data meters. We recommend you monitor your data usage and retention policies for cost considerations as needed. For more information, see [Controlling costs](/azure/azure-monitor/essentials/diagnostic-settings#controlling-costs).
93+
Your data volume, retention, and Call Diagnostics query usage in Log Analytics within Azure Monitor is billed through existing Azure data meters. We recommend that you monitor your data usage and retention policies for cost considerations as needed. For more information, see [Controlling costs](/azure/azure-monitor/essentials/diagnostic-settings#controlling-costs).
9494

9595
If you have multiple Azure Communications Services resource IDs, you must enable these settings for each resource ID and query call details for participants within their respective resource IDs.
9696

@@ -102,7 +102,7 @@ Here are resources for common call problems:
102102

103103
- For an overview of troubleshooting strategies and for more information on isolating call problems, see [Overview of general troubleshooting strategies](../../resources/troubleshooting/voice-video-calling/general-troubleshooting-strategies/overview.md).
104104

105-
- If you see common error messages or descriptions, see [Understanding error messages and codes](../../resources/troubleshooting/voice-video-calling/general-troubleshooting-strategies/understanding-error-codes.md).
105+
- For descriptions of common error messages, see [Understanding error messages and codes](../../resources/troubleshooting/voice-video-calling/general-troubleshooting-strategies/understanding-error-codes.md).
106106

107107
- If users can't join calls, see [Overview of call setup issues](../../resources/troubleshooting/voice-video-calling/call-setup-issues/overview.md).
108108

@@ -122,7 +122,7 @@ Use Copilot in Azure for Call Diagnostics to improve call quality by detailing p
122122

123123
- Learn how to manage call quality: [Improve and manage call quality](manage-call-quality.md).
124124
- Explore troubleshooting guidance: [Overview of audio issues](../../resources/troubleshooting/voice-video-calling/audio-issues/overview.md).
125-
- Continue to learn other quality best practices: [Best practices: Azure Communication Services calling SDKs](../best-practices.md).
125+
- Learn about other quality best practices: [Best practices: Azure Communication Services calling SDKs](../best-practices.md).
126126
- Learn how to use the Log Analytics workspace: [Log Analytics tutorial](/azure/azure-monitor/logs/log-analytics-tutorial).
127127
- Create your own queries in Log Analytics: [Get started with log queries in Azure Monitor](/azure/azure-monitor/logs/get-started-queries).
128128
- Explore known call issues: [Known issues in the SDKs and APIs](../known-issues.md).

articles/communication-services/concepts/voice-video-calling/end-of-call-survey-concept.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The API allows applications to gather data points that describe user-perceived r
5151
| Screen sharing | 2 | 1 - 5 | A response of 1 indicates an imperfect screen-sharing experience. A response of 5 indicates that the customer experienced no screen-sharing problems. |
5252

5353
> [!NOTE]
54-
> A question's indicated cutoff value in the API is the threshold that Microsoft uses when analyzing your survey data. When you customize the cutoff value or input range, Microsoft analyzes your survey data according to your customization.
54+
> A question's indicated cutoff value in the API is the threshold that Microsoft uses when analyzing your survey data. When you customize the cutoff value or input range, Microsoft analyzes your survey data according to your customizations.
5555
5656
### More survey tags
5757

articles/communication-services/concepts/voice-video-calling/manage-call-quality.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ Before you read this article, become familiar with overview information about ca
2424

2525
## Prepare your network and prioritize important network traffic by using QoS
2626

27-
As your users start using Azure Communication Services for calls and meetings, they might experience a caller's voice breaking up or cutting in and out of a call or meeting. Shared video might freeze, or pixelate, or fail altogether. This problem is due to the IP packets that represent voice and video traffic encountering network congestion and arriving out of sequence or not at all. If it happens (or to prevent it from happening in the first place), use Quality of Service (QoS) by following the
28-
[network recommendations](network-requirements.md).
27+
As your users start using Azure Communication Services for calls and meetings, they might experience a caller's voice breaking up or cutting in and out of a call or meeting. Shared video might freeze, or pixelate, or fail altogether. This problem is due to the IP packets that represent voice and video traffic encountering network congestion and arriving out of sequence or not at all. If it happens (or to prevent it from happening in the first place), use Quality of Service (QoS) by following the [network recommendations](network-requirements.md).
2928

3029
With QoS, you prioritize delay-sensitive network traffic (for example, voice or video streams). You allow that traffic to "cut in line" in front of traffic that's less sensitive. An example of lower-priority traffic is downloading a new app. In that case, an extra second to download isn't a significant problem.
3130

@@ -71,7 +70,7 @@ For more information, see [Network Diagnostic tool](../developer-tools/network-d
7170

7271
##### Pre-Call API for diagnostics
7372

74-
Maybe you want to build your own diagnostic tool or to perform a deeper integration of the Network Diagnostic tool into your application. If so, you can use the Pre-Call API to run the diagnostic tool for the Calling SDK.
73+
Maybe you want to build your own diagnostic tool or perform a deeper integration of the Network Diagnostic tool into your application. If so, you can use the Pre-Call API to run the diagnostic tool for the Calling SDK.
7574

7675
The Pre-Call API lets you customize the experience in your user interface. You can then run the same series of tests that the Network Diagnostic tool uses to ensure compatibility, connectivity, and device permissions with a test call. You can decide the best way to tell users how to correct problems before calls begin. You can also perform specific checks when troubleshooting quality and reliability problems.
7776

@@ -86,7 +85,7 @@ Because Azure Communication Services voice and video calls run on web and mobile
8685
- The user forgot to close a previous tab.
8786
- The user couldn't join a call without a meeting organizer present. The user reattempts to select the link for joining the meeting, which opens a separate mobile browser tab.
8887

89-
Having multiple call browser tabs at the same time causes disruptions to audio and video behavior on the call that the user is trying to join (referred to as the *target call*). You should make sure that multiple browser tabs aren't open before a call starts and (through monitoring) during the whole call lifecycle. You can proactively notify customers to close their excess tabs, or help them join a call correctly with useful messaging if they're unable to join a call initially.
88+
Having multiple call browser tabs at the same time causes disruptions to audio and video behavior on the call that the user is trying to join (that is, the *target call*). You should make sure that multiple browser tabs aren't open before a call starts and (through monitoring) during the whole life cycle of the call. You can proactively notify customers to close their excess tabs, or help them join a call correctly with useful messaging if they initially can't join a call.
9089

9190
To check if user has multiple instances of Azure Communication Services running in a browser, see [How to detect if an application using the Azure Communication Services SDK is active in multiple tabs of a browser](../../how-tos/calling-sdk/is-sdk-active-in-multiple-tabs.md).
9291

@@ -134,15 +133,15 @@ To learn more, see [Media quality statistics](media-quality-sdk.md).
134133

135134
#### Optimal Video Count API
136135

137-
During a group call with two or more participants, a user's video quality can fluctuate due to changes in network conditions and their specific hardware limitations. By using the Optimal Video Count API, you can improve user call quality by understanding how many video streams their local endpoint can render at a time without worsening quality.
136+
During a group call with two or more participants, a user's video quality can fluctuate due to changes in network conditions and their specific hardware limitations. By using the Optimal Video Count API, you can improve a user's call quality by understanding how many video streams their local endpoint can render at a time without worsening quality.
138137

139138
By implementing this feature, you can preserve the call quality and bandwidth of local endpoints that would otherwise attempt to render video poorly. The API exposes the property `optimalVideoCount`, which dynamically changes in response to the network and hardware capabilities of a local endpoint. This information is available at runtime and gets updates throughout the call, so you can adjust a user's visual experience as network and hardware conditions change.
140139

141140
To implement this feature, see the web platform guidance [Manage video during calls](/azure/communication-services/how-tos/calling-sdk/manage-video?pivots=platform-web#remote-video-quality).
142141

143142
### After a call
144143

145-
Before you release and scale your Azure Communication Services calling solution, implement the following quality and reliability monitoring capabilities to ensure you're collecting available logs and metrics. The call data isn't stored until you implement the capabilities, so you can't monitor and debug your call quality and reliability without them.
144+
Before you release and scale your Azure Communication Services calling solution, implement the following monitoring capabilities for quality and reliability to ensure that you're collecting available logs and metrics. The call data isn't stored until you implement the capabilities, so you can't monitor and debug your call quality and reliability without them.
146145

147146
For more information, see [Azure Communication Services Voice Calling and Video Calling logs](../analytics/logs/voice-and-video-logs.md).
148147

@@ -156,7 +155,7 @@ We recommend that you monitor your data usage and retention policies for cost co
156155

157156
#### Diagnose calls by using Call Diagnostics
158157

159-
Call Diagnostics is an Azure Monitor experience that delivers tailored insight through specialized telemetry and diagnostic pages in the Azure portal.
158+
Call Diagnostics is an Azure Monitor experience that delivers tailored insights through specialized telemetry and diagnostic pages in the Azure portal.
160159

161160
After you begin storing log data in your Log Analytics workspace, you can visualize your search for individual calls and visualize the data in Call Diagnostics. In your Azure Monitor account, go to your Azure Communication Services resource and locate **Call Diagnostics** on the service menu. To learn how to best use this capability, see [Call Diagnostics](call-diagnostics.md).
162161

@@ -184,7 +183,7 @@ By collecting call data such as media statistics, User Facing Diagnostics, and P
184183

185184
For example, a user might have an hour-long call and report poor audio at one point in the call. The call might have fired a User Facing Diagnostic flag that indicated a severe problem with the quality of an incoming or outgoing media stream.
186185

187-
By storing the [detailed media statistics](media-quality-sdk.md) from the call, you can review when the User Facing Diagnostics flag occurred to see if high levels of packet loss, jitter, or latency around this time indicate a poor network condition. You can explore whether the network was affected by an external client's unmanaged network, unnecessary network traffic due to improper QoS network prioritization policies, or an unnecessary virtual private network (VPN), for example.
186+
By storing the [detailed media statistics](media-quality-sdk.md) from the call, you can review when the User Facing Diagnostics flag occurred to see if high levels of packet loss, jitter, or latency around this time indicate a poor network condition. For example, you can explore whether the network was affected by an external client's unmanaged network, unnecessary network traffic due to improper QoS network prioritization policies, or an unnecessary virtual private network (VPN).
188187

189188
> [!NOTE]
190189
> As a rule, we recommend prioritizing the bandwidth of a user's audio connection before their video connection. We recommend prioritizing both audio and video before other network traffic. When a network can't support both audio and video, you can proactively disable a user's video or nudge a user to disable their video.
@@ -207,4 +206,4 @@ If you don't have access to your customer's Azure portal to view data tied to th
207206
- Explore known issues: [Known issues in the SDKs and APIs](../known-issues.md).
208207
- Learn how to debug calls: [Call Diagnostics](call-diagnostics.md).
209208
- Learn how to use the Log Analytics workspace: [Log Analytics tutorial](/azure/azure-monitor/logs/log-analytics-tutorial).
210-
- Create your own queries: [Get started with log queries in Azure Monitor](/azure/azure-monitor/logs/get-started-queries)
209+
- Create your own queries: [Get started with log queries in Azure Monitor](/azure/azure-monitor/logs/get-started-queries).

0 commit comments

Comments
 (0)