You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communication-services/concepts/analytics/insights/sms-insights.md
+21-13Lines changed: 21 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
-
title: Azure Communication Services SMS Insights Dashboard
3
-
titleSuffix: An Azure Communication Services concept document
4
-
description: Descriptions of data visualizations available for SMS Communications Services via Workbooks
2
+
title: SMS Insights Dashboard
3
+
titleSuffix: An Azure Communication Services carticle
4
+
description: This article describes the data visualizations available for SMS Communications Services via Workbooks
5
5
author: mkhribech
6
6
services: azure-communication-services
7
7
ms.author: mkhribech
@@ -13,11 +13,13 @@ ms.subservice: data
13
13
14
14
# SMS Insights Dashboard
15
15
16
-
In this document, we outline the available insights dashboard to monitor SMS logs and metrics.
16
+
This article describes the available insights dashboard to monitor SMS logs and metrics.
17
17
18
18
## Overview
19
19
20
-
The SMS Insights dashboard in your communication resource shows data visualizations based on the logs and metrics for your SMS usage. It's powered by Azure Monitor logs and metrics that are collected and stored. [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) are used to create the data visualization. To enable Azure Monitor collection to populate the SMS Insights dashboard see [Enable Azure Monitor in Diagnostic Settings](/azure/communication-services/concepts/analytics/enable-logging). Ensure that logs are sent to a [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-overview).
20
+
The SMS Insights dashboard in your communication resource shows data visualizations based on the logs and metrics for your SMS usage. It's powered by Azure Monitor logs and metrics that are collected and stored.
21
+
22
+
Use [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) to create the data visualization. To enable Azure Monitor collection to populate the SMS Insights dashboard, see [Enable Azure Monitor in Diagnostic Settings](/azure/communication-services/concepts/analytics/enable-logging). Ensure that logs are sent to a [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-overview).
21
23
22
24
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-overview-full.png" alt-text="Screenshot of SMS insights overview page.":::
23
25
@@ -39,22 +41,26 @@ The `SMS Insights Dashboard` is made out of four sections:
39
41
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-nav.png" alt-text="Screenshot of SMS insights navigation tabs.":::
40
42
41
43
### Overview section
44
+
42
45
The Overview section provides an overall performance of sent messages along with SMS failure breakdown. The user can filter the SMS performance data by time specific time range, number type, sender number, and destination. The data is presented in interactive graphs that the user can click on to further drill down into logs.
43
46
44
47
Great to help answer general questions like:
45
-
- How many SMS have I sent through my resource?
48
+
- How many SMS messages did I send through my resource?
46
49
- Are my messages being blocked or failing at a glance?
47
50
- What is my message distribution by country/region?
48
51
49
52
#### Top metrics
53
+
50
54
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-overview.png" alt-text="Screenshot of SMS insights overview graphs.":::
51
55
52
56
53
57
#### SMS by country/region
58
+
54
59
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-overview-country.png" alt-text="Screenshot of SMS insights overview by country/region.":::
55
60
56
61
### Message delivery rates section
57
-
The Message Delivery Rates section provides insights into SMS performance and delivery rate per day. The user can select a specific date in the graph to drill into logs.
62
+
63
+
The Message Delivery Rates section provides insights into SMS performance and delivery rate per day. You can select a specific date in the graph to drill into logs.
58
64
59
65
Can help answer questions like:
60
66
- Are there particular days where I'm seeing fewer deliveries?
@@ -63,6 +69,7 @@ Can help answer questions like:
63
69
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-message-rates.png" alt-text="Screenshot of SMS insights message rates.":::
64
70
65
71
### Opt-in & opt-out rates
72
+
66
73
The Opt-in & opt-out rates section provides insights into end user responses for opt-ins/outs and help.
67
74
68
75
Answer questions like:
@@ -71,26 +78,27 @@ Answer questions like:
71
78
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-opt-in-out.png" alt-text="Screenshot of SMS insights opt in and out.":::
72
79
73
80
### Response patterns
81
+
74
82
The Response patterns section provides insights into the total SMS usage in a day across messages delivered, received, failed, and blocked.
75
83
76
-
This section helps you understand:
77
-
- How is my solution performing over time?
84
+
This section helps you understand how the solution performs over time.
78
85
79
86
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-response-patterns.png" alt-text="Screenshot of SMS insights response patterns.":::
80
87
81
88
## Exporting logs
82
-
The SMS logs can be exported by clicking on the Download button on the top right corner of the logs table:
89
+
90
+
To export SMS logs, click the Download button on the top right corner of the logs table:
83
91
84
92
:::image type="content" source="..\media\workbooks\sms-insights\sms-insights-export.png" alt-text="Screenshot of SMS insights export.":::
85
93
86
94
## Editing dashboards
87
95
88
-
The **SMS insights** dashboards provided with your **Communication Service** resource can be customized by clicking on the **Edit** button on the top navigation bar:
96
+
To customize the **SMS insights** dashboards provided with your **Communication Service** resource, click the **Edit** button on the top navigation bar:
89
97
90
98
:::image type="content" source="..\media\workbooks\dashboard-editing.png" alt-text="Screenshot of dashboard editing process.":::
91
99
92
-
Editing these dashboards doesn't modify the **Insights** tab, but rather creates a separate workbook, which can be accessed on your resource’s Workbooks tab:
100
+
Editing these dashboards doesn't modify the **Insights** tab, but rather creates a separate workbook, which you can access on your resource Workbooks tab:
93
101
94
102
:::image type="content" source="..\media\workbooks\workbooks-tab.png" alt-text="Screenshot of the workbooks tab.":::
95
103
96
-
For an in-depth description of workbooks, refer to the[Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) documentation.
104
+
For an in-depth description of workbooks, see[Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) documentation.
Azure Communication Services offers logging capabilities that you can use to monitor and debug your Communication Services solution. These capabilities can be configured through the Azure portal.
17
+
Azure Communication Services provides logging capabilities you can use to monitor and debug your Communication Services solution. You can configure these capabilities through the Azure portal.
18
18
19
19
> [!IMPORTANT]
20
-
> The following refers to logs enabled through [Azure Monitor](/azure/azure-monitor/overview)(see also [FAQ](/azure/azure-monitor/overview#frequently-asked-questions)). To enable these logs for your Communications Services, see: [Enable logging in Diagnostic Settings](../enable-logging.md)
20
+
> This article describes logs enabled through [Azure Monitor](/azure/azure-monitor/overview)See also [FAQ](/azure/azure-monitor/overview#frequently-asked-questions). To enable these logs for your Communications Services, see: [Enable logging in Diagnostic Settings](../enable-logging.md).
21
21
22
-
## Pre-requisites
22
+
## Prerequisites
23
23
24
-
Azure Communications Services provides monitoring and analytics features via [Azure Monitor Logs overview](/azure/azure-monitor/logs/data-platform-logs) and [Azure Monitor Metrics](/azure/azure-monitor/essentials/data-platform-metrics). Each Azure resource requires its own diagnostic setting, which defines the following criteria:
25
-
* Categories of logs and metric data sent to the destinations defined in the setting. The available categories will vary for different resource types.
26
-
* One or more destinations to send the logs. Current destinations include Log Analytics workspace, Event Hubs, and Azure Storage.
27
-
* A single diagnostic setting can define no more than one of each of the destinations. If you want to send data to more than one of a particular destination type (for example, two different Log Analytics workspaces), then create multiple settings. Each resource can have up to five diagnostic settings.
24
+
Azure Communications Services provides monitoring and analytics features via [Azure Monitor Logs overview](/azure/azure-monitor/logs/data-platform-logs) and [Azure Monitor Metrics](/azure/azure-monitor/essentials/data-platform-metrics).
28
25
29
-
The following are instructions for configuring your Azure Monitor resource to start creating logs and metrics for your Communications Services. For detailed documentation about using Diagnostic Settings across all Azure resources, see: [Enable logging in Diagnostic Settings](../enable-logging.md)
26
+
Each Azure resource requires its own diagnostic setting, which defines the following criteria:
27
+
28
+
- Categories of logs and metric data sent to the destinations defined in the setting. The available categories vary for different resource types.
29
+
- One or more destinations to send the logs. Current destinations include Log Analytics workspace, Event Hubs, and Azure Storage.
30
+
- A single diagnostic setting can define no more than one of each of the destinations. If you want to send data to more than one of a particular destination type (for example, two different Log Analytics workspaces), you need to create multiple settings. Each resource can have up to five diagnostic settings.
31
+
32
+
Complete these instructions to configure your Azure Monitor resource to start creating logs and metrics for your Communications Services. For detailed documentation about using Diagnostic Settings across all Azure resources, see: [Enable logging in Diagnostic Settings](../enable-logging.md).
30
33
31
34
> [!NOTE]
32
-
> Under diagnostic setting name please select “SMS Operational” to enable the logs for SMS.
35
+
> T to enable the logs for SMS, under diagnostic setting name select **SMS Operational**.
33
36
34
37
## **Overview**
35
38
36
-
SMS operational logs are records of events and activities that provide insights into your SMS API requests. They captured details about the performance and functionality of the SMS primitive, including details about the status of message whether they were successfully delivered, blocked, or failed to send.
37
-
SMS operational logs contain information that help identify trends and patterns, resolve issues that might be impacting performance such failed message deliveries or serve issues. The logs include the following details:
39
+
SMS operational logs are records of events and activities that provide insights into your SMS API requests. Logs capture details about the performance and function of SMS. Details include the status of messages, whether the message was successfully delivered, blocked, or failed to send.
40
+
41
+
SMS operational logs contain information to help identify trends and patterns, resolve issues that might be impacting performance such failed message deliveries or serve issues. The logs include the following details:
38
42
* Messages sent.
39
43
* Message received.
40
44
* Messages delivered.
41
-
* Messages opt-in & opt-out.
45
+
* Messages optin & optout.
42
46
43
47
## Resource log categories
44
48
45
-
Communication Services offers the following types of logs that you can enable:
49
+
Communication Services offers the following types of logs:
46
50
47
51
***Usage logs** - provides usage data associated with each billed service offering
48
52
***SMS operational logs** - provides basic information related to the SMS service
49
53
50
-
51
54
### Usage logs schema
52
55
53
56
| Property | Description |
54
57
| -------- | ---------------|
55
58
|`Timestamp`| The timestamp (UTC) of when the log was generated. |
56
59
|`Operation Name`| The operation associated with log record. |
57
-
|`Operation Version`| The `api-version` associated with the operation, if the operationName was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
60
+
|`Operation Version`| The `api-version` associated with the operation, if the operationName was performed using an API. If no API corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
58
61
|`Category`| The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
59
62
|`Correlation ID`| The ID for correlated events. Can be used to identify correlated events between multiple tables. |
60
63
|`Properties`| Other data applicable to various modes of Communication Services. |
61
64
|`Record ID`| The unique ID for a given usage record. |
62
-
|`Usage Type`| The mode of usage. (for example, Chat, PSTN, NAT, etc.)|
63
-
|`Unit Type`| The type of unit that usage is based off for a given mode of usage. (for example, minutes, megabytes, messages, etc.). |
65
+
|`Usage Type`| The mode of usage. Such as Chat, PSTN, NAT, and so on.|
66
+
|`Unit Type`| The type of unit that usage is based off for a given mode of usage. Such as minutes, megabytes, messages, and so on. |
64
67
|`Quantity`| The number of units used or consumed for this record. |
65
68
66
69
### SMS operational logs
@@ -70,8 +73,8 @@ Communication Services offers the following types of logs that you can enable:
70
73
|`TimeGenerated`| The timestamp (UTC) of when the log was generated. |
71
74
|`OperationName`| The operation associated with log record. |
72
75
|`CorrelationID`| The ID for correlated events. Can be used to identify correlated events between multiple tables. |
73
-
|`OperationVersion`| The api-version associated with the operation, if the operationName was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
74
-
|`Category`| The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
76
+
|`OperationVersion`| The api-version associated with the operation, if the operationName was performed using an API. If no API corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
77
+
|`Category`| The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties in the properties blob of an event are the same within a particular log category and resource type. |
75
78
|`ResultType`| The status of the operation. |
76
79
|`ResultSignature`| The sub status of the operation. If this operation corresponds to a REST API call, this field is the HTTP status code of the corresponding REST call. |
77
80
|`ResultDescription`| The static text description of this operation. |
@@ -86,9 +89,9 @@ Communication Services offers the following types of logs that you can enable:
86
89
|`SdkType`| The SDK type used in the request. |
87
90
|`PlatformType`| The platform type used in the request. |
88
91
|`Method`| The method used in the request. |
89
-
|`NumberType`| The type of number, the SMS message is being sent from. It can be either **LongCodeNumber** or **ShortCodeNumber** or **DynamicAlphaSenderID**|
90
-
|`MessageID`|Represent the unique messageId generated for every outgoing and incoming message. This can be found in the SMS API response object|
91
-
|`Country`|Represent the countries/regions where the SMS messages were sent to or received from|
92
+
|`NumberType`| The type of number, the SMS message is being sent from. It can be either **LongCodeNumber**, **ShortCodeNumber**, or **DynamicAlphaSenderID**.|
93
+
|`MessageID`| Represents the unique messageId generated for every outgoing and incoming message. Find the MessageId in the SMS API response object. |
94
+
|`Country`| Represents the countries/regions where SMS messages are sent to or received from. |
92
95
93
96
#### Example SMS sent log
94
97
@@ -123,6 +126,7 @@ Communication Services offers the following types of logs that you can enable:
123
126
```
124
127
125
128
#### Example SMS delivery report log
129
+
126
130
```json
127
131
128
132
[
@@ -153,6 +157,7 @@ Communication Services offers the following types of logs that you can enable:
153
157
```
154
158
155
159
#### Example SMS received log
160
+
156
161
```json
157
162
158
163
[
@@ -182,4 +187,6 @@ Communication Services offers the following types of logs that you can enable:
182
187
183
188
```
184
189
185
-
(see also [FAQ](/azure/azure-monitor/overview#frequently-asked-questions)).
title: SMS metrics definitions for Azure Communication Service
3
-
titleSuffix: An Azure Communication Services concept document
4
-
description: This document covers definitions of SMS metrics available in the Azure portal.
2
+
title: SMS metrics
3
+
titleSuffix: An Azure Communication Services article
4
+
description: This article describes the SMS metrics available in the Azure portal.
5
5
author: mkhribech
6
6
services: azure-communication-services
7
7
ms.author: mkhribech
@@ -10,17 +10,17 @@ ms.topic: conceptual
10
10
ms.service: azure-communication-services
11
11
ms.subservice: data
12
12
---
13
-
# SMS metrics overview
13
+
# SMS metrics
14
14
15
-
Azure Communication Services currently provides metrics for all Communication Services primitives. You can use [Azure Monitor metrics explorer](/azure/azure-monitor/essentials/analyze-metrics) to:
15
+
Azure Communication Services provides metrics for Azure Communication Services. You can use [Azure Monitor metrics explorer](/azure/azure-monitor/essentials/analyze-metrics) to:
16
16
17
17
- Plot your own charts.
18
18
- Investigate abnormalities in your metric values.
19
19
- Understand your API traffic by using the metrics data that Chat requests emit.
20
20
21
21
## Where to find metrics
22
22
23
-
Primitives in Communication Services emit metrics for API requests. To find these metrics, see the **Metrics** tab under your Communication Services resource. You can also create permanent dashboards by using the workbooks tab under your Communication Services resource.
23
+
Each service in Azure Communication Services emits metrics for API requests. To view metrics, see the **Metrics** tab under your Communication Services resource. You can also create permanent dashboards by using the workbooks tab under your Communication Services resource.
24
24
25
25
## Metric definitions
26
26
@@ -36,8 +36,8 @@ For more information on supported aggregation types and time series aggregations
36
36
37
37
The following operations are available on SMS API request metrics.
0 commit comments