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
Platform metrics and the activity log are collected and stored automatically, but can be routed to other locations by using a diagnostic setting.
47
-
48
-
Resource Logs aren't collected and stored until you create a diagnostic setting and route them to one or more locations.
49
-
50
-
See [Create diagnostic setting to collect platform logs and metrics in Azure](../azure-monitor/essentials/diagnostic-settings.md) for the detailed process for creating a diagnostic setting using the Azure portal, CLI, or PowerShell. When you create a diagnostic setting, you specify which categories of logs to collect. The categories for Azure Event Hubs are listed in [Azure Event Hubs monitoring data reference](monitor-event-hubs-reference.md#resource-logs).
51
-
52
-
> [!NOTE]
53
-
> Azure Monitor doesn't include dimensions in the exported metrics data, that's sent to a destination like Azure Storage, Azure Event Hubs, Log Analytics, etc.
54
-
55
46
56
47
### Supported metrics for Microsoft.EventHub/clusters
57
48
@@ -67,66 +58,65 @@ The following table lists the metrics available for the Microsoft.EventHub/Names
This section lists all the automatically collected platform metrics collected for Azure Event Hubs. The resource provider for these metrics is `Microsoft.EventHub/clusters` or `Microsoft.EventHub/namespaces`.
73
62
74
63
### Request metrics
64
+
75
65
Counts the number of data and management operations requests.
76
66
77
-
| Metric Name|Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
78
-
|----------|----------|-----|---|---|---|
79
-
| Incoming Requests| Yes | Count | Count | The number of requests made to the Event Hubs service over a specified period. This metric includes all the data and management plane operations. | Entity name|
80
-
| Successful Requests| No | Count | Count | The number of successful requests made to the Event Hubs service over a specified period. | Entity name<br/><br/>Operation Result |
81
-
| Throttled Requests| No | Count | Count | The number of requests that were throttled because the usage was exceeded. | Entity name<br/><br/>Operation Result |
67
+
| Metric name| Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
| Incoming Requests| Yes | Count | Count | The number of requests made to the Event Hubs service over a specified period. This metric includes all the data and management plane operations. | Entity name|
70
+
| Successful Requests| No | Count | Count | The number of successful requests made to the Event Hubs service over a specified period. | Entity name<br/><br/>Operation Result |
71
+
| Throttled Requests| No | Count | Count | The number of requests that were throttled because the usage was exceeded. | Entity name<br/><br/>Operation Result |
82
72
83
73
The following two types of errors are classified as **user errors**:
84
74
85
75
1. Client-side errors (In HTTP that would be 400 errors).
86
76
2. Errors that occur while processing messages.
87
77
88
-
89
78
### Message metrics
90
-
| Metric Name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
|Incoming Messages | Yes | Count | Count | The number of events or messages sent to Event Hubs over a specified period. | Entity name |
83
+
|Outgoing Messages | Yes | Count | Count | The number of events or messages received from Event Hubs over a specified period. | Entity name |
84
+
| Captured Messages | No | Count | Count | The number of captured messages. | Entity name |
85
+
|Incoming Bytes | Yes | Bytes | Count | Incoming bytes for an event hub over a specified period. | Entity name|
86
+
|Outgoing Bytes | Yes | Bytes | Count | Outgoing bytes for an event hub over a specified period. | Entity name |
87
+
| Size | No | Bytes | Average | Size of an event hub in bytes.|Entity name |
99
88
100
89
> [!NOTE]
101
90
> - These values are point-in-time values. Incoming messages that were consumed immediately after that point-in-time may not be reflected in these metrics.
102
91
> - The **Incoming requests** metric includes all the data and management plane operations. The **Incoming messages** metric gives you the total number of events that are sent to the event hub. For example, if you send a batch of 100 events to an event hub, it'll count as 1 incoming request and 100 incoming messages.
103
92
104
93
### Capture metrics
105
-
| Metric Name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
|Active Connections| No | Count | Average | The number of active connections on a namespace and on an entity (event hub) in the namespace. Value for this metric is a point-in-time value. Connections that were active immediately after that point-in-time may not be reflected in the metric.| Entity name |
116
-
|Connections Opened | No | Count | Average | The number of open connections. | Entity name |
117
-
|Connections Closed | No | Count | Average| The number of closed connections. | Entity name |
102
+
103
+
| Metric name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
| Active Connections| No | Count | Average | The number of active connections on a namespace and on an entity (event hub) in the namespace. Value for this metric is a point-in-time value. Connections that were active immediately after that point-in-time might not be reflected in the metric.| Entity name |
106
+
| Connections Opened | No | Count | Average | The number of open connections. | Entity name |
107
+
| Connections Closed | No | Count | Average| The number of closed connections. | Entity name |
118
108
119
109
### Error metrics
120
-
| Metric Name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
|Server Errors| No | Count | Count | The number of requests not processed because of an error in the Event Hubs service over a specified period. | Entity name<br/><br/>Operation Result |
123
-
|User Errors | No | Count | Count | The number of requests not processed because of user errors over a specified period. | Entity name<br/><br/>Operation Result|
124
-
|Quota Exceeded Errors | No |Count | Count | The number of errors caused by exceeding quotas over a specified period. | Entity name<br/><br/>Operation Result|
110
+
111
+
| Metric name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
| Server Errors | No | Count | Count | The number of requests not processed because of an error in the Event Hubs service over a specified period. | Entity name<br/><br/>Operation Result |
114
+
| User Errors | No | Count | Count | The number of requests not processed because of user errors over a specified period. | Entity name<br/><br/>Operation Result |
115
+
| Quota Exceeded Errors | No | Count | Count | The number of errors caused by exceeding quotas over a specified period. | Entity name<br/><br/>Operation Result |
125
116
126
117
> [!NOTE]
127
118
> Logic Apps creates epoch receivers and receivers may be moved from one node to another depending on the service load. During those moves, `ReceiverDisconnection` exceptions may occur. They are counted as user errors on the Event Hubs service side. Logic Apps may collect failures from Event Hubs clients so that you can view them in user logs.
@@ -138,10 +128,9 @@ The following two types of errors are classified as **user errors**:
138
128
139
129
Azure Event Hubs supports the following dimensions for metrics in Azure Monitor. Adding dimensions to your metrics is optional. If you don't add dimensions, metrics are specified at the namespace level.
140
130
141
-
|Dimension name|Description|
142
-
| ------------------- | ----------------- |
143
-
|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.|
144
-
131
+
| Dimension name | Description |
132
+
|:---------------|:------------|
133
+
| 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.|
@@ -159,45 +148,44 @@ Azure Event Hubs now has the capability to dispatch logs to either of two destin
159
148
160
149
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).
161
150
162
-
You can view our sample queries to get started with different log categories.
151
+
You can view our sample queries to get started with different log categories.
163
152
164
153
> [!IMPORTANT]
165
-
> Dimensions aren't exported to a Log Analytics workspace.
166
-
154
+
> Dimensions aren't exported to a Log Analytics workspace.
|`ResourceId`| Resource associated with the activity. | Yes | Yes |
184
171
|`Timestamp`| Aggregation time. | Yes | No |
185
-
|`TimeGenerated [UTC]`|Time of executed operation (in UTC)| No | Yes |
172
+
|`TimeGenerated [UTC]`|Time of executed operation (in UTC)| No | Yes |
186
173
|`Status`| Status of the activity (success or failure). | Yes | Yes |
187
174
|`Protocol`| Type of the protocol associated with the operation. | Yes | Yes |
188
-
|`AuthType`| Type of authentication (Azure Active Directory or SAS Policy). | Yes | Yes |
189
-
|`AuthKey`|Azure Active Directory application ID or SAS policy name that's used to authenticate to a resource. | Yes | Yes |
175
+
|`AuthType`| Type of authentication (Microsoft Entra ID or SAS Policy). | Yes | Yes |
176
+
|`AuthKey`|Microsoft Entra ID application ID or SAS policy name that's used to authenticate to a resource. | Yes | Yes |
190
177
|`NetworkType`| Type of the network access: `Public` or `Private`. | Yes | Yes |
191
178
|`ClientIP`| IP address of the client application. | Yes | Yes |
192
179
|`Count`| Total number of operations performed during the aggregated period of 1 minute. | Yes | Yes |
193
180
|`Properties`| Metadata that are specific to the data plane operation. | Yes | Yes |
194
-
|`Category`| Log category | Yes |NO|
181
+
|`Category`| Log category | Yes |No|
195
182
|`Provider`|Name of Service emitting the logs, such as Eventhub | No | Yes |
196
183
|`Type`| Type of logs emitted | No | Yes |
197
184
198
185
Here's an example of a runtime audit log entry:
199
186
200
-
AzureDiagnostics :
187
+
AzureDiagnostics:
188
+
201
189
```json
202
190
{
203
191
"ActivityId": "<activity id>",
@@ -215,7 +203,9 @@ AzureDiagnostics :
215
203
}
216
204
217
205
```
206
+
218
207
Resource specific table entry:
208
+
219
209
```json
220
210
{
221
211
"ActivityId": "<activity id>",
@@ -236,13 +226,14 @@ Resource specific table entry:
236
226
```
237
227
238
228
## Application metrics logs
239
-
Application metrics logs capture the aggregated information on certain metrics related to data plane operations. The captured information includes the following runtime metrics.
240
229
241
-
> [!NOTE]
242
-
> Application metrics logs are available only in **premium** and **dedicated** tiers.
230
+
Application metrics logs capture the aggregated information on certain metrics related to data plane operations. The captured information includes the following runtime metrics.
231
+
232
+
> [!NOTE]
233
+
> Application metrics logs are available only in **premium** and **dedicated** tiers.
243
234
244
235
| Name | Description |
245
-
|-------|------- |
236
+
|:-------|:------- |
246
237
|`ConsumerLag`| Indicate the lag between consumers and producers. |
247
238
|`NamespaceActiveConnections`| Details of active connections established from a client to the event hub. |
248
239
|`GetRuntimeInfo`| Obtain run time information from Event Hubs. |
@@ -255,12 +246,13 @@ Application metrics logs capture the aggregated information on certain metrics r
255
246
|`OffsetFetch`| Number of offset fetch calls made to the event hub. |
256
247
257
248
## Diagnostic Error Logs
258
-
Diagnostic error logs capture error messages for any client side, throttling and Quota exceeded errors. They provide detailed diagnostics for error identification.
259
249
260
-
Diagnostic Error Logs include elements listed in below table:
250
+
Diagnostic error logs capture error messages for any client side, throttling, and Quota exceeded errors. They provide detailed diagnostics for error identification.
251
+
252
+
Diagnostic Error Logs include elements listed in following table:
261
253
262
254
| Name | Description | Supported in Azure Diagnostics | Supported in AZMSDiagnosticErrorLogs (Resource specific table) |
263
-
|---|---|---|---|
255
+
|:---|:---|:---|:---|
264
256
|`ActivityId`| A randomly generated UUID that ensures uniqueness for the audit activity. | Yes | Yes |
265
257
|`ActivityName`| Operation name | Yes | Yes |
266
258
|`NamespaceName`| Name of Namespace | Yes | yes |
@@ -294,7 +286,9 @@ Here's an example of Diagnostic error log entry:
@@ -335,5 +328,5 @@ Resource specific table entry:
335
328
336
329
## Related content
337
330
338
-
- See [Monitor [TODO-replace-with-service-name]](monitor-[TODO-replace-with-service-filename].md) for a description of monitoring [TODO-replace-with-service-name].
339
-
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.
331
+
- See [Monitor Azure Event Hubs](monitor-event-hubs.md) for a description of monitoring Event Hubs.
332
+
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.
0 commit comments