|
| 1 | +--- |
| 2 | +title: Azure Communication Services Insights dashboard |
| 3 | +titleSuffix: An Azure Communication Services concept document |
| 4 | +description: Descriptions of data visualizations available from the Insights dashboard. |
| 5 | +author: amagginetti |
| 6 | +services: azure-communication-services |
| 7 | + |
| 8 | +ms.author: amagginetti |
| 9 | +ms.date: 03/08/2021 |
| 10 | +ms.topic: conceptual |
| 11 | +ms.service: azure-communication-services |
| 12 | +ms.subservice: data |
| 13 | +--- |
| 14 | + |
| 15 | +# Insights dashboard |
| 16 | + |
| 17 | +This article describes insights available from the Insights dashboard. Use these insights to monitor logs and metrics. |
| 18 | + |
| 19 | +## Overview |
| 20 | + |
| 21 | +Each Communications Resource includes an Insights dashboard that displays data visualizations from the Azure Monitor logs and metrics monitored for your Communications Services. The visualizations within Insights are made possible via [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview). In order to take advantage of Workbooks, follow the instructions outlined in [Enable Azure Monitor in Diagnostic Settings](../enable-logging.md). To enable Workbooks, you need to send your logs to a [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-overview) destination. |
| 22 | + |
| 23 | +:::image type="content" source="..\media\workbooks\insights-overview-2.png" alt-text="Screenshot of Communication Services Insights dashboard."::: |
| 24 | + |
| 25 | +## Prerequisites |
| 26 | + |
| 27 | +- In order to take advantage of Workbooks, follow the instructions outlined in [Enable Logging with Azure Monitor](../enable-logging.md). You need to enable `Operational Authentication Logs`, `Call Summary Logs`, `Call Diagnostic Logs`. |
| 28 | +- To use Workbooks, you need to send your logs to a [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-overview) destination. |
| 29 | + |
| 30 | +## Accessing Azure Insights for Communication Services |
| 31 | + |
| 32 | +Inside your Azure Communication Services resource, scroll down on the left nav bar to the **Monitor** category and click on the **Insights** tab: |
| 33 | + |
| 34 | +:::image type="content" source="..\media\workbooks\acs-insights-nav.png" alt-text="Screenshot of the Insights navigation blade."::: |
| 35 | + |
| 36 | +## Authentication insights |
| 37 | + |
| 38 | +The **Authentication** tab shows authentication logs, which are created through operations such as issuing an access token or creating an identity. The data displayed includes the types of operations performed and the results of those operations: |
| 39 | + |
| 40 | +:::image type="content" source="..\media\workbooks\auth.png" alt-text="Screenshot of the authentication overview."::: |
| 41 | + |
| 42 | +## Voice and Video Insights |
| 43 | + |
| 44 | +Since **Voice and video** logs are the most complex in nature, this modality is broken down into four subsections: |
| 45 | + |
| 46 | +:::image type="content" source="..\media\workbooks\voice-and-video-nav.png" alt-text="Screenshot of voice and video navigation."::: |
| 47 | + |
| 48 | +The **Summary** tab contains general information about Voice and video usage, including the types of media streams shared, the types of endpoints participating in a call (e.g. VoIP, Bot, Application, PSTN, or Server), the OS usage, and participant end reasons: |
| 49 | + |
| 50 | +:::image type="content" source="..\media\workbooks\voice-and-video-summary.png" alt-text="Screenshot of voice and video summary."::: |
| 51 | + |
| 52 | +The **Volume** tab under the **Voice and video** modality displays the number of calls and the number of participants in a specific period of time (**Time range** parameter), subdivided into time bins (**Time granularity** parameter): |
| 53 | + |
| 54 | +:::image type="content" source="..\media\workbooks\voice-and-video-volume.png" alt-text="Screenshot of voice and video volume."::: |
| 55 | + |
| 56 | +The **Volume** tab contains a **Grouping** parameter, which helps visualize the number of calls and participants segmented by either Call type (P2P vs. Group calls) and Interop Calls (pure Azure Communication Services vs. Teams Interop): |
| 57 | + |
| 58 | +:::image type="content" source="..\media\workbooks\voice-and-video-volume-grouping.png" alt-text="Screenshot of voice and video volume grouping."::: |
| 59 | + |
| 60 | +The **Quality** tab under **Voice and video** allows users to inspect the quality distribution of calls, where quality is defined at three levels for this dashboard: |
| 61 | + |
| 62 | +- The proportion of poor-quality media streams (**Stream quality** plot), where a stream’s quality is classified as Poor when it has at least one unhealthy telemetry value, where unhealthy ranges are defined as: |
| 63 | + - Jitter > 30 milliseconds |
| 64 | + - Packet loss rate > 10% |
| 65 | + - Round trip time > 500 milliseconds |
| 66 | + |
| 67 | +- The proportion of **Impacted calls**, where an impacted call is defined as a call that has at least one poor quality stream |
| 68 | + |
| 69 | +- **Participant end reasons**, which keep track of the reason why a participant left a call. End reasons are [SIP codes](https://en.wikipedia.org/wiki/List_of_SIP_response_codes), which are numeric codes that describe the specific status of a signaling request. SIP codes can be grouped into six categories: *Success*, *Client Failure*, *Server Failure*, *Global Failure*, *Redirection*, and *Provisional*. The distribution of SIP code categories is shown in the pie chart on the left hand side, while a list of the specific SIP codes for participant end reasons is provided on the right hand side |
| 70 | + |
| 71 | +:::image type="content" source="..\media\workbooks\voice-and-video-quality.png" alt-text="Screenshot of voice and video quality."::: |
| 72 | + |
| 73 | +Quality can also be filtered by the types of media streams (**Media Type** parameter) used in the call, e.g. to only get the impacted calls in terms of video stream quality: |
| 74 | + |
| 75 | +:::image type="content" source="..\media\workbooks\voice-and-video-quality-params.png" alt-text="Screenshot voice and video quality media type parameter."::: |
| 76 | + |
| 77 | +And can also be filtered by endpoint types (**Endpoint Type** parameter), e.g. getting the participant end reasons for PSTN participants. These filters allow for multiple selections: |
| 78 | + |
| 79 | +:::image type="content" source="..\media\workbooks\voice-and-video-params-2.png" alt-text="Screenshot voice and video quality endpoint type parameter."::: |
| 80 | + |
| 81 | +The **Details** tab offers a quick way to navigate through the **Voice and video** calls made in a time range by grouping calls by dates, and showing the details of every call made in terms of the participants in that call and the outgoing streams per participant, together with duration and telemetry values for these: |
| 82 | + |
| 83 | +:::image type="content" source="..\media\workbooks\voice-and-video-details.png" alt-text="Screenshot of voice and video details."::: |
| 84 | + |
| 85 | +The details of a call are initially hidden. A list of the participants is displayed after clicking on a call: |
| 86 | + |
| 87 | +:::image type="content" source="..\media\workbooks\voice-and-video-details-participants.png" alt-text="Screenshot of voice and video participant details."::: |
| 88 | + |
| 89 | +And clicking on a participant displays a list of the outgoing streams for that participant, together with their duration (proportional to the full call duration) and telemetry values, where unhealthy values are displayed in red: |
| 90 | + |
| 91 | +:::image type="content" source="..\media\workbooks\voice-and-video-details-streams.png" alt-text="Screenshot of voice and video stream details."::: |
| 92 | + |
| 93 | +## More information about workbooks |
| 94 | + |
| 95 | +For an in-depth description of workbooks, refer to the [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) documentation. |
| 96 | + |
| 97 | +## Editing dashboards |
| 98 | + |
| 99 | +The **Insights** dashboards provided with your **Communication Service** resource can be customized by clicking on the **Edit** button on the top navigation bar: |
| 100 | + |
| 101 | +:::image type="content" source="..\media\workbooks\dashboard-editing.png" alt-text="Screenshot of dashboard editing process."::: |
| 102 | + |
| 103 | +Editing these dashboards doesn't modify the **Insights** tab, but rather creates a separate workbook that can be accessed on your resource’s Workbooks tab: |
| 104 | + |
| 105 | +:::image type="content" source="..\media\workbooks\workbooks-tab.png" alt-text="Screenshot of the workbooks tab."::: |
| 106 | + |
| 107 | +For an in-depth description of workbooks, refer to the [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) documentation. |
0 commit comments