Skip to content

Commit 1b19500

Browse files
authored
Merge pull request #289550 from fangchen0601/fangchen0601/callback
[ACS][CallAutomation]Add new metric for call automation callback event
2 parents 08c1ad5 + 3784532 commit 1b19500

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

articles/communication-services/concepts/analytics/logs/call-automation-metrics.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,26 @@ Azure Communication Services currently provides metrics for all Communication Se
1616

1717
## Where to find metrics
1818

19-
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.
19+
Primitives in Communication Services emit metrics for API requests and callback events. 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.
2020

2121
## Metric definitions
2222

23-
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`.
24-
25-
For more information on supported aggregation types and time series aggregations, see [Advanced features of Azure Metrics Explorer](/azure/azure-monitor/essentials/metrics-charts#aggregation).
26-
27-
- **Operation**: All operations or routes that can be called on the Communication Services Chat gateway.
23+
All API request metrics contain three dimensions that you can use to filter your metrics data.
24+
- **Operation**: All operations or routes that can be called on the Communication Services CallAutomation.
2825
- **Status Code**: The status code response sent after the request.
2926
- **StatusSubClass**: The status code series sent after the response.
3027

28+
APIs like [Call Automation](../../../concepts/call-automation/call-automation.md), used to program calling workflows, work with async operations in an action-event driven programming model. In this case, an API request results in a response indicating whether your request was accepted and later a webhook event, published to callback URI you specify. These webhook events are published after the request processed and contain info on result of the action. For example: AddPArticipant API results in an API response and later an AddParticipantSucceeded or AddParticipantFailed event. Developers can use the metric for these events to monitor and raise alerts for failing scenarios. The metric can be filtered on following dimensions:
29+
- **EventTypeName**: The callback event type name.
30+
- **Code**: The status code of the callback event.
31+
- **CodeClass**: The status code series of the callback event.
32+
- **SubCode**: The sub code of the callback event.
33+
- **Version**: The version of the callback event.
34+
35+
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`.
36+
37+
For more information on supported aggregation types and time series aggregations, see [Advanced features of Azure Metrics Explorer](/azure/azure-monitor/essentials/metrics-charts#aggregation).
38+
3139
### Call Automation API requests
3240

3341
The following operations are available on Call Automation API request metrics.
@@ -52,6 +60,14 @@ The following operations are available on Call Automation API request metrics.
5260
| Delete Call | Delete a call. |
5361
| Cancel All Media Operations | Cancel all ongoing or queued media operations in a call. |
5462

63+
### Call Automation Callback Event
64+
65+
The following event type names are available on Call Automation Callback Event metrics.
66+
Refer to [here](../../../concepts/call-automation/call-automation.md#call-automation-webhook-events) for the list of callback event types covered by this metric.
67+
68+
The Code and SubCode values within the ResultInformation of a callback event indicate the status of an operation. These values are identical and can be used to determine the reason for an event, such as a call being disconnected. For details on specific disconnection reasons, refer to the list of codes provided at [Call end troubleshooting codes](../../../resources/troubleshooting/voice-video-calling/troubleshooting-codes.md?pivots=callend).
69+
70+
5571
## Next steps
5672

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

0 commit comments

Comments
 (0)