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/chat-metrics.md
+7-6Lines changed: 7 additions & 6 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
2
title: Chat metrics definitions for Azure Communication Service
3
-
titleSuffix: An Azure Communication Services concept document
4
-
description: This document covers definitions of chat metrics available in the Azure portal.
3
+
titleSuffix: An Azure Communication Services article
4
+
description: This article defines of chat metrics available in the Azure portal.
5
5
author: mkhribech
6
6
services: azure-communication-services
7
7
ms.author: mkhribech
@@ -10,17 +10,18 @@ ms.topic: conceptual
10
10
ms.service: azure-communication-services
11
11
ms.subservice: data
12
12
---
13
+
13
14
# Chat metrics overview
14
15
15
-
Azure Communication Services currently provides metrics for all Communication Services primitives. You can use [Azure Metrics Explorer](/azure/azure-monitor/essentials/metrics-getting-started) to:
16
+
Azure Communication Services currently provides metrics for all Communication Services services. You can use [Azure Metrics Explorer](/azure/azure-monitor/essentials/metrics-getting-started) to:
16
17
17
18
- Plot your own charts.
18
19
- Investigate abnormalities in your metric values.
19
-
- Understand your API traffic by using the metrics data that Chat requests emit.
20
+
- Understand your API traffic using the metrics data that Chat requests emit.
20
21
21
22
## Where to find metrics
22
23
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.
24
+
Each service emits metrics for API requests. To find these metrics, see the **Metrics** tab under your Communication Services resource. You can also create permanent dashboards using the workbooks tab under your Communication Services resource.
24
25
25
26
## Metric definitions
26
27
@@ -55,7 +56,7 @@ The following operations are available on Chat API request metrics.
55
56
| AddChatThreadParticipants | Adds thread members to a thread. If members already exist, no change occurs. |
56
57
| RemoveChatThreadParticipant | Removes a member from a thread. |
57
58
58
-
If a request is made to an operation that isn't recognized, you receive a "Bad Route" value response.
59
+
If a request to an operation isn't recognized, you receive a "Bad Route" value response.
In this document, we outline the available insights dashboard to monitor Chat logs and metrics.
17
+
This article describes the insights dashboard you can view to monitor Chat logs and metrics.
18
18
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.
19
+
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.
20
+
21
+
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 `Operational Chat Logs`,`Operational Authentication Logs`.
27
+
-To use Workbooks, follow the instructions in [Enable Azure Monitor in Diagnostic Settings](../enable-logging.md). You need to enable `Operational Chat Logs` and`Operational Authentication 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
30
31
31
-
Inside your Azure Communication Services resource, scroll down on the left nav bar to the **Monitor** category and click on the **Insights** tab:
32
+
Inside your Azure Communication Services resource, scroll down on the left nav bar to the **Monitor** category and click the **Insights** tab:
32
33
33
34
:::image type="content" source="..\media\workbooks\acs-insights-nav.png" alt-text="Screenshot of the Insights navigation blade.":::
34
35
35
-
## Authentication insights
36
+
## Authentication insights tab
36
37
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:
38
39
39
40
:::image type="content" source="..\media\workbooks\auth.png" alt-text="Screenshot that shows the authentication tab.":::
40
41
41
-
## Chat insights
42
+
## Chat insights tab
42
43
43
44
The **Chat** tab displays the data for all chat-related operations and their result types:
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.
16
+
Azure Communication Services provides logging capabilities that you can use to monitor and debug your Communication Services solution. These capabilities can be configured through the Azure portal.
17
17
18
18
> [!IMPORTANT]
19
-
> 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)
19
+
> This article 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
20
21
21
## Resource log categories
22
22
23
-
Communication Services offers the following types of logs that you can enable:
23
+
Communication Services provides the following types of logs that you can enable:
24
24
25
25
***Usage logs** - provides usage data associated with each billed service offering
26
26
***Authentication operational logs** - provides basic information related to the Authentication service
Copy file name to clipboardExpand all lines: articles/communication-services/concepts/authentication.md
+10-15Lines changed: 10 additions & 15 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
2
title: Authenticate to Azure Communication Services
3
-
titleSuffix: An Azure Communication Services concept document
4
-
description: Learn about the various ways an app or service can authenticate to Communication Services.
3
+
titleSuffix: An Azure Communication Services article
4
+
description: This article describes how you can use an app or service to authenticate to Communication Services.
5
5
author: tophpalmer
6
6
7
7
manager: chpalm
@@ -34,15 +34,15 @@ The following table shows the Azure Communication Services SDKs and their authen
34
34
| Calling | User Access Token |
35
35
| Chat | User Access Token |
36
36
37
-
Each authorization option is briefly described below:
37
+
Each authorization option is briefly described as follows:
38
38
39
39
### Access Key
40
40
41
-
Access key authentication is suitable for service applications running in a trusted service environment. Your access key can be found in the Azure Communication Services portal. The service application uses it as a credential to initialize the corresponding SDKs. See an example of how it is used in the [Identity SDK](../quickstarts/identity/access-tokens.md).
41
+
Access key authentication is suitable for service applications running in a trusted service environment. Your access key can be found in the Azure Communication Services portal. The service application uses it as a credential to initialize the corresponding SDKs. See an example of how it's used in the [Identity SDK](../quickstarts/identity/access-tokens.md).
42
42
43
43
Since the access key is part of the connection string of your resource, authentication with a connection string is equivalent to authentication with an access key.
44
44
45
-
If you wish to call Azure Communication Services' APIs manually using an access key, then you will need to sign the request. Signing the request is explained, in detail, within a [tutorial](../tutorials/hmac-header-tutorial.md).
45
+
If you wish to call Azure Communication Services' APIs manually using an access key, then you need to sign the request. Signing the request is explained, in detail, within a [tutorial](../tutorials/hmac-header-tutorial.md).
46
46
47
47
<aname='azure-ad-authentication'></a>
48
48
@@ -52,23 +52,17 @@ To set up a service principal, [create a registered application from the Azure C
52
52
53
53
Communication services supports Microsoft Entra ID authentication for Communication services resources. You can find more details, about the managed identity support in the [How to use Managed Identity with Azure Communication Services](/azure/communication-services/how-tos/managed-identity).
54
54
55
-
56
-
57
-
58
-
59
55
### Microsoft Entra ID Authentication
60
56
61
57
The Azure platform provides role-based access (Azure RBAC) to control access to resources. Azure RBAC security principal represents a user, group, service principal, or managed identity that is requesting access to Azure resources. Microsoft Entra ID authentication provides superior security and ease of use over other authorization options.
62
58
63
59
-**Managed Identity:**
64
60
- By using managed identity, you avoid having to store your account access key within your code, as you do with Access Key authorization. Managed identity credentials are fully managed, rotated, and protected by the platform, reducing the risk of credential exposure.
65
61
- Managed identities can authenticate to Azure services and resources that support Microsoft Entra ID authentication. This method provides a seamless and secure way to manage credentials.
66
-
- For more information on how to use Managed Identity with Azure Communication Services, refer to [This Guide](/azure/communication-services/how-tos/managed-identity).
67
-
68
-
62
+
- For more information about using Managed Identity with Azure Communication Services, see [Managed Identity](../how-tos/managed-identity.md).
69
63
70
64
-**Service Principal:**
71
-
- To set up a service principal [create a registered application from the Azure CLI](../quickstarts/identity/service-principal.md?pivots=platform-azcli). Then, the endpoint and credentials can be used to authenticate the SDKs.
65
+
- To set up a service principal [create a registered application from the Azure CLI](../quickstarts/identity/service-principal.md?pivots=platform-azcli). Then, you can use the endpoint and credentials to authenticate the SDKs.
72
66
- See examples of how [service principal](../quickstarts/identity/service-principal.md) is used.
73
67
74
68
Communication Services supports Microsoft Entra ID authentication for Communication Services resources, While you can continue to use Access Key authorization with communication services applications, Microsoft recommends moving to Microsoft Entra ID where possible.
@@ -78,7 +72,7 @@ Use our [Trusted authentication service hero sample](../samples/trusted-auth-sam
78
72
79
73
### User Access Tokens
80
74
81
-
User access tokens are generated using the Identity SDK and are associated with users created in the Identity SDK. See an example of how to [create users and generate tokens](../quickstarts/identity/access-tokens.md). Then, user access tokens are used to authenticate participants added to conversations in the Chat or Calling SDK. For more information, see [add chat to your app](../quickstarts/chat/get-started.md). User access token authentication is different compared to access key and Microsoft Entra authentication in that it is used to authenticate a user rather than a secured Azure resource.
75
+
User access tokens are generated using the Identity SDK and are associated with users created in the Identity SDK. See an example of how to [create users and generate tokens](../quickstarts/identity/access-tokens.md). Then, user access tokens are used to authenticate participants added to conversations in the Chat or Calling SDK. For more information, see [add chat to your app](../quickstarts/chat/get-started.md). User access token authentication is different compared to access key and Microsoft Entra authentication in that it's used to authenticate a user rather than a secured Azure resource.
82
76
83
77
## Using identity for monitoring and metrics
84
78
@@ -98,5 +92,6 @@ The user identity is intended to act as a primary key for logs and metrics colle
98
92
> [!div class="nextstepaction"]
99
93
> [Trusted authentication service hero sample](../samples/trusted-auth-sample.md)
100
94
101
-
For more information, see the following articles:
95
+
## Related articles
96
+
102
97
-[Learn about client and server architecture](../concepts/identity-model.md#client-server-architecture)
You can choose between indefinite thread retention, automatic deletion between 30 and 90 days via the retention policy on the [Create Chat Thread API](/rest/api/communication/chat/chat/create-chat-thread), or immediate deletion using the APIs [Delete Chat Message](/rest/api/communication/chat/chat-thread/delete-chat-message) or [Delete Chat Thread](/rest/api/communication/chat/chat/delete-chat-thread).
46
+
You can choose between:
47
+
- Indefinite thread retention.
48
+
- Automatic deletion between 30 and 90 days via the retention policy on the [Create Chat Thread API](/rest/api/communication/chat/chat/create-chat-thread).
49
+
- Immediate deletion using the APIs [Delete Chat Message](/rest/api/communication/chat/chat-thread/delete-chat-message) or [Delete Chat Thread](/rest/api/communication/chat/chat/delete-chat-thread).
47
50
48
51
Any thread created before the new retention policy isn't affected unless you specifically change the policy for that thread. If you submit a support request for a deleted chat thread more than 30 days after the retention policy deleted that thread, it can no longer be retrieved and no information about that thread is available. If needed, [open a support ticket](/azure/azure-portal/supportability/how-to-create-azure-support-request) as quickly as possible within the 30 day window after you create a thread so we can assist you.
49
52
@@ -110,7 +113,7 @@ The client app can subscribe to following events:
110
113
-`chatMessageEdited` - when a message is edited in a chat thread.
111
114
-`chatMessageDeleted` - when a message is deleted in a chat thread.
112
115
-`typingIndicatorReceived` - when another participant sends a typing indicator to the chat thread.
113
-
-`readReceiptReceived` - when another participant sends a read receipt for a message they have read.
116
+
-`readReceiptReceived` - when another participant sends a read receipt for a message they read.
114
117
-`chatThreadCreated` - when a Communication Services user creates a chat thread.
115
118
-`chatThreadDeleted` - when a Communication Services user deletes a chat thread.
116
119
-`chatThreadPropertiesUpdated` - when chat thread properties are updated; currently, only updating the topic for the thread is supported.
@@ -120,7 +123,7 @@ The client app can subscribe to following events:
120
123
-`realTimeNotificationDisconnected` -when real time notification is disconnected.
121
124
122
125
> [!NOTE]
123
-
> Real time notifications are not to be used with server applications.
126
+
> Do not use real-time notifications with server applications.
124
127
125
128
## Server events
126
129
@@ -155,6 +158,6 @@ For more information, see [Push Notifications](../notifications.md).
155
158
156
159
## Related articles
157
160
158
-
- Familiarize yourself with the [Chat SDK](./sdk-features.md)
159
-
- Access control for participants on a thread using [Identity and Tokens](../identity-model.md)
160
-
- Build an application or a mobile app with [UI Library](../ui-library/ui-library-overview.md)
161
+
- Familiarize yourself with the [Chat SDK](./sdk-features.md).
162
+
- Access control for participants on a thread using [Identity and Tokens](../identity-model.md).
163
+
- Build an application or a mobile app with [UI Library](../ui-library/ui-library-overview.md).
The following table show supported use cases for Gov Cloud user with Azure Communication Services:
26
+
The following table shows supported use cases for Government Community Cloud (GCC) user with Azure Communication Services:
26
27
27
28
| Scenario | Supported |
28
29
| --- | --- |
29
30
| 1:1 Chat | ✔️ |
30
31
| Group Chat | ✔️ |
31
32
32
-
Azure Communication Chat service also allows connecting to Microsoft 365 cloud that meets government security and compliance requirements for Teams Interoperability [scenarios](../interop/guest/government-cloud.md).
33
+
Azure Communication Chat service also enables connecting to Microsoft 365 cloud that meets government security and compliance requirements for Teams Interoperability [scenarios](../interop/guest/government-cloud.md).
0 commit comments