Skip to content

Commit 153a3c1

Browse files
committed
updated
1 parent b336640 commit 153a3c1

File tree

1 file changed

+37
-35
lines changed

1 file changed

+37
-35
lines changed

articles/event-hubs/event-hubs-diagnostic-logs.md

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -51,45 +51,47 @@ Diagnostic logs are disabled by default. To enable diagnostic logs, follow these
5151

5252
Event Hubs captures diagnostic logs for the following categories:
5353

54-
- **Archive Logs**: logs related to the [Event Hubs Capture](event-hubs-capture-overview.md) feature, specifically, logs related to capture errors.
55-
- **Operational Logs**: information about all management operations that are performed on the Azure Event Hubs namespace. Data operations are not captured, because of the high volume of data operations that are conducted on Azure Event Hubs.
56-
- **Auto scale logs**: information about auto-inflate operations done on an Event Hubs namespace.
57-
- **Kafka coordinator logs** - information about Kafka coordinator operations related to Event Hubs.
58-
- **Kafka user error logs**: information about Kafka user operations related to Event Hubs.
59-
- **Event Hubs virtual network (VNet) connection event**: information about IP addresses and virtual networks sending traffic to Event Hubs.
60-
- **Customer-managed key user logs**: information about operations related to customer-managed key.
54+
| Category | Description |
55+
| -------- | ----------- |
56+
| Archive Logs | Captures information about [Event Hubs Capture](event-hubs-capture-overview.md) operations, specifically, logs related to capture errors. |
57+
| Operational Logs | Capture all management operations that are performed on the Azure Event Hubs namespace. Data operations are not captured, because of the high volume of data operations that are conducted on Azure Event Hubs. |
58+
| Auto scale logs | Captures auto-inflate operations done on an Event Hubs namespace. |
59+
| Kafka coordinator logs | Captures Kafka coordinator operations related to Event Hubs. |
60+
| Kafka user error logs | Captures information about Kafka APIs called on Event Hubs. |
61+
| Event Hubs virtual network (VNet) connection event | Captures information about IP addresses and virtual networks sending traffic to Event Hubs. |
62+
| Customer-managed key user logs | Captures operations related to customer-managed key. |
6163

6264

63-
All logs are stored in JavaScript Object Notation (JSON) format. Each entry has string fields that use the format described in the following sections.
65+
All logs are stored in JavaScript Object Notation (JSON) format. Each entry has string fields that use the format described in the following sections.
6466

6567
## Archive logs schema
6668

6769
Archive log JSON strings include elements listed in the following table:
6870

6971
Name | Description
7072
------- | -------
71-
TaskName | Description of the task that failed.
72-
ActivityId | Internal ID, used for tracking.
73-
trackingId | Internal ID, used for tracking.
74-
resourceId | Azure Resource Manager resource ID.
75-
eventHub | Event hub full name (includes namespace name).
76-
partitionId | Event Hub partition being written to.
73+
TaskName | Description of the task that failed
74+
ActivityId | Internal ID, used for tracking
75+
trackingId | Internal ID, used for tracking
76+
resourceId | Azure Resource Manager resource ID
77+
eventHub | Event hub full name (includes namespace name)
78+
partitionId | Event Hub partition being written to
7779
archiveStep | possible values: ArchiveFlushWriter, DestinationInit
78-
startTime | Failure start time.
79-
failures | Number of times failure occurred.
80-
durationInSeconds | Duration of failure.
81-
message | Error message.
80+
startTime | Failure start time
81+
failures | Number of times the failure occurred
82+
durationInSeconds | Duration of failure
83+
message | Error message
8284
category | ArchiveLogs
8385

8486
The following code is an example of an archive log JSON string:
8587

8688
```json
8789
{
8890
"TaskName": "EventHubArchiveUserError",
89-
"ActivityId": "21b89a0b-8095-471a-9db8-d151d74ecf26",
90-
"trackingId": "21b89a0b-8095-471a-9db8-d151d74ecf26_B7",
91-
"resourceId": "/SUBSCRIPTIONS/854D368F-1828-428F-8F3C-F2AFFA9B2F7D/RESOURCEGROUPS/DEFAULT-EVENTHUB-CENTRALUS/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/FBETTATI-OPERA-EVENTHUB",
92-
"eventHub": "fbettati-opera-eventhub:eventhub:eh123~32766",
91+
"ActivityId": "000000000-0000-0000-0000-0000000000000",
92+
"trackingId": "0000000-0000-0000-0000-00000000000000000",
93+
"resourceId": "/SUBSCRIPTIONS/000000000-0000-0000-0000-0000000000000/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event Hubs Namespace Name>",
94+
"eventHub": "<Event Hub full name>",
9395
"partitionId": "1",
9496
"archiveStep": "ArchiveFlushWriter",
9597
"startTime": "9/22/2016 5:11:21 AM",
@@ -106,27 +108,27 @@ Operational log JSON strings include elements listed in the following table:
106108

107109
Name | Description
108110
------- | -------
109-
ActivityId | Internal ID, used to track purpose.
110-
EventName | Operation name.
111-
resourceId | Azure Resource Manager resource ID.
112-
SubscriptionId | Subscription ID.
113-
EventTimeString | Operation time.
114-
EventProperties | Operation properties.
115-
Status | Operation status.
116-
Caller | Caller of operation (Azure portal or management client).
117-
category | OperationalLogs
111+
ActivityId | Internal ID, used for tracking purposes |
112+
EventName | Operation name |
113+
resourceId | Azure Resource Manager resource ID |
114+
SubscriptionId | Subscription ID |
115+
EventTimeString | Operation time |
116+
EventProperties | Operation properties |
117+
Status | Operation status |
118+
Caller | Caller of operation (Azure portal or management client) |
119+
Category | OperationalLogs |
118120

119121
The following code is an example of an operational log JSON string:
120122

121123
```json
122124
Example:
123125
{
124-
"ActivityId": "6aa994ac-b56e-4292-8448-0767a5657cc7",
126+
"ActivityId": "00000000-0000-0000-0000-00000000000000",
125127
"EventName": "Create EventHub",
126-
"resourceId": "/SUBSCRIPTIONS/1A2109E3-9DA0-455B-B937-E35E36C1163C/RESOURCEGROUPS/DEFAULT-SERVICEBUS-CENTRALUS/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/SHOEBOXEHNS-CY4001",
127-
"SubscriptionId": "1a2109e3-9da0-455b-b937-e35e36c1163c",
128+
"resourceId": "/SUBSCRIPTIONS/00000000-0000-0000-0000-0000000000000/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event Hubs namespace name>",
129+
"SubscriptionId": "000000000-0000-0000-0000-000000000000",
128130
"EventTimeString": "9/28/2016 8:40:06 PM +00:00",
129-
"EventProperties": "{\"SubscriptionId\":\"1a2109e3-9da0-455b-b937-e35e36c1163c\",\"Namespace\":\"shoeboxehns-cy4001\",\"Via\":\"https://shoeboxehns-cy4001.servicebus.windows.net/f8096791adb448579ee83d30e006a13e/?api-version=2016-07\",\"TrackingId\":\"5ee74c9e-72b5-4e98-97c4-08a62e56e221_G1\"}",
131+
"EventProperties": "{\"SubscriptionId\":\"0000000000-0000-0000-0000-000000000000\",\"Namespace\":\"<Namespace Name>\",\"Via\":\"https://<Namespace Name>.servicebus.windows.net/f8096791adb448579ee83d30e006a13e/?api-version=2016-07\",\"TrackingId\":\"5ee74c9e-72b5-4e98-97c4-08a62e56e221_G1\"}",
130132
"Status": "Succeeded",
131133
"Caller": "ServiceBus Client",
132134
"category": "OperationalLogs"

0 commit comments

Comments
 (0)