Skip to content

Commit 6a415c9

Browse files
author
Jill Grant
authored
Merge pull request #281272 from memontic-ms/memontic/acs-cpm-metrics-and-logs
Add details for ACS Advanced Messaging metrics and logging
2 parents 06d2013 + 7c601b1 commit 6a415c9

File tree

5 files changed

+133
-37
lines changed

5 files changed

+133
-37
lines changed

‎articles/communication-services/concepts/advanced-messaging/logs.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Azure Communication Services Advanced Messaging logs
3+
titleSuffix: An Azure Communication Services concept document
4+
description: Learn about logging for Azure Communication Services Advanced Messaging.
5+
author: memontic-ms
6+
services: azure-communication-services
7+
ms.author: memontic
8+
ms.date: 07/18/2024
9+
ms.topic: conceptual
10+
ms.service: azure-communication-services
11+
---
12+
13+
# Advanced Messaging logs
14+
15+
Azure Communication Services offers logging capabilities that you can use to monitor and debug your Communication Services solution. These capabilities can be configured for Advanced Messaging through the Azure portal by enabling the diagnostic setting for `Advanced Messaging Logs`.
16+
17+
> [!IMPORTANT]
18+
> The following refers to logs enabled through [Azure Monitor](../../../azure-monitor/overview.md) (see also [FAQ](../../../azure-monitor/overview.md#frequently-asked-questions)). To enable these logs for your Communications Services, see: [Enable logging in Diagnostic Settings](../analytics/enable-logging.md)
19+
20+
## ACSAdvancedMessagingOperations
21+
22+
To view the table definition, see [Log Analytics table ACSAdvancedMessagingOperations](/azure/azure-monitor/reference/tables/ACSAdvancedMessagingOperations).

‎articles/communication-services/concepts/advanced-messaging/metrics.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Advanced Messaging metrics definitions for Azure Communication Service
3+
titleSuffix: An Azure Communication Services concept document
4+
description: This document covers definitions of Advanced Messaging metrics available in the Azure portal.
5+
author: memontic-ms
6+
services: azure-communication-services
7+
ms.author: memontic
8+
ms.date: 07/18/2024
9+
ms.topic: conceptual
10+
ms.service: azure-communication-services
11+
---
12+
13+
# Advanced Messaging metrics overview
14+
15+
Azure Communication Services currently provides metrics for all Communication Services primitives. You can use [Azure Monitor metrics explorer](../../../azure-monitor/essentials/analyze-metrics.md) to:
16+
17+
- Plot your own charts.
18+
- Investigate abnormalities in your metric values.
19+
- Understand your API traffic by using the metrics data that Advanced Messaging requests emit.
20+
21+
## Where to find metrics
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.
24+
25+
## Metric definitions
26+
27+
All API request metrics contain three dimensions that you can use to filter your metrics data. These dimensions can be aggregated together by using the `Count` aggregation type. They support all standard Azure Aggregation time series, including `Sum`, `Average`, `Min`, and `Max`.
28+
29+
For more information on supported aggregation types and time series aggregations, see [Azure Monitor Metrics aggregation and display explained](./../../../azure-monitor/essentials/metrics-aggregation-explained.md).
30+
31+
- **Operation**: All operations or routes that can be called on the Azure Communication Services Advanced Messaging gateway.
32+
- **Status Code**: The status code response sent after the request.
33+
- **StatusSubClass**: The status code series sent after the response.
34+
35+
For the complete list of all metrics emitted by Azure Communication Services, see [Metrics overview](./../metrics.md) or the reference documentation [Supported metrics for Microsoft.Communication/CommunicationServices](/azure/azure-monitor/reference/supported-metrics/microsoft-communication-communicationservices-metrics).
36+
37+
### Advanced Messaging API requests
38+
39+
The following operations are available on Advanced Messaging API request metrics:
40+
41+
| Operation / Route | Description | Scenario |
42+
|---------------------------|------------------------------------|-------------------------------------------------------------------------------------------|
43+
| DownloadMedia | Download media payload request. | Business requested to download media payload. |
44+
| ListTemplates | List templates request. | Business requested to list templates for a given channel. |
45+
| ReceiveMessage | Message received. | User sent a message to the business. |
46+
| SendMessage | Send message notification request. | Business requesting to send a message to the user. |
47+
| SendMessageDeliveryStatus | Delivery status received. | Business received response about a message that the business requested to send to a user. |
48+
49+
:::image type="content" source="./../media/acs-advanced-messaging-metrics.png" alt-text="Screenshot of Advanced Messaging request metric." lightbox="./../media/acs-advanced-messaging-metrics.png":::

‎articles/communication-services/concepts/media/acs-advanced-messaging-metrics.png

34.6 KB
Loading

‎articles/communication-services/concepts/metrics.md

Lines changed: 51 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ author: mkhribech
66
services: azure-communication-services
77

88
ms.author: mkhribech
9-
ms.date: 06/30/2023
9+
ms.date: 07/18/2024
1010
ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
ms.subservice: data
1313
---
14+
1415
# Metrics overview
1516

1617
Azure Communication Services currently provides metrics for all Azure communication services' primitives. [Azure Metrics Explorer](../../azure-monitor/essentials/metrics-getting-started.md) can be used to plot your own charts, investigate abnormalities in your metric values, and understand your API traffic by using the metrics data that email requests emit.
@@ -29,44 +30,19 @@ More information on supported aggregation types and time series aggregations can
2930
- **Status Code** - The status code response sent after the request.
3031
- **StatusSubClass** - The status code series sent after the response.
3132

32-
### Chat API request metric operations
33-
34-
The following operations are available on Chat API request metrics:
35-
36-
| Operation / Route | Description |
37-
| -------------------- | ---------------------------------------------------------------------------------------------- |
38-
| GetChatMessage | Gets a message by message ID. |
39-
| ListChatMessages | Gets a list of chat messages from a thread. |
40-
| SendChatMessage | Sends a chat message to a thread. |
41-
| UpdateChatMessage | Updates a chat message. |
42-
| DeleteChatMessage | Deletes a chat message. |
43-
| GetChatThread | Gets a chat thread. |
44-
| ListChatThreads | Gets the list of chat threads of a user. |
45-
| UpdateChatThread | Updates a chat thread's properties. |
46-
| CreateChatThread | Creates a chat thread. |
47-
| DeleteChatThread | Deletes a thread. |
48-
| GetReadReceipts | Gets read receipts for a thread. |
49-
| SendReadReceipt | Sends a read receipt event to a thread, on behalf of a user. |
50-
| SendTypingIndicator | Posts a typing event to a thread, on behalf of a user. |
51-
| ListChatThreadParticipants | Gets the members of a thread. |
52-
| AddChatThreadParticipants | Adds thread members to a thread. If members already exist, no change occurs. |
53-
| RemoveChatThreadParticipant | Remove a member from a thread. |
54-
55-
:::image type="content" source="./media/chat-metric.png" alt-text="Screenshot of Chat API Request Metric." lightbox="./media/chat-metric.png":::
33+
### Advanced Messaging API requests
5634

57-
If a request is made to an operation that isn't recognized, you receive a "Bad Route" value response.
35+
The following operations are available on Advanced Messaging API request metrics:
5836

59-
### SMS API requests
37+
| Operation / Route | Description | Scenario |
38+
|---------------------------|------------------------------------|-------------------------------------------------------------------------------------------|
39+
| DownloadMedia | Download media payload request. | Business requested to download media payload. |
40+
| ListTemplates | List templates request. | Business requested to list templates for a given channel. |
41+
| ReceiveMessage | Message received. | User sent a message to the business. |
42+
| SendMessage | Send message notification request. | Business requesting to send a message to the user. |
43+
| SendMessageDeliveryStatus | Delivery status received. | Business received response about a message that the business requested to send to a user. |
6044

61-
The following operations are available on SMS API request metrics:
62-
63-
| Operation / Route | Description |
64-
| -------------------- | ---------------------------------------------------------------------------------------------- |
65-
| SMSMessageSent | Sends an SMS message. |
66-
| SMSDeliveryReportsReceived | Gets SMS Delivery Reports |
67-
| SMSMessagesReceived | Gets SMS messages. |
68-
69-
:::image type="content" source="./media/sms-metric.png" alt-text="Screenshot of SMS API Request Metric." lightbox="./media/sms-metric.png":::
45+
:::image type="content" source="./media/acs-advanced-messaging-metrics.png" alt-text="Screenshot of Advanced Messaging request metric." lightbox="./media/acs-advanced-messaging-metrics.png":::
7046

7147
### Authentication API requests
7248

@@ -106,6 +82,33 @@ The following operations are available on Call Automation API request metrics:
10682
| Delete Call | Delete a call. |
10783
| Cancel All Media Operations | Cancel all ongoing or queued media operations in a call. |
10884

85+
### Chat API request metric operations
86+
87+
The following operations are available on Chat API request metrics:
88+
89+
| Operation / Route | Description |
90+
| -------------------- | ---------------------------------------------------------------------------------------------- |
91+
| GetChatMessage | Gets a message by message ID. |
92+
| ListChatMessages | Gets a list of chat messages from a thread. |
93+
| SendChatMessage | Sends a chat message to a thread. |
94+
| UpdateChatMessage | Updates a chat message. |
95+
| DeleteChatMessage | Deletes a chat message. |
96+
| GetChatThread | Gets a chat thread. |
97+
| ListChatThreads | Gets the list of chat threads of a user. |
98+
| UpdateChatThread | Updates a chat thread's properties. |
99+
| CreateChatThread | Creates a chat thread. |
100+
| DeleteChatThread | Deletes a thread. |
101+
| GetReadReceipts | Gets read receipts for a thread. |
102+
| SendReadReceipt | Sends a read receipt event to a thread, on behalf of a user. |
103+
| SendTypingIndicator | Posts a typing event to a thread, on behalf of a user. |
104+
| ListChatThreadParticipants | Gets the members of a thread. |
105+
| AddChatThreadParticipants | Adds thread members to a thread. If members already exist, no change occurs. |
106+
| RemoveChatThreadParticipant | Remove a member from a thread. |
107+
108+
:::image type="content" source="./media/chat-metric.png" alt-text="Screenshot of Chat API Request Metric." lightbox="./media/chat-metric.png":::
109+
110+
If a request is made to an operation that isn't recognized, you receive a "Bad Route" value response.
111+
109112
### Job Router API requests
110113

111114
The following operations are available on Job Router API request metrics:
@@ -172,6 +175,18 @@ The following operations are available on Rooms API request metrics:
172175

173176
:::image type="content" source="./media/rooms/rooms-metrics.png" alt-text="Screenshot of Rooms Request Metric." lightbox="./media/rooms/rooms-metrics.png":::
174177

178+
### SMS API requests
179+
180+
The following operations are available on SMS API request metrics:
181+
182+
| Operation / Route | Description |
183+
| -------------------- | ---------------------------------------------------------------------------------------------- |
184+
| SMSMessageSent | Sends an SMS message. |
185+
| SMSDeliveryReportsReceived | Gets SMS Delivery Reports |
186+
| SMSMessagesReceived | Gets SMS messages. |
187+
188+
:::image type="content" source="./media/sms-metric.png" alt-text="Screenshot of SMS API Request Metric." lightbox="./media/sms-metric.png":::
189+
175190
## Next steps
176191

177192
- Learn more about [Data Platform Metrics](../../azure-monitor/essentials/data-platform-metrics.md)

‎articles/communication-services/toc.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1047,6 +1047,12 @@ items:
10471047
href: concepts/sms/messaging-policy.md
10481048
- name: Pricing
10491049
href: concepts/advanced-messaging/whatsapp/pricing.md
1050+
- name: Analytics
1051+
items:
1052+
- name: Metrics
1053+
href: concepts/advanced-messaging/metrics.md
1054+
- name: Logs
1055+
href: concepts/advanced-messaging/logs.md
10501056
- name: Events
10511057
items:
10521058
- name: Overview
@@ -1056,7 +1062,11 @@ items:
10561062
- name: Templates
10571063
href: concepts/advanced-messaging/whatsapp/template-messages.md
10581064
- name: Azure Advisor
1059-
href: concepts/advisor-overview.md
1065+
items:
1066+
- name: Overview
1067+
href: concepts/advisor-overview.md
1068+
- name: Metrics
1069+
href: concepts/metrics.md
10601070
- name: Resources
10611071
items:
10621072
- name: Release notes

0 commit comments

Comments
 (0)