Skip to content

Commit e8679ff

Browse files
authored
Merge pull request #239971 from Saglodha/patch-8
Update monitor-event-hubs-reference.md
2 parents a8f8b81 + 8062c83 commit e8679ff

File tree

2 files changed

+49
-16
lines changed

2 files changed

+49
-16
lines changed
35 KB
Loading

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

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,13 @@ Azure Event Hubs supports the following dimensions for metrics in Azure Monitor.
8080
| ------------------- | ----------------- |
8181
|Entity Name| Name of the event hub. With the 'Incoming Requests' metric, the Entity Name dimension has a value of '-NamespaceOnlyMetric-' in addition to all your event hubs. It represents the requests that were made at the namespace level. Examples include a request to list all event hubs in the namespace or requests to entities that failed authentication or authorization.|
8282

83+
8384
## Resource logs
85+
86+
Azure Event Hubs now has the capability to dispatch logs to either of two destination tables - Azure Diagnostic or [Resource specific tables](~/articles/azure-monitor/essentials/resource-logs.md) in Log Analytics. You could use the toggle available on Azure portal to choose destination tables.
87+
88+
:::image type="content" source="media/monitor-event-hubs-reference/destination-table-toggle.png" alt-text="Screenshot of dialog box to set destination table." lightbox="media/monitor-event-hubs-reference/destination-table-toggle.png":::
89+
8490
[!INCLUDE [event-hubs-diagnostic-log-schema](./includes/event-hubs-diagnostic-log-schema.md)]
8591

8692

@@ -92,24 +98,31 @@ Runtime audit logs capture aggregated diagnostic information for all data plane
9298
9399
Runtime audit logs include the elements listed in the following table:
94100

95-
Name | Description
96-
------- | -------
97-
`ActivityId` | A randomly generated UUID that ensures uniqueness for the audit activity.
98-
`ActivityName` | Runtime operation name.
99-
`ResourceId` | Resource associated with the activity.
100-
`Timestamp` | Aggregation time.
101-
`Status` | Status of the activity (success or failure).
102-
`Protocol` | Type of the protocol associated with the operation.
103-
`AuthType` | Type of authentication (Microsoft Entra ID or SAS Policy).
104-
`AuthKey` | Microsoft Entra application ID or SAS policy name that's used to authenticate to a resource.
105-
`NetworkType` | Type of the network access: `Public` or `Private`.
106-
`ClientIP` | IP address of the client application.
107-
`Count` | Total number of operations performed during the aggregated period of 1 minute.
108-
`Properties` | Metadata that are specific to the data plane operation.
109-
`Category` | Log category
101+
102+
Name | Description | Supported in Azure Diagnostics | Supported in Resource Specific table
103+
------- | -------| -----| -----|
104+
`ActivityId` | A randomly generated UUID that ensures uniqueness for the audit activity. | Yes | Yes
105+
`ActivityName` | Runtime operation name.| Yes | Yes
106+
`ResourceId` | Resource associated with the activity. | Yes | Yes
107+
`Timestamp` | Aggregation time. | Yes | No
108+
`TimeGenerated [UTC]`|Time of executed operation (in UTC)| No | Yes
109+
`Status` | Status of the activity (success or failure). | Yes | Yes
110+
`Protocol` | Type of the protocol associated with the operation. | Yes | Yes
111+
`AuthType` | Type of authentication (Azure Active Directory or SAS Policy). | Yes | Yes
112+
`AuthKey` | Azure Active Directory application ID or SAS policy name that's used to authenticate to a resource. | Yes | Yes
113+
`NetworkType` | Type of the network access: `Public` or `Private`. | Yes | Yes
114+
`ClientIP` | IP address of the client application. | Yes | Yes
115+
`Count` | Total number of operations performed during the aggregated period of 1 minute. | Yes | Yes
116+
`Properties` | Metadata that are specific to the data plane operation. | Yes | Yes
117+
`Category` | Log category | Yes | NO
118+
`Provider`|Name of Service emitting the logs e.g., Eventhub | No | Yes
119+
`Type` | Type of logs emitted | No | Yes
120+
121+
110122

111123
Here's an example of a runtime audit log entry:
112124

125+
AzureDiagnostics :
113126
```json
114127
{
115128
"ActivityId": "<activity id>",
@@ -126,6 +139,25 @@ Here's an example of a runtime audit log entry:
126139
"Category": "RuntimeAuditLogs"
127140
}
128141

142+
```
143+
Resource specific table entry:
144+
```json
145+
{
146+
"ActivityId": "<activity id>",
147+
"ActivityName": "ConnectionOpen | Authorization | SendMessage | ReceiveMessage",
148+
"ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event Hubs namespace>/eventhubs/<event hub name>",
149+
"TimeGenerated (UTC)": "1/1/2021 8:40:06 PM +00:00",
150+
"Status": "Success | Failure",
151+
"Protocol": "AMQP | KAFKA | HTTP | Web Sockets",
152+
"AuthType": "SAS | Azure Active Directory",
153+
"AuthId": "<AAD application name | SAS policy name>",
154+
"NetworkType": "Public | Private",
155+
"ClientIp": "x.x.x.x",
156+
"Count": 1,
157+
"Type": "AZMSRuntimeAUditLogs",
158+
"Provider":"EVENTHUB"
159+
}
160+
129161
```
130162

131163
## Application metrics logs
@@ -148,10 +180,11 @@ Name | Description
148180
`OffsetFetch` | Number of offset fetch calls made to the event hub.
149181

150182

151-
152183
## Azure Monitor Logs tables
153184
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).
154185

186+
You can view our sample queries to get started with different log categories.
187+
155188
> [!IMPORTANT]
156189
> Dimensions aren't exported to a Log Analytics workspace.
157190

0 commit comments

Comments
 (0)