Skip to content

Commit d09e7dd

Browse files
Additional edits.
1 parent 5adf198 commit d09e7dd

File tree

3 files changed

+76
-142
lines changed

3 files changed

+76
-142
lines changed

articles/event-hubs/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@
308308
href: event-hubs-management-libraries.md
309309
- name: Monitor
310310
items:
311-
- name: Monitor Azure Event Hubs
311+
- name: Monitor Event Hubs
312312
href: monitor-event-hubs.md
313313
- name: Stream Azure Diagnostics data using Event Hubs
314314
href: ../azure-monitor/agents/diagnostics-extension-stream-event-hubs.md

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

Lines changed: 71 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -7,43 +7,18 @@ ms.topic: reference
77
ms.service: azure-event-hubs
88
---
99

10-
<!--
11-
IMPORTANT
12-
According to the Content Pattern guidelines all comments must be removed before publication!!!
13-
To make this template easier to use, first:
14-
1. Search and replace [TODO-replace-with-service-name] with the official name of your service.
15-
2. Search and replace [TODO-replace-with-service-filename] with the service name to use in GitHub filenames.-->
16-
17-
<!-- VERSION 3.0 2024_01_01
18-
For background about this template, see https://review.learn.microsoft.com/en-us/help/contribute/contribute-monitoring?branch=main -->
19-
20-
<!-- All sections are required unless otherwise noted. Add service-specific information after the includes.
21-
Your service should have the following two articles:
22-
1. The primary monitoring article (based on the template monitor-service-template.md)
23-
- Title: "Monitor [TODO-replace-with-service-name]"
24-
- TOC title: "Monitor"
25-
- Filename: "monitor-[TODO-replace-with-service-filename].md"
26-
2. A reference article that lists all the metrics and logs for your service (based on this template).
27-
- Title: "[TODO-replace-with-service-name] monitoring data reference"
28-
- TOC title: "Monitoring data reference"
29-
- Filename: "monitor-[TODO-replace-with-service-filename]-reference.md".
30-
-->
31-
3210
# Azure Event Hubs monitoring data reference
3311

34-
<!-- Intro. -->
3512
[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
3613

3714
See [Monitor Azure Event Hubs](monitor-event-hubs.md) for details on the data you can collect for Event Hubs and how to use it.
3815

3916
Azure Event Hubs creates monitoring data using [Azure Monitor](../azure-monitor/overview.md), which is a full stack monitoring service in Azure. Azure Monitor provides a complete set of features to monitor your Azure resources. It can also monitor resources in other clouds and on-premises.
4017

41-
Azure Event Hubs collects the same kinds of monitoring data as other Azure resources that are described in [Monitoring data from Azure resources](../azure-monitor/essentials/monitor-azure-resource.md#monitoring-data).
18+
Azure Event Hubs collects the same kinds of monitoring data as other Azure resources that are described in [Monitoring data from Azure resources](../azure-monitor/essentials/monitor-azure-resource.md#monitoring-data).
4219

43-
<!-- ## Metrics -->
4420
[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
4521

46-
4722
### Supported metrics for Microsoft.EventHub/clusters
4823

4924
The following table lists the metrics available for the Microsoft.EventHub/clusters resource type.
@@ -60,59 +35,57 @@ The following table lists the metrics available for the Microsoft.EventHub/Names
6035

6136
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`.
6237

63-
### Request metrics
64-
65-
Counts the number of data and management operations requests.
66-
67-
| Metric name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
68-
|:------------|:-----------|:-----|:---|:---|:---|
69-
| 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 |
72-
73-
The following two types of errors are classified as **user errors**:
38+
Request metrics count the number of data and management operations requests. This table provides more information about values from the preceding tables.
7439

75-
1. Client-side errors (In HTTP that would be 400 errors).
76-
2. Errors that occur while processing messages.
40+
| Metric name | Description |
41+
|:--------------------|:------------|
42+
| Incoming Requests | The number of requests made to the Event Hubs service over a specified period. This metric includes all the data and management plane operations. |
43+
| Successful Requests | The number of successful requests made to the Event Hubs service over a specified period. |
44+
| Throttled Requests | The number of requests that were throttled because the usage was exceeded. |
7745

78-
### Message metrics
46+
This table provides more information for message metrics from the preceding tables.
7947

80-
| Metric name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
81-
|:------------|:-----------|:-----|:---|:---|:---|
82-
|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 |
48+
| Metric name | Description |
49+
|:------------|:------------|
50+
| Incoming Messages | The number of events or messages sent to Event Hubs over a specified period. |
51+
| Outgoing Messages | The number of events or messages received from Event Hubs over a specified period. |
52+
| Captured Messages | The number of captured messages. |
53+
| Incoming Bytes | Incoming bytes for an event hub over a specified period. |
54+
| Outgoing Bytes | Outgoing bytes for an event hub over a specified period. |
55+
| Size | Size of an event hub in bytes. |
8856

8957
> [!NOTE]
9058
> - 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.
9159
> - 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.
9260
93-
### Capture metrics
61+
This table provides more information for capture metrics from the preceding tables.
62+
63+
| Metric name | Description |
64+
|:------------|:------------|
65+
| Captured Messages | The number of captured messages. |
66+
| Captured Bytes | Captured bytes for an event hub. |
67+
| Capture Backlog | Capture backlog for an event hub. |
9468

95-
| Metric name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
96-
|:------------|:-----------|:-----|:---|:---|:---|
97-
| Captured Messages | No | Count | Count | The number of captured messages. | Entity name |
98-
| Captured Bytes | No | Bytes | Count | Captured bytes for an event hub | Entity name |
99-
| Capture Backlog | No | Count | Count | Capture backlog for an event hub | Entity name |
69+
This table provides more information for connection metrics from the preceding tables.
10070

101-
### Connection metrics
71+
| Metric name | Description |
72+
|:------------|:------------|
73+
| Active Connections | 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. |
74+
| Connections Opened | The number of open connections. |
75+
| Connections Closed | The number of closed connections. |
10276

103-
| Metric name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
104-
|:------------|:-----------|:-----|:---|:---|:---|
105-
| 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 |
77+
This table provides more information for error metrics from the preceding tables.
10878

109-
### Error metrics
79+
| Metric name | Description |
80+
|:------------|:------------|
81+
| Server Errors | The number of requests not processed because of an error in the Event Hubs service over a specified period. |
82+
| User Errors | The number of requests not processed because of user errors over a specified period. |
83+
| Quota Exceeded Errors | The number of errors caused by exceeding quotas over a specified period. |
11084

111-
| Metric name | Exportable via diagnostic settings | Unit | Aggregation type | Description | Dimensions |
112-
|:------------|:-----------|:-----|:---|:---|:---|
113-
| 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 |
85+
The following two types of errors are classified as **user errors**:
86+
87+
1. Client-side errors (In HTTP that would be 400 errors).
88+
2. Errors that occur while processing messages.
11689

11790
> [!NOTE]
11891
> 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.
@@ -121,28 +94,45 @@ The following two types of errors are classified as **user errors**:
12194

12295
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
12396

124-
- EntityName
125-
- OperationResult
126-
- Replica
127-
- Role
97+
| Dimension name | Description |
98+
|:----------------|:------------|
99+
| EntityName | 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. |
100+
| OperationResult | |
101+
| Replica | |
102+
| Role | |
128103

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.
104+
Adding dimensions to your metrics is optional. If you don't add dimensions, metrics are specified at the namespace level.
130105

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.|
106+
> [!NOTE]
107+
> When you enable metrics in a diagnostic setting, dimension information is not currently included as part of the information sent to a storage account, event hub, or log analytics.
134108
135-
<!-- ## Resource logs -->
136109
[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
137110

138111
### Supported resource logs for Microsoft.EventHub/Namespaces
139112

140113
[!INCLUDE [Microsoft.EventHub/Namespaces](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-eventhub-namespaces-logs-include.md)]
141114

142-
<!-- ## Log tables -->
143115
[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
144116

145-
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.
117+
### Event Hubs Microsoft.EventHub/namespaces
118+
119+
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
120+
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
121+
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagnostics#columns)
122+
- [AZMSApplicationMetricLogs](/azure/azure-monitor/reference/tables/azmsapplicationmetriclogs#columns)
123+
- [AZMSOperationalLogs](/azure/azure-monitor/reference/tables/azmsoperationallogs#columns)
124+
- [AZMSRunTimeAuditLogs](/azure/azure-monitor/reference/tables/azmsruntimeauditlogs#columns)
125+
- [AZMSDiagnosticErrorLogs](/azure/azure-monitor/reference/tables/azmsdiagnosticerrorlogs#columns)
126+
- [AZMSVnetConnectionEvents](/azure/azure-monitor/reference/tables/azmsvnetconnectionevents#columns)
127+
- [AZMSArchiveLogs](/azure/azure-monitor/reference/tables/azmsarchivelogs#columns)
128+
- [AZMSAutoscaleLogs](/azure/azure-monitor/reference/tables/azmsautoscalelogs#columns)
129+
- [AZMSKafkaCoordinatorLogs](/azure/azure-monitor/reference/tables/azmskafkacoordinatorlogs#columns)
130+
- [AZMSKafkaUserErrorLogs](/azure/azure-monitor/reference/tables/azmskafkausererrorlogs#columns)
131+
- [AZMSCustomerManagedKeyUserLogs](/azure/azure-monitor/reference/tables/azmscustomermanagedkeyuserlogs#columns)
132+
133+
### Event Hubs resource logs
134+
135+
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.
146136

147137
:::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":::
148138

@@ -155,7 +145,8 @@ You can view our sample queries to get started with different log categories.
155145
156146
[!INCLUDE [event-hubs-diagnostic-log-schema](./includes/event-hubs-diagnostic-log-schema.md)]
157147

158-
## Runtime audit logs
148+
### Runtime audit logs
149+
159150
Runtime audit logs capture aggregated diagnostic information for all data plane access operations (such as send or receive events) in Event Hubs.
160151

161152
> [!NOTE]
@@ -225,7 +216,7 @@ Resource specific table entry:
225216

226217
```
227218

228-
## Application metrics logs
219+
### Application metrics logs
229220

230221
Application metrics logs capture the aggregated information on certain metrics related to data plane operations. The captured information includes the following runtime metrics.
231222

@@ -245,7 +236,7 @@ Application metrics logs capture the aggregated information on certain metrics r
245236
| `OffsetCommit` | Number of offset commit calls made to the event hub |
246237
| `OffsetFetch` | Number of offset fetch calls made to the event hub. |
247238

248-
## Diagnostic Error Logs
239+
### Diagnostic Error Logs
249240

250241
Diagnostic error logs capture error messages for any client side, throttling, and Quota exceeded errors. They provide detailed diagnostics for error identification.
251242

@@ -306,22 +297,6 @@ Resource specific table entry:
306297

307298
```
308299

309-
### Event Hubs Microsoft.EventHub/namespaces
310-
311-
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
312-
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
313-
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagnostics#columns)
314-
- [AZMSApplicationMetricLogs](/azure/azure-monitor/reference/tables/azmsapplicationmetriclogs#columns)
315-
- [AZMSOperationalLogs](/azure/azure-monitor/reference/tables/azmsoperationallogs#columns)
316-
- [AZMSRunTimeAuditLogs](/azure/azure-monitor/reference/tables/azmsruntimeauditlogs#columns)
317-
- [AZMSDiagnosticErrorLogs](/azure/azure-monitor/reference/tables/azmsdiagnosticerrorlogs#columns)
318-
- [AZMSVnetConnectionEvents](/azure/azure-monitor/reference/tables/azmsvnetconnectionevents#columns)
319-
- [AZMSArchiveLogs](/azure/azure-monitor/reference/tables/azmsarchivelogs#columns)
320-
- [AZMSAutoscaleLogs](/azure/azure-monitor/reference/tables/azmsautoscalelogs#columns)
321-
- [AZMSKafkaCoordinatorLogs](/azure/azure-monitor/reference/tables/azmskafkacoordinatorlogs#columns)
322-
- [AZMSKafkaUserErrorLogs](/azure/azure-monitor/reference/tables/azmskafkausererrorlogs#columns)
323-
- [AZMSCustomerManagedKeyUserLogs](/azure/azure-monitor/reference/tables/azmscustomermanagedkeyuserlogs#columns)
324-
325300
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
326301

327302
- [Microsoft.EventHub resource provider operations](/azure/role-based-access-control/permissions/integration#microsofteventhub)

0 commit comments

Comments
 (0)