Skip to content

Commit 88782b1

Browse files
authored
Merge pull request #113515 from spelluru/ehubdiag0501
Diagnostic logs update for Event Hubs
2 parents 6e18cf9 + 14fad6d commit 88782b1

File tree

1 file changed

+62
-32
lines changed

1 file changed

+62
-32
lines changed

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

Lines changed: 62 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -138,64 +138,94 @@ Autoscale log JSON includes elements listed in the following table:
138138

139139
| Name | Description |
140140
| ---- | ----------- |
141-
| trackingId | Internal ID, which is used for tracing purposes |
142-
| resourceId | Internal ID, which contains Azure subscription ID and namespace name |
143-
| message | Informational message, which provides details about auto-inflate action. The message contains previous and current value of throughput unit for a given namespace and what triggered the inflate of the TU. |
141+
| TrackingId | Internal ID, which is used for tracing purposes |
142+
| ResourceId | Azure Resource Manager resource ID. |
143+
| Message | Informational message, which provides details about auto-inflate action. The message contains previous and current value of throughput unit for a given namespace and what triggered the inflate of the TU. |
144144

145145
## Kafka coordinator logs schema
146146
Kafka coordinator log JSON includes elements listed in the following table:
147147

148148
| Name | Description |
149149
| ---- | ----------- |
150-
| requestId | request ID, which is used for tracing purposes |
151-
| resourceId | Internal ID, which contains Azure subscription ID and namespace name |
152-
| operationName | Name of the operation that's done during the group coordination |
153-
| clientId | Client ID |
154-
| namespaceName | Namespace name |
155-
| subscriptionId | Azure subscription ID |
156-
| message | Informational message, which provides details about actions done during the consumer group coordination. |
150+
| RequestId | Request ID, which is used for tracing purposes |
151+
| ResourceId | Azure Resource Manager resource ID |
152+
| Operation | Name of the operation that's done during the group coordination |
153+
| ClientId | Client ID |
154+
| NamespaceName | Namespace name |
155+
| SubscriptionId | Azure subscription ID |
156+
| Message | Informational or warning message, which provides details about actions done during the group coordination. |
157+
158+
### Example
159+
160+
```json
161+
{
162+
"RequestId": "FE01001A89E30B020000000304620E2A_KafkaExampleConsumer#0",
163+
"Operation": "Join.Start",
164+
"ClientId": "KafkaExampleConsumer#0",
165+
"Message": "Start join group for new member namespace-name:c:$default:I:KafkaExampleConsumer#0-cc40856f7f3c4607915a571efe994e82, current group size: 0, API version: 2, session timeout: 10000ms, rebalance timeout: 300000ms.",
166+
"SubscriptionId": "0000000-0000-0000-0000-000000000000",
167+
"NamespaceName": "namespace-name",
168+
"ResourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/microsoft.eventhub/namespaces/namespace-name",
169+
"Category": "KafkaCoordinatorLogs"
170+
}
171+
```
157172

158173
## Kafka user error logs schema
159174
Kafka user error log JSON includes elements listed in the following table:
160175

161176
| Name | Description |
162177
| ---- | ----------- |
163-
| trackingId | tracking ID, which is used for tracing purposes. |
164-
| namespaceName | Namespace name |
165-
| eventhub | Event hub name |
166-
| partitionId | Partition ID |
167-
| groupId | Group ID |
178+
| TrackingId | Tracking ID, which is used for tracing purposes. |
179+
| NamespaceName | Namespace name |
180+
| Eventhub | Event hub name |
181+
| PartitionId | Partition ID |
182+
| GroupId | Group ID |
168183
| ClientId | Client ID |
169-
| resourceId | Internal ID, which contains Azure subscription ID and namespace name |
170-
| message | Informational message, which provides details about an error |
184+
| ResourceId | Azure Resource Manager resource ID. |
185+
| Message | Informational message, which provides details about an error |
171186

172187
## Event Hubs virtual network connection event schema
173188

174189
Event Hubs virtual network (VNet) connection event JSON includes elements listed in the following table:
175190

176191
| Name | Description |
177192
| --- | ----------- |
178-
| subscriptionId | Azure subscription ID |
179-
| namespaceName | Namespace name |
180-
| ipAddress | IP address of a client connecting to the Event Hubs service |
181-
| action | Action done by the Event Hubs service when evaluating connection requests. Supported actions are **AcceptConnection** and **RejectConnection**. |
182-
| reason | Provides a reason why the action was done |
183-
| count | Number of occurrences for the given action |
184-
| resourceId | Internal resource ID, which contains subscription ID and namespace name. |
193+
| SubscriptionId | Azure subscription ID |
194+
| NamespaceName | Namespace name |
195+
| IPAddress | IP address of a client connecting to the Event Hubs service |
196+
| Action | Action done by the Event Hubs service when evaluating connection requests. Supported actions are **Accept Connection** and **Deny Connection**. |
197+
| Reason | Provides a reason why the action was done |
198+
| Count | Number of occurrences for the given action |
199+
| ResourceId | Azure Resource Manager resource ID. |
200+
201+
### Example
202+
203+
```json
204+
{
205+
"SubscriptionId": "0000000-0000-0000-0000-000000000000",
206+
"NamespaceName": "namespace-name",
207+
"IPAddress": "1.2.3.4",
208+
"Action": "Deny Connection",
209+
"Reason": "IPAddress doesn't belong to a subnet with Service Endpoint enabled.",
210+
"Count": "65",
211+
"ResourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/microsoft.eventhub/namespaces/namespace-name",
212+
"Category": "EventHubVNetConnectionEvent"
213+
}
214+
```
185215

186216
## Customer-managed key user logs
187217
Customer-managed key user log JSON includes elements listed in the following table:
188218

189219
| Name | Description |
190220
| ---- | ----------- |
191-
| category | Type of category for a message. It's one of the following values: **error** and **info** |
192-
| resourceId | Internal resource ID, which includes Azure subscription ID and namespace name |
193-
| keyVault | Name of the Key Vault resource |
194-
| key | Name of the Key Vault key. |
195-
| version | Version of the Key Vault key |
196-
| operation | The name of an operation done to serve requests |
197-
| code | Status code |
198-
| message | Message, which provides details about an error or informational message |
221+
| Category | Type of category for a message. It's one of the following values: **error** and **info** |
222+
| ResourceId | Internal resource ID, which includes Azure subscription ID and namespace name |
223+
| KeyVault | Name of the Key Vault resource |
224+
| Key | Name of the Key Vault key. |
225+
| Version | Version of the Key Vault key |
226+
| Operation | The name of an operation done to serve requests |
227+
| Code | Status code |
228+
| Message | Message, which provides details about an error or informational message |
199229

200230

201231

0 commit comments

Comments
 (0)