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
# Enable logs via Diagnostic Settings in Azure Monitor
16
-
17
-
## Overview
15
+
# Enable logging with Azure Monitor
18
16
19
17
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:
20
18
21
-
- Categories of logs and metric data sent to the destinations defined in the setting. The available categories will vary for different resource types.
19
+
- Categories of logs and metric data sent to the destinations defined in the setting. The available categories vary for different resource types.
22
20
- One or more destinations to send the logs. Current destinations include Log Analytics workspace, Event Hubs, and Azure Storage.
23
21
- 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
22
25
-
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: [Diagnostic Settings](/azure/azure-monitor/essentials/diagnostic-settings).
23
+
The following instructions describe how to configure your Azure Monitor resource to start creating logs and metrics for your Communications Services. For more information about using Diagnostic Settings across all Azure resources, see: [Diagnostic Settings](/azure/azure-monitor/essentials/diagnostic-settings).
26
24
27
25
These instructions apply to the following Communications Services logs:
28
26
@@ -31,27 +29,27 @@ These instructions apply to the following Communications Services logs:
31
29
32
30
## Access Diagnostic Settings
33
31
34
-
To access Diagnostic Settings for your Communications Services, start by navigating to your Communications Services home page within Azure portal:
32
+
To access Diagnostic Settings for your Communications Services, open your Communications Services home page within Azure portal:
You'll then be prompted to choose a name for your Diagnostic Setting, which is useful if you have many Azure resources you are monitoring. You'll also be prompted to select the log and metric data sources you wish to monitor as either logs or metrics. See [Azure Monitor data platform](/azure/azure-monitor/data-platform) for more detail on the difference.
46
+
The system prompts you to choose a name for your diagnostic setting, which is useful if you have many Azure resources to monitor. The system also prompts you to select the log and metric data sources you wish to monitor as either logs or metrics. See [Azure Monitor data platform](/azure/azure-monitor/data-platform) for more detail on the difference.
49
47
50
48
:::image type="content" source="media\enable-logging\diagnostic-setting-categories-details-acs.png" alt-text="Adding a Diagnostic Setting":::
51
49
52
50
## Choose Destinations
53
51
54
-
You'll also be prompted to select a destination to store the logs. Platform logs and metrics can be sent to the destinations in the following table, which is also included in Azure Monitor documentation in deeper detail: [Create diagnostic settings to send platform logs and metrics to different destinations.](/azure/azure-monitor/essentials/diagnostic-settings?tabs=CMD)
52
+
The system also prompts you to select a destination to store the logs. Platform logs and metrics can be sent to the destinations in the following table. For more information, see [Create diagnostic settings to send platform logs and metrics to different destinations.](/azure/azure-monitor/essentials/diagnostic-settings?tabs=CMD).
55
53
56
54
| Destination | Description |
57
55
|:------------|:------------|
@@ -63,17 +61,16 @@ The following settings are an example of what you would see within your Communic
They're all viable and flexible options that can adapt to your specific storage needs; however, we provide other features and built in analytic insights when the Log Analytics Workspace option is selected.
64
+
All settings are viable and flexible options that you can adapt to your specific storage needs. We also provide other features and built in analytic insights if you select the Log Analytics Workspace option.
67
65
68
-
## Log Analytics Workspace for additional analytics features
66
+
## Log Analytics Workspace for more analytics features
69
67
70
68
By choosing to send your logs to a [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-overview) destination, you enable more features within Azure Monitor generally and for your Communications Services. Log Analytics is a tool within Azure portal used to create, edit, and run [queries](/azure/azure-monitor/logs/queries) with data in your Azure Monitor logs and metrics and [Workbooks](/azure/azure-monitor/visualize/workbooks-overview), [alerts](/azure/azure-monitor/alerts/alerts-log), [notification actions](/azure/azure-monitor/alerts/action-groups), [REST API access](/rest/api/loganalytics/), and many others. If you don't have a Log Analytics workspace, you must [create one before you proceed.](/azure/azure-monitor/logs/quick-create-workspace)
71
69
72
-
For your Communications Services logs, we've provided a useful [default query pack](/azure/azure-monitor/logs/query-packs#default-query-pack) to provide an initial set of insights to quickly analyze and understand your data. These query packs are described here: [Log Analytics for Communications Services](query-call-logs.md).
73
-
74
-
## Next Steps
70
+
For your Communications Services logs, we provided a useful [default query pack](/azure/azure-monitor/logs/query-packs#default-query-pack) to provide an initial set of insights to quickly analyze and understand your data. These query packs are described here: [Log Analytics for Communications Services](query-call-logs.md).
75
71
76
-
- If you don't have a Log Analytics workspace to send your data to, you must create one before you proceed. See: [Create a Log Analytics workspace](/azure/azure-monitor/logs/quick-create-workspace)
72
+
## Next steps
77
73
74
+
- If you don't have a Log Analytics workspace to send your data to, you must create one before you proceed. For more information, see [Create a Log Analytics workspace](/azure/azure-monitor/logs/quick-create-workspace).
78
75
79
-
- You may start a Diagnostic Setting to use certain capabilities by enabling collection for all logs, however you should monitor costs associated with logs from Diagnostic Settings, see:[Controlling costs](/azure/azure-monitor/essentials/diagnostic-settings#controlling-costs)
76
+
- You may start a Diagnostic Setting to use certain capabilities by enabling collection for all logs. However, you should monitor costs associated with logs from Diagnostic Settings. For more information, see [Controlling costs](/azure/azure-monitor/essentials/diagnostic-settings#controlling-costs).
In this document, we outline the available insights dashboard to monitor Email logs and metrics.
17
+
This article describes the available insights dashboard to monitor Email logs and metrics.
18
18
19
19
## Overview
20
-
Within your Communications Resource, we've provided an **Insights Preview** feature that displays many data visualizations conveying insights 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.
20
+
21
+
Within your Communications Resource, we provide an **Insights Preview** feature that displays many data visualizations conveying insights 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.
21
22
22
23
:::image type="content" source="..\media\workbooks\insights-overview-2.png" alt-text="Screenshot of Communication Services Insights dashboard.":::
23
24
24
25
## Prerequisites
25
26
26
-
-In order to take advantage of Workbooks, follow the instructions outlined in [Enable Azure Monitor in Diagnostic Settings](../enable-logging.md). You need to enable `Email Service Send Mail Logs`, `Email Service Delivery Status Update Logs` , `Email Service User Engagement Logs.`
27
+
-To take advantage of Workbooks, follow the instructions outlined in [Enable Azure Monitor in Diagnostic Settings](../enable-logging.md). You need to enable `Email Service Send Mail Logs`, `Email Service Delivery Status Update Logs` , `Email Service User Engagement Logs.`
27
28
- To use Workbooks, you need to send your logs to a [Log Analytics workspace](/azure/azure-monitor/logs/log-analytics-overview) destination.
28
29
29
30
## Accessing Azure Insights for Communication Services
@@ -36,11 +37,12 @@ Inside your Azure Communication Services resource, scroll down on the left nav b
36
37
37
38
The Email Insights dashboards give users an intuitive and clear way to navigate their Email usage data. The dashboard is broken into two subsections overview and email performance.
38
39
39
-
Filters: Filters help you focus on the data that is most relevant to your needs by narrowing down your report to specific criteria such as specific date range, recipient info or location.
40
+
Filtershelp you focus on the data that is most relevant to your needs by narrowing down your report to specific criteria such as specific date range, recipient info, or location.
40
41
41
42
:::image type="content" source="../media/workbooks/email-insights/email-overview.png" alt-text="Screenshot of email dashboard overview.":::
42
43
43
-
### Overview:
44
+
### Overview
45
+
44
46
This section provides insights into the effectiveness of email notifications and message performance to enable identification of patterns impacting message delivery. This graph measures the Total messages sent, messages delivered, messages failed, and messages blocked, message viewed, and message clicked, and the size of the message sent & delivered.
45
47
46
48
#### Overall email health
@@ -49,36 +51,36 @@ Overall email insight measures email delivery that assesses effectiveness and ef
49
51
50
52
:::image type="content" source="../media/workbooks/email-insights/email-health.png" alt-text="Screenshot of overall email health campaign.":::
51
53
52
-
53
54
#### Email size
54
-
Email size represents the storage space your emails are taking up, this information will help optimize your mailbox and prevent it from reaching the max size and impact performance.
55
+
56
+
Email size represents the storage space your emails are taking up, this information helps optimize your mailbox and prevent it from reaching the max size and impact performance.
55
57
56
58
:::image type="content" source="../media/workbooks/email-insights/email-size.png" alt-text="Screenshot of email size.":::
57
59
58
-
### Email performance:
59
-
This section provides insights into the email delivery rate, delivery log indicating information about delivered emailed, bounced, blocked, suppression, failed etc. Analyzing the delivery log will help identify any issues or patterns and enable you to troubleshoot delivery problems and improved customer engagement.
60
-
60
+
### Email performance
61
61
62
-
#### Email delivery rates
63
-
Email delivery rates are pivotal to the success of the email marketing campaign, it provides insights into email performance over time. Measuring and monitoring the message delivery performance over extended periods by week or month or specified period.
62
+
This section provides insights into the email delivery rate, delivery log indicating information about delivered emailed, bounced, blocked, suppression, failed, and so on. Analyzing the delivery log helps identify any issues or patterns and enable you to troubleshoot delivery problems and improved customer engagement.
64
63
65
-
:::image type="content" source="../media/workbooks/email-insights/email-delivery-rate.png" alt-text="Screenshot of email delivery rate .":::
64
+
#### Email delivery rates
66
65
67
-
#### Failure rate
66
+
Email delivery rates are pivotal to the success of the email marketing campaign. It provides insights into email performance over time. Measuring and monitoring the message delivery performance over extended periods by week or month or specified period.
68
67
69
-
Email failure rate represents the different types of unsuccessful email deliveries including failed, bounced, blocked, and suppressed. It helps measure the following:
68
+
:::image type="content" source="../media/workbooks/email-insights/email-delivery-rate.png" alt-text="Screenshot of email delivery rate.":::
70
69
71
-
** Failed rate: it represents the number of emails that didn’t get delivered to the recipient for various reasons.
72
-
** Suppression rate: It represents the number of recipients who expressed interest and agreed to receive email messages from you but has no valid mailbox with that address anymore or opt-out of receiving emails from you.
73
-
** Bounce rate: It represents the number of emails that couldn’t be delivered due to recipient’s email address is invalid, email server blocked the delivery or invalid domain name.
74
-
** Blocked rate: It represents the number of emails that were not delivered through the recipient’s email server or were blocked by spam filter
70
+
#### Failure rate
75
71
76
-
:::image type="content" source="../media/workbooks/email-insights/email-failure-rate.png" alt-text="Screenshot of email failure rate.":::
72
+
Email failure rate represents the different types of unsuccessful email deliveries including failed, bounced, blocked, and suppressed. It helps measure the following categories:
73
+
74
+
-**Failed rate:** represents the number of emails that didn’t get delivered to the recipient for various reasons.
75
+
-**Suppression rate:** represents the number of recipients who expressed interest and agreed to receive email messages from you but has no valid mailbox with that address anymore or opt-out of receiving emails from you.
76
+
-**Bounce rate:** represents the number of emails that couldn’t be delivered due to recipient’s email address is invalid, email server blocked the delivery or invalid domain name.
77
+
-**Blocked rate:** represents the number of emails not delivered through the recipient’s email server or blocked by spam filter.
77
78
79
+
:::image type="content" source="../media/workbooks/email-insights/email-failure-rate.png" alt-text="Screenshot of email failure rate.":::
78
80
79
81
## More information about workbooks
80
82
81
-
For an in-depth description of workbooks, refer to the [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) documentation.
83
+
For an in-depth description of workbooks, see [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview).
82
84
83
85
## Editing dashboards
84
86
@@ -89,5 +91,3 @@ The **Insights** dashboards provided with your **Communication Service** resourc
89
91
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:
90
92
91
93
:::image type="content" source="../media/workbooks/workbooks-tab.png" alt-text="Screenshot of the workbooks tab.":::
92
-
93
-
For an in-depth description of workbooks, refer to the [Azure Monitor Workbooks](/azure/azure-monitor/visualize/workbooks-overview) documentation.
Copy file name to clipboardExpand all lines: articles/communication-services/concepts/analytics/logs/call-summary-log-schema.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,6 @@ This table describes each property.
74
74
|`ParticipantEndSubCode`| Represents the Calling SDK error subcode that the SDK emits (when relevant) for each `participantId` value. |
75
75
|`ResultCategory`| Represents the category of the participant ending the call. It can be one of these four values: Success, ExpectedError, UnexpectedClientError, UnexpectedServerError. |
76
76
|`DiagnosticOptions`| This value allows developers to attach custom tags to their client telemetry, which can then be viewed in the Call Diagnostics section. This helps in identifying and troubleshooting issues more effectively. To learn how to add custom tags to this value, refer to [Tutorial on adding custom tags to your client telemetry](../../../tutorials/voice-video-calling/diagnostic-options-tag.md)|
77
-
|`callDebuggingInfo`| This value contains json object with key-value pairs that represent internal properties of the call used for Microsoft debugging purposes.|
78
77
79
78
### Error codes
80
79
@@ -337,4 +336,4 @@ If you have multiple Azure Communications Services resource IDs, you must enable
337
336
- Learn about the [insights dashboard to monitor Voice Calling and Video Calling logs](/azure/communication-services/concepts/analytics/insights/voice-and-video-insights).
338
337
339
338
- Learn how to use call logs to diagnose call quality and reliability
340
-
issues with Call Diagnostics, see: [Call Diagnostics](../../voice-video-calling/call-diagnostics.md)
339
+
issues with Call Diagnostics, see: [Call Diagnostics](../../voice-video-calling/call-diagnostics.md)
![learn-build-service-prod[bot]](https://avatars.githubusercontent.com/in/237442?v=4&size=40){kind=avatar}
0 commit comments