Skip to content

Commit 3c05a5e

Browse files
authored
Update monitor-event-hubs-reference.md
Updating event Hubs monitoring reference with Diagnostic Error logs
1 parent ea2f919 commit 3c05a5e

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

articles/event-hubs/monitor-event-hubs-reference.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,63 @@ Name | Description
179179
`OffsetCommit` | Number of offset commit calls made to the event hub
180180
`OffsetFetch` | Number of offset fetch calls made to the event hub.
181181

182+
## Diagnostic Error Logs
183+
Diagnostic error logs capture error messages for any client side, throttling and Quota exceeded errors. They provide detailed diagnostics for error identification.
184+
185+
Diagnostic Error Logs include elements listed in below table:
186+
187+
Name | Description | Supported in Azure Diagnostics | Supported in AZMSDiagnosticErrorLogs (Resource specific table)
188+
---|---|---|---|
189+
`ActivityId` | A randomly generated UUID that ensures uniqueness for the audit activity. | Yes | Yes
190+
`ActivityName` | Operation name | Yes | Yes
191+
`NamespaceName` | Name of Namespace | Yes | yes
192+
`EntityType` | Type of Entity | Yes | Yes
193+
`EntityName` | Name of Entity | Yes | Yes
194+
`OperationResult` | Type of error in Operation (Clienterror or Serverbusy or quotaexceeded) | Yes | Yes
195+
`ErrorCount` | Count of identical errors during the aggregation period of 1 minute. | Yes | Yes
196+
`ErrorMessage` | Detailed Error Message | Yes | Yes
197+
`ResourceProvider` | Name of Service emitting the logs. Possible values: Microsoft.Eventhub and Microsoft.Servicebus | Yes | Yes
198+
`Time Generated (UTC)` | Operation time | No | Yes
199+
`EventTimestamp` | Operation Time | Yes | No
200+
`Category` | Log category | Yes | No
201+
`Type` | Type of Logs emitted | No | Yes
202+
203+
Here's an example of Diagnostic error log entry:
204+
205+
```json
206+
{
207+
"ActivityId": "0000000000-0000-0000-0000-00000000000000",
208+
"SubscriptionId": "<Azure Subscription Id",
209+
"NamespaceName": "Name of Event Hubs Namespace",
210+
"EntityType": "EventHub",
211+
"EntityName": "Name of Event Hub",
212+
"ActivityName": "SendMessage",
213+
"ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event hub namespace name>",,
214+
"OperationResult": "ServerBusy",
215+
"ErrorCount": 1,
216+
"EventTimestamp": "3/27/2024 1:02:29.126 PM +00:00",
217+
"ErrorMessage": "the request was terminated because the entity is being throttled by the application group with application group name <application group name> and policy name <throttling policy name>.error code: 50013.",
218+
"category": "DiagnosticErrorLogs"
219+
}
220+
221+
```
222+
Resource specific table entry:
223+
```json
224+
{
225+
"ActivityId": "0000000000-0000-0000-0000-00000000000000",
226+
"NamespaceName": "Name of Event Hubs Namespace",
227+
"EntityType": "Event Hub",
228+
"EntityName": "Name of Event Hub",
229+
"ActivityName": "SendMessage",
230+
"ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event hub namespace name>",,
231+
"OperationResult": "ServerBusy",
232+
"ErrorCount": 1,
233+
"TimeGenerated [UTC]": "1/27/2024 4:02:29.126 PM +00:00",
234+
"ErrorMessage": "The request was terminated because the entity is being throttled by the application group with application group name <application group name> and policy name <throttling policy name>.error code: 50013.",
235+
"Type": "AZMSDiagnosticErrorLogs"
236+
}
237+
238+
```
182239

183240
## Azure Monitor Logs tables
184241
Azure Event Hubs uses Kusto tables from Azure Monitor Logs. You can query these tables with Log Analytics. For a list of Kusto tables the service uses, see [Azure Monitor Logs table reference](/azure/azure-monitor/reference/tables/tables-resourcetype#event-hubs).

0 commit comments

Comments
 (0)