Skip to content

Commit 0ce5ee3

Browse files
Implement templates.
1 parent 1d36153 commit 0ce5ee3

File tree

3 files changed

+219
-74
lines changed

3 files changed

+219
-74
lines changed

articles/event-hubs/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@
354354
href: ../operational-excellence/relocation-event-hub-cluster.md?toc=/azure/event-hubs/TOC.json
355355
- name: Reference
356356
items:
357-
- name: Monitor data Reference
357+
- name: Monitoring data Reference
358358
href: monitor-event-hubs-reference.md
359359
- name: SDKs
360360
href: sdks.md

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

Lines changed: 107 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,73 @@
11
---
2-
title: Monitoring Azure Event Hubs data reference
3-
description: Important reference material needed when you monitor Azure Event Hubs.
2+
title: Monitoring data reference for Azure Event Hubs
3+
description: This article contains important reference material you need when you monitor Azure Event Hubs.
4+
ms.date: 06/19/2024
5+
ms.custom: horz-monitor, subject-monitoring
46
ms.topic: reference
5-
ms.custom: subject-monitoring
6-
ms.date: 10/06/2022
7+
ms.service: azure-event-hubs
78
---
89

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.-->
916

10-
# Monitoring Azure Event Hubs data reference
11-
See [Monitoring Azure Event Hubs](monitor-event-hubs.md) for details on collecting and analyzing monitoring data for Azure Event Hubs.
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+
32+
# Azure Event Hubs monitoring data reference
33+
34+
<!-- Intro. -->
35+
[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
36+
37+
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.
38+
39+
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.
40+
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).
42+
43+
<!-- ## Metrics -->
44+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
45+
46+
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).
1251

1352
> [!NOTE]
1453
> 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.
1554
1655

56+
### Supported metrics for Microsoft.EventHub/clusters
57+
58+
The following table lists the metrics available for the Microsoft.EventHub/clusters resource type.
59+
60+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
61+
[!INCLUDE [Microsoft.EventHub/clusters](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-eventhub-clusters-metrics-include.md)]
62+
63+
### Supported metrics for Microsoft.EventHub/Namespaces
64+
65+
The following table lists the metrics available for the Microsoft.EventHub/Namespaces resource type.
66+
67+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
68+
[!INCLUDE [<ResourceType/namespace>](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-eventhub-namespaces-metrics-include.md)]
69+
70+
1771
## Metrics
1872
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`.
1973

@@ -72,7 +126,15 @@ The following two types of errors are classified as **user errors**:
72126
> [!NOTE]
73127
> 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.
74128
75-
## Metric dimensions
129+
130+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
131+
132+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
133+
134+
- EntityName
135+
- OperationResult
136+
- Replica
137+
- Role
76138

77139
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.
78140

@@ -81,14 +143,29 @@ Azure Event Hubs supports the following dimensions for metrics in Azure Monitor.
81143
|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.|
82144

83145

84-
## Resource logs
146+
<!-- ## Resource logs -->
147+
[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
148+
149+
### Supported resource logs for Microsoft.EventHub/Namespaces
150+
151+
[!INCLUDE [Microsoft.EventHub/Namespaces](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-eventhub-namespaces-logs-include.md)]
152+
153+
<!-- ## Log tables -->
154+
[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
85155

86156
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.
87157

88158
:::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":::
89159

90-
[!INCLUDE [event-hubs-diagnostic-log-schema](./includes/event-hubs-diagnostic-log-schema.md)]
160+
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+
162+
You can view our sample queries to get started with different log categories.
91163

164+
> [!IMPORTANT]
165+
> Dimensions aren't exported to a Log Analytics workspace.
166+
167+
168+
[!INCLUDE [event-hubs-diagnostic-log-schema](./includes/event-hubs-diagnostic-log-schema.md)]
92169

93170
## Runtime audit logs
94171
Runtime audit logs capture aggregated diagnostic information for all data plane access operations (such as send or receive events) in Event Hubs.
@@ -235,15 +312,28 @@ Resource specific table entry:
235312

236313
```
237314

238-
## Azure Monitor Logs tables
239-
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).
240315

241-
You can view our sample queries to get started with different log categories.
316+
### Event Hubs Microsoft.EventHub/namespaces
242317

243-
> [!IMPORTANT]
244-
> Dimensions aren't exported to a Log Analytics workspace.
318+
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
319+
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
320+
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagnostics#columns)
321+
- [AZMSApplicationMetricLogs](/azure/azure-monitor/reference/tables/azmsapplicationmetriclogs#columns)
322+
- [AZMSOperationalLogs](/azure/azure-monitor/reference/tables/azmsoperationallogs#columns)
323+
- [AZMSRunTimeAuditLogs](/azure/azure-monitor/reference/tables/azmsruntimeauditlogs#columns)
324+
- [AZMSDiagnosticErrorLogs](/azure/azure-monitor/reference/tables/azmsdiagnosticerrorlogs#columns)
325+
- [AZMSVnetConnectionEvents](/azure/azure-monitor/reference/tables/azmsvnetconnectionevents#columns)
326+
- [AZMSArchiveLogs](/azure/azure-monitor/reference/tables/azmsarchivelogs#columns)
327+
- [AZMSAutoscaleLogs](/azure/azure-monitor/reference/tables/azmsautoscalelogs#columns)
328+
- [AZMSKafkaCoordinatorLogs](/azure/azure-monitor/reference/tables/azmskafkacoordinatorlogs#columns)
329+
- [AZMSKafkaUserErrorLogs](/azure/azure-monitor/reference/tables/azmskafkausererrorlogs#columns)
330+
- [AZMSCustomerManagedKeyUserLogs](/azure/azure-monitor/reference/tables/azmscustomermanagedkeyuserlogs#columns)
331+
332+
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
333+
334+
- [Microsoft.EventHub resource provider operations](/azure/role-based-access-control/permissions/integration#microsofteventhub)
245335

336+
## Related content
246337

247-
## Next steps
248-
- For details on monitoring Azure Event Hubs, see [Monitoring Azure Event Hubs](monitor-event-hubs.md).
249-
- For details on monitoring Azure resources, see [Monitoring Azure resources with Azure Monitor](../azure-monitor/essentials/monitor-azure-resource.md).
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.

0 commit comments

Comments
 (0)