Skip to content

Commit bc68f89

Browse files
Merge pull request #271358 from spelluru/ehubfreshness0405
Freshness review of Event Hubs monitoring and Node Js quickstart
2 parents 4f076d2 + 316ff71 commit bc68f89

File tree

6 files changed

+19
-20
lines changed

6 files changed

+19
-20
lines changed

articles/event-hubs/event-hubs-node-get-started-send.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you're new to Azure Event Hubs, see [Event Hubs overview](event-hubs-about.md
1717

1818
To complete this quickstart, you need the following prerequisites:
1919

20-
- **Microsoft Azure subscription**. To use Azure services, including Azure Event Hubs, you need a subscription. If you don't have an existing Azure account, you can sign up for a [free trial](https://azure.microsoft.com/free/) or use your MSDN subscriber benefits when you [create an account](https://azure.microsoft.com).
20+
- **Microsoft Azure subscription**. To use Azure services, including Azure Event Hubs, you need a subscription. If you don't have an existing Azure account, you can sign up for a [free trial](https://azure.microsoft.com/free/).
2121
- Node.js LTS. Download the latest [long-term support (LTS) version](https://nodejs.org).
2222
- Visual Studio Code (recommended) or any other integrated development environment (IDE).
2323
- **Create an Event Hubs namespace and an event hub**. The first step is to use the [Azure portal](https://portal.azure.com) to create a namespace of type Event Hubs, and obtain the management credentials your application needs to communicate with the event hub. To create a namespace and an event hub, follow the procedure in [this article](event-hubs-create.md).
@@ -139,16 +139,14 @@ In this section, you create a JavaScript application that sends events to an eve
139139
---
140140

141141
1. Run `node send.js` to execute this file. This command sends a batch of three events to your event hub. If you're using the Passwordless (Azure Active Directory's Role-based Access Control) authentication, you might want to run `az login` and sign into Azure using the account that was added to the Azure Event Hubs Data Owner role.
142-
1. In the Azure portal, verify that the event hub has received the messages. Refresh the page to update the chart. It might take a few seconds for it to show that the messages have been received.
142+
1. In the Azure portal, verify that the event hub received the messages. Refresh the page to update the chart. It might take a few seconds for it to show that the messages are received.
143143

144144
[![Verify that the event hub received the messages](./media/node-get-started-send/verify-messages-portal.png)](./media/node-get-started-send/verify-messages-portal.png#lightbox)
145145

146146
> [!NOTE]
147147
> For the complete source code, including additional informational comments, go to the [GitHub sendEvents.js page](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/eventhub/event-hubs/samples/v5/javascript/sendEvents.js).
148148

149-
You have now sent events to an event hub.
150-
151-
149+
152150
## Receive events
153151
In this section, you receive events from an event hub by using an Azure Blob storage checkpoint store in a JavaScript application. It performs metadata checkpoints on received messages at regular intervals in an Azure Storage blob. This approach makes it easy to continue receiving messages later from where you left off.
154152

@@ -170,13 +168,13 @@ To create an Azure storage account and a blob container in it, do the following
170168

171169
[Get the connection string to the storage account](../storage/common/storage-configure-connection-string.md).
172170

173-
Note the connection string and the container name. You use them in the receive code.
171+
Note the connection string and the container name. You use them in the code to receive events.
174172

175173
---
176174

177175
### Install the npm packages to receive events
178176

179-
For the receiving side, you need to install two more packages. In this quickstart, you use Azure Blob storage to persist checkpoints so that the program doesn't read the events that it has already read. It performs metadata checkpoints on received messages at regular intervals in a blob. This approach makes it easy to continue receiving messages later from where you left off.
177+
For the receiving side, you need to install two more packages. In this quickstart, you use Azure Blob storage to persist checkpoints so that the program doesn't read the events that it already read. It performs metadata checkpoints on received messages at regular intervals in a blob. This approach makes it easy to continue receiving messages later from where you left off.
180178
181179
### [Passwordless (Recommended)](#tab/passwordless)
182180
@@ -361,7 +359,7 @@ npm install @azure/eventhubs-checkpointstore-blob
361359
> [!NOTE]
362360
> For the complete source code, including additional informational comments, go to the [GitHub receiveEventsUsingCheckpointStore.js page](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/eventhub/eventhubs-checkpointstore-blob/samples/v1/javascript/receiveEventsUsingCheckpointStore.js).
363361
364-
You have now received events from your event hub. The receiver program receives events from all the partitions of the default consumer group in the event hub.
362+
The receiver program receives events from all the partitions of the default consumer group in the event hub.
365363
366364
## Clean up resources
367365
Delete the resource group that has the Event Hubs namespace or delete only the namespace if you want to keep the resource group.
29.3 KB
Loading
-3.47 KB
Loading
-10.5 KB
Loading
-4.72 KB
Loading

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

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Monitoring Azure Event Hubs
33
description: Learn how to use Azure Monitor to view, analyze, and create alerts on metrics from Azure Event Hubs.
44
ms.topic: conceptual
55
ms.custom: subject-monitoring
6-
ms.date: 03/01/2023
6+
ms.date: 04/05/2024
77
---
88

99
# Monitor Azure Event Hubs
@@ -45,7 +45,7 @@ See [Create diagnostic setting to collect platform logs and metrics in Azure](..
4545
If you use **Azure Storage** to store the diagnostic logging information, the information is stored in containers named **insights-logs-operationlogs** and **insights-metrics-pt1m**. Sample URL for an operation log: `https://<Azure Storage account>.blob.core.windows.net/insights-logs-operationallogs/resourceId=/SUBSCRIPTIONS/<Azure subscription ID>/RESOURCEGROUPS/<Resource group name>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<Namespace name>/y=<YEAR>/m=<MONTH-NUMBER>/d=<DAY-NUMBER>/h=<HOUR>/m=<MINUTE>/PT1H.json`. The URL for a metric log is similar.
4646

4747
### Azure Event Hubs
48-
If you use **Azure Event Hubs** to store the diagnostic logging information, the information is stored in Event Hubs instances named **insights-logs-operationlogs** and **insights-metrics-pt1m**. You can also select an existing event hub except for the event hub for which you are configuring diagnostic settings.
48+
If you use **Azure Event Hubs** to store the diagnostic logging information, the information is stored in Event Hubs instances named **insights-logs-operationlogs** and **insights-metrics-pt1m**. You can also select an existing event hub except for the event hub for which you're configuring diagnostic settings.
4949

5050
### Log Analytics
5151
If you use **Log Analytics** to store the diagnostic logging information, the information is stored in tables named **AzureDiagnostics** / **AzureMetrics** or **resource specific tables**
@@ -61,7 +61,7 @@ The metrics and logs you can collect are discussed in the following sections.
6161
## Analyze metrics
6262
You can analyze metrics for Azure Event Hubs, along with metrics from other Azure services, by selecting **Metrics** from the **Azure Monitor** section on the home page for your Event Hubs namespace. See [Analyze metrics with Azure Monitor metrics explorer](../azure-monitor/essentials/analyze-metrics.md) for details on using this tool. For a list of the platform metrics collected, see [Monitoring Azure Event Hubs data reference metrics](monitor-event-hubs-reference.md#metrics).
6363

64-
![Metrics Explorer with Event Hubs namespace selected](./media/monitor-event-hubs/metrics.png)
64+
:::image type="content" source="./media/monitor-event-hubs/metrics.png" alt-text="Screenshot showing the Metrics Explorer for an Event Hubs namespace." lightbox="./media/monitor-event-hubs/metrics.png":::
6565

6666
For reference, you can see a list of [all resource metrics supported in Azure Monitor](../azure-monitor/essentials/metrics-supported.md).
6767

@@ -71,7 +71,7 @@ For reference, you can see a list of [all resource metrics supported in Azure Mo
7171
### Filter and split
7272
For metrics that support dimensions, you can apply filters using a dimension value. For example, add a filter with `EntityName` set to the name of an event hub. You can also split a metric by dimension to visualize how different segments of the metric compare with each other. For more information of filtering and splitting, see [Advanced features of Azure Monitor](../azure-monitor/essentials/metrics-charts.md).
7373

74-
:::image type="content" source="./media/monitor-event-hubs/metrics-filter-split.png" alt-text="Image showing filtering and splitting metrics":::
74+
:::image type="content" source="./media/monitor-event-hubs/metrics-filter-split.png" alt-text="Screenshot showing the Metrics Explorer for an Event Hubs namespace with a filter." lightbox="./media/monitor-event-hubs/metrics-filter-split.png":::
7575

7676
## Analyze logs
7777
Using Azure Monitor Log Analytics requires you to create a diagnostic configuration and enable __Send information to Log Analytics__. For more information, see the [Collection and routing](#collection-and-routing) section. Data in Azure Monitor Logs is stored in tables, with each table having its own set of unique properties. Azure Event Hubs stores data in the following tables: **AzureDiagnostics** and **AzureMetrics**.
@@ -166,17 +166,18 @@ Using *Runtime audit logs* you can capture aggregated diagnostic information for
166166
> Runtime audit logs are available only in **premium** and **dedicated** tiers.
167167
168168
### Enable runtime logs
169-
You can enable either runtime audit logs or application metrics logs by selecting *Diagnostic settings* from the *Monitoring* section on the Event Hubs namespace page in Azure portal. Click on *Add diagnostic setting* as shown below.
169+
You can enable either runtime audit or application metrics logging by selecting *Diagnostic settings* from the *Monitoring* section on the Event Hubs namespace page in Azure portal. Select **Add diagnostic setting** as shown in the following image.
170170
171-
![Screenshot showing the Diagnostic settings page.](./media/monitor-event-hubs/add-diagnostic-settings.png)
171+
:::image type="content" source="./media/monitor-event-hubs/add-diagnostic-settings.png" alt-text="Screenshot that shows the Diagnostic settings page for an Event Hubs namespace." lightbox="./media/monitor-event-hubs/add-diagnostic-settings.png":::
172172
173173
Then you can enable log categories *RuntimeAuditLogs* or *ApplicationMetricsLogs* as needed.
174-
![Screenshot showing the selection of RuntimeAuditLogs and ApplicationMetricsLogs.](./media/monitor-event-hubs/configure-diagnostic-settings.png)
175174
176-
Once runtime logs are enabled, Event Hubs will start collecting and storing them according to the diagnostic setting configuration.
175+
:::image type="content" source="./media/monitor-event-hubs/configure-diagnostic-settings.png" alt-text="Screenshot that shows the runtime audit and application metric logs enabled." lightbox="./media/monitor-event-hubs/configure-diagnostic-settings.png":::
176+
177+
Once runtime logs are enabled, Event Hubs start collecting and storing them according to the diagnostic setting configuration.
177178
178179
### Publish and consume sample data
179-
To collect sample runtime audit logs in your Event Hubs namespace, you can publish and consume sample data using client applications which are based on [Event Hubs SDK](../event-hubs/event-hubs-dotnet-standard-getstarted-send.md) (AMQP) or using any [Apache Kafka client application](../event-hubs/event-hubs-quickstart-kafka-enabled-event-hubs.md).
180+
To collect sample runtime audit logs in your Event Hubs namespace, you can publish and consume sample data using client applications, which are based on [Event Hubs SDK](../event-hubs/event-hubs-dotnet-standard-getstarted-send.md), which uses Advanced Message Queuing Protocol (AMQP) or using any [Apache Kafka client application](../event-hubs/event-hubs-quickstart-kafka-enabled-event-hubs.md).
180181
181182
182183
### Analyze runtime audit logs
@@ -201,7 +202,7 @@ AZMSRuntimeAuditLogs
201202
Up on the execution of the query you should be able to obtain corresponding audit logs in the following format.
202203
:::image type="content" source="./media/monitor-event-hubs/runtime-audit-logs.png" alt-text="Image showing the result of a sample query to analyze runtime audit logs." lightbox="./media/monitor-event-hubs/runtime-audit-logs.png":::
203204

204-
By analyzing these logs you should be able to audit how each client application interacts with Event Hubs. Each field associated with runtime audit logs are defined in [runtime audit logs reference](../event-hubs/monitor-event-hubs-reference.md#runtime-audit-logs).
205+
By analyzing these logs, you should be able to audit how each client application interacts with Event Hubs. Each field associated with runtime audit logs is defined in [runtime audit logs reference](../event-hubs/monitor-event-hubs-reference.md#runtime-audit-logs).
205206

206207

207208
### Analyze application metrics
@@ -223,10 +224,10 @@ AZMSApplicationMetricLogs
223224
| where Provider == "EVENTHUB"
224225
```
225226
---
226-
Application metrics includes the following runtime metrics.
227+
Application metrics include the following runtime metrics.
227228
:::image type="content" source="./media/monitor-event-hubs/application-metrics-logs.png" alt-text="Image showing the result of a sample query to analyze application metrics." lightbox="./media/monitor-event-hubs/application-metrics-logs.png":::
228229

229-
Therefore you can use application metrics to monitor runtime metrics such as consumer lag or active connection from a given client application. Each field associated with runtime audit logs are defined in [application metrics logs reference](../event-hubs/monitor-event-hubs-reference.md#runtime-audit-logs).
230+
Therefore you can use application metrics to monitor runtime metrics such as consumer lag or active connection from a given client application. Fields associated with runtime audit logs are defined in [application metrics logs reference](../event-hubs/monitor-event-hubs-reference.md#runtime-audit-logs).
230231

231232

232233
## Alerts

0 commit comments

Comments
 (0)