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/logging-and-diagnostics.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,11 @@ Azure Communication Services offers logging capabilities that you can use to mon
22
22
23
23
## Enable diagnostic logs in your resource
24
24
25
-
Logging is turned off by default when a resource is created. To enable logging, navigate to the **Diagnostic settings**blade in the resource menu under the **Monitoring** section. Then click on**Add diagnostic setting**.
25
+
Logging is turned off by default when a resource is created. To enable logging, navigate to the **Diagnostic settings**tab in the resource menu under the **Monitoring** section. Then select**Add diagnostic setting**.
26
26
27
27
Next, select the archive target you want. Currently, we support storage accounts and Log Analytics as archive targets. After selecting the types of logs that you'd like to capture, save the diagnostic settings.
28
28
29
-
New settings take effect in about ten minutes. Logs will begin appearing in the configured archival target within the Logs pane of your Communication Services resource.
29
+
New settings take effect in about 10 minutes. Logs will begin appearing in the configured archival target within the Logs pane of your Communication Services resource.
30
30
31
31
:::image type="content" source="./media/diagnostic-settings.png" alt-text="Azure Communication Services Diagnostic Settings Options.":::
32
32
@@ -44,15 +44,15 @@ Communication Services offers the following types of logs that you can enable:
44
44
***Email Send Mail operational logs** - provides detailed information related to the Email service send mail requests.
45
45
***Email Status Update operational logs** - provides message and recipient level delivery status updates related to the Email service send mail requests.
46
46
***Email User Engagement operational logs** - provides information related to 'open' and 'click' user engagement metrics for messages sent from the Email service.
47
-
***Call Automation operational logs** - provides operational information on Call Automation API requests. These logs can be used to identify failure points, query all requests made in a call (using Correlation ID or Server Call ID) or query all requests made by a specific service application in the call (using PArticipant ID).
47
+
***Call Automation operational logs** - provides operational information on Call Automation API requests. These logs can be used to identify failure points, query all requests made in a call (using Correlation ID or Server Call ID) or query all requests made by a specific service application in the call (using Participant ID).
48
48
49
49
### Usage logs schema
50
50
51
51
| Property | Description |
52
52
| -------- | ---------------|
53
53
| Timestamp | The timestamp (UTC) of when the log was generated. |
54
54
| Operation Name | The operation associated with log record. |
55
-
| Operation Version | The `api-version` associated with the operation, if the operationName was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
55
+
| Operation Version | The `api-version` associated with the operation, if the operationName was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
56
56
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
57
57
| Correlation ID | The ID for correlated events. Can be used to identify correlated events between multiple tables. |
58
58
| Properties | Other data applicable to various modes of Communication Services. |
@@ -68,7 +68,7 @@ Communication Services offers the following types of logs that you can enable:
68
68
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
69
69
| OperationName | The operation associated with log record. |
70
70
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. |
71
-
| OperationVersion | The api-version associated with the operation, if the operationName was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
71
+
| OperationVersion | The api-version associated with the operation, if the operationName was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
72
72
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
73
73
| ResultType | The status of the operation. |
74
74
| ResultSignature | The sub status of the operation. If this operation corresponds to a REST API call, this field is the HTTP status code of the corresponding REST call. |
@@ -90,7 +90,7 @@ Communication Services offers the following types of logs that you can enable:
90
90
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
91
91
| OperationName | The operation associated with log record. |
92
92
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. |
93
-
| OperationVersion | The api-version associated with the operation, if the operationName was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
93
+
| OperationVersion | The api-version associated with the operation, if the operationName was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
94
94
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
95
95
| ResultType | The status of the operation. |
96
96
| ResultSignature | The sub status of the operation. If this operation corresponds to a REST API call, this field is the HTTP status code of the corresponding REST call. |
@@ -115,7 +115,7 @@ Communication Services offers the following types of logs that you can enable:
115
115
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
116
116
| OperationName | The operation associated with log record. |
117
117
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. |
118
-
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
118
+
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
119
119
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
120
120
| ResultType | The status of the operation. |
121
121
| ResultSignature | The sub-status of the operation. If this operation corresponds to a REST API call, this field is the HTTP status code of the corresponding REST call. |
@@ -135,17 +135,17 @@ Communication Services offers the following types of logs that you can enable:
135
135
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
136
136
| OperationName | The operation associated with log record. |
137
137
| CorrelationId | The ID for correlated events. Can be used to identify correlated events between multiple tables. |
138
-
| OperationVersion | The API-version associated with the operation or version of the operation (if there is no API version). |
138
+
| OperationVersion | The API-version associated with the operation or version of the operation (if there's no API version). |
139
139
| Category | The log category of the event. Logs with the same log category and resource type will have the same properties fields. |
140
-
| ResultType | The status of the operation (e.g. Succeeded or Failed). |
140
+
| ResultType | The status of the operation (for example, Succeeded or Failed). |
141
141
| ResultSignature | The sub status of the operation. If this operation corresponds to a REST API call, this field is the HTTP status code of the corresponding REST call. |
142
142
| DurationMs | The duration of the operation in milliseconds. |
143
143
| Level | The severity level of the operation. |
144
144
| URI | The URI of the request. |
145
145
| Identity | The request sender's identity, if provided. |
146
146
| SdkType | The SDK type being used in the request. |
147
147
| PlatformType | The platform type being used in the request. |
148
-
| RouteType | The routing methodology to where the ICE server will be located from the client (e.g. Any or Nearest). |
148
+
| RouteType | The routing methodology to where the ICE server will be located from the client (for example, Any or Nearest). |
149
149
150
150
151
151
### Email Send Mail operational logs
@@ -155,9 +155,9 @@ Communication Services offers the following types of logs that you can enable:
155
155
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
156
156
| Location | The region where the operation was processed. |
157
157
| OperationName | The operation associated with log record. |
158
-
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
158
+
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
159
159
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
160
-
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. For all Email operational logs, the CorrelationId is mapped to the MessageId which is returned from a successful SendMail request. |
160
+
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. For all Email operational logs, the CorrelationId is mapped to the MessageId, which is returned from a successful SendMail request. |
161
161
| Size | Represents the total size in megabytes of the email body, subject, headers and attachments. |
162
162
| ToRecipientsCount | The total # of unique email addresses on the To line. |
163
163
| CcRecipientsCount | The total # of unique email addresses on the Cc line. |
@@ -173,9 +173,9 @@ Communication Services offers the following types of logs that you can enable:
173
173
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
174
174
| Location | The region where the operation was processed. |
175
175
| OperationName | The operation associated with log record. |
176
-
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
176
+
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
177
177
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
178
-
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. For all Email operational logs, the CorrelationId is mapped to the MessageId which is returned from a successful SendMail request. |
178
+
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. For all Email operational logs, the CorrelationId is mapped to the MessageId, which is returned from a successful SendMail request. |
179
179
| RecipientId | The email address for the targeted recipient. If this is a message-level event, the property will be empty. |
180
180
| DeliveryStatus | The terminal status of the message. |
181
181
@@ -186,9 +186,9 @@ Communication Services offers the following types of logs that you can enable:
186
186
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
187
187
| Location | The region where the operation was processed. |
188
188
| OperationName | The operation associated with log record. |
189
-
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
189
+
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
190
190
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
191
-
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. For all Email operational logs, the CorrelationId is mapped to the MessageId which is returned from a successful SendMail request. |
191
+
| CorrelationID | The ID for correlated events. Can be used to identify correlated events between multiple tables. For all Email operational logs, the CorrelationId is mapped to the MessageId, which is returned from a successful SendMail request. |
192
192
| RecipientId | The email address for the targeted recipient. If this is a message-level event, the property will be empty. |
193
193
| EngagementType | The type of user engagement being tracked. |
194
194
| EngagementContext | The context represents what the user interacted with. |
@@ -202,7 +202,7 @@ Communication Services offers the following types of logs that you can enable:
202
202
| TimeGenerated | The timestamp (UTC) of when the log was generated. |
203
203
| OperationName | The operation associated with log record. |
204
204
| CorrelationID | The identifier to identify a call and correlate events for a unique call. |
205
-
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there is no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
205
+
| OperationVersion | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
206
206
| Category | The log category of the event. Category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
207
207
| ResultType | The status of the operation. |
208
208
| ResultSignature | The sub status of the operation. If this operation corresponds to a REST API call, this field is the HTTP status code of the corresponding REST call. |
Copy file name to clipboardExpand all lines: articles/communication-services/concepts/metrics.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Azure Communication Services currently provides metrics for all ACS primitives.
18
18
19
19
## Where to find metrics
20
20
21
-
Primitives in Azure Communication Services emit metrics for API requests. These metrics can be found in the Metrics blade under your Communication Services resource. You can also create permanent dashboards using the workbooks blade under your Communication Services resource.
21
+
Primitives in Azure Communication Services emit metrics for API requests. These metrics can be found in the Metrics tab under your Communication Services resource. You can also create permanent dashboards using the workbooks tab under your Communication Services resource.
22
22
23
23
## Metric definitions
24
24
@@ -100,15 +100,15 @@ The following operations are available on Call Automation API request metrics:
100
100
| Transfer Call To Participant | Transfer 1:1 call to another user. |
101
101
| Play | Play audio to call participants. |
102
102
| Recognize | Recognize user input from call participants. |
103
-
| Add Participants | Add a aprticipant to a call. |
103
+
| Add Participants | Add a participant to a call. |
104
104
| Remove Participants | Remove a participant from a call. |
105
105
| HangUp Call | Hang up your call leg. |
106
106
| Terminate Call | End the call for all participants. |
107
107
| Get Call | Get details about a call. |
108
108
| Get Participant | Get details on a call participant. |
109
109
| Get Participants | Get all participants in a call. |
110
110
| Delete Call | Delete a call. |
111
-
| Cancel All Media Operations |Call all ongoing or queued media operations in a call. |
111
+
| Cancel All Media Operations |Cancel all ongoing or queued media operations in a call. |
0 commit comments