Skip to content

Commit c00e8ea

Browse files
authored
reworded the doc for easier readability
1 parent 50baefc commit c00e8ea

File tree

1 file changed

+16
-35
lines changed

1 file changed

+16
-35
lines changed

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

Lines changed: 16 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -20,52 +20,33 @@ Primitives in Communication Services emit metrics for API requests and callback
2020

2121
## Metric definitions
2222

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.
25-
- **Status Code**: The status code response sent after the request.
26-
- **StatusSubClass**: The status code series sent after the response.
23+
Call Automation operates on asynchronous operations in an action-event driven programming model. An API request results in an immediate response indicating whether the request was accepted. Subsequently, a webhook event is published to a callback URI that you specify. These webhook events are triggered after the request has been processed and contains information about the outcome of the action. For instance, the AddParticipant API will return an initial response and later trigger either an AddParticipantSucceeded or AddParticipantFailed event.
2724

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.
25+
Call Automation publishes metrics for both the API request/response and the corresponding webhook events for developers to monitor the API health and configure alerts for failing scenarios.
3426

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`.
27+
This document describes the two metrics and various dimensions you can use to fiter 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`.
3628

3729
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).
3830

3931
### Call Automation API requests
4032

41-
The following operations are available on Call Automation API request metrics.
42-
43-
| Operation/Route | Description |
44-
| -------------------- | ---------------------------------------------------------------------------------------------- |
45-
| Create Call | Create an outbound call to user.
46-
| Answer Call | Answer an inbound call. |
47-
| Redirect Call | Redirect an inbound call to another user. |
48-
| Reject Call | Reject an inbound call. |
49-
| Transfer Call To Participant | Transfer 1:1 call to another user. |
50-
| Play | Play audio to call participants. |
51-
| PlayPrompt | Play a prompt to users as part of the Recognize action. |
52-
| Recognize | Recognize user input from call participants. |
53-
| Add Participants | Add a participant to a call. |
54-
| Remove Participants | Remove a participant from a call. |
55-
| HangUp Call | Hang up your call leg. |
56-
| Terminate Call | End the call for all participants. |
57-
| Get Call | Get details about a call. |
58-
| Get Participant | Get details on a call participant. |
59-
| Get Participants | Get all participants in a call. |
60-
| Delete Call | Delete a call. |
61-
| Cancel All Media Operations | Cancel all ongoing or queued media operations in a call. |
33+
API request metric is published for all generally available [operations](../../../concepts/call-automation/call-automation.md#call-actions). This metric contains three dimensions that you can use to filter your metrics data.
34+
- **Operation**: All operations or routes that can be called on Call Automation.
35+
- **Status Code**: The status code response sent for this request.
36+
- **StatusSubClass**: The status code series.
6237

6338
### Call Automation Callback Event
6439

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.
40+
Refer to [list](../../../concepts/call-automation/call-automation.md#call-automation-webhook-events) of all the callback event types covered by this metric.
6741

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).
42+
The metric can be filtered on following dimensions:
43+
- **EventTypeName**: The callback event type name.
44+
- **Code**: The status code of the callback event.
45+
- **CodeClass**: The status code series of the callback event.
46+
- **SubCode**: The sub code of the callback event.
47+
- **Version**: The version of the callback event.
48+
49+
The Code and SubCode values are published in the metric as well as the callback event published to your callback URI. These values can be used to determine the reason for an event, such as a call being disconnected. For more details on codes published and what they mean, refer to [troubleshooting guide](../../../resources/troubleshooting/voice-video-calling/troubleshooting-codes.md).
6950

7051

7152
## Next steps

0 commit comments

Comments
 (0)