Skip to content

Commit cccb6cb

Browse files
v-dirichardsv-dirichards
authored
Merge pull request #286726 from TimShererWithAquent/nat-gateway-working
290929: Q&M: Onboard 15 services: Azure NAT Gateway
2 parents cabf329 + 192e5b7 commit cccb6cb

File tree

4 files changed

+133
-24
lines changed

4 files changed

+133
-24
lines changed

‎articles/nat-gateway/monitor-nat-gateway-reference.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Monitoring data reference for Azure NAT Gateway
3+
description: This article contains important reference material you need when you monitor Azure NAT Gateway by using Azure Monitor.
4+
ms.date: 12/02/2024
5+
ms.custom: horz-monitor
6+
ms.topic: reference
7+
author: asudbring
8+
ms.author: allensu
9+
ms.service: azure-nat-gateway
10+
---
11+
# Azure NAT Gateway monitoring data reference
12+
13+
[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
14+
15+
See [Monitor Azure NAT Gateway](monitor-nat-gateway.md) for details on the data you can collect for Azure NAT Gateway and how to use it.
16+
17+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
18+
19+
NAT gateway metrics can be found in the following locations in the Azure portal.
20+
21+
- **Metrics** page under **Monitoring** from a NAT gateway's resource page.
22+
23+
- **Insights** page under **Monitoring** from a NAT gateway's resource page.
24+
25+
:::image type="content" source="./media/nat-metrics/nat-insights-metrics.png" alt-text="Screenshot of the insights and metrics options in NAT gateway overview.":::
26+
27+
- Azure Monitor page under **Metrics**.
28+
29+
:::image type="content" source="./media/nat-metrics/azure-monitor.png" alt-text="Screenshot of the metrics section of Azure Monitor.":::
30+
31+
### Supported metrics for Microsoft.Network/natgateways
32+
33+
The following table lists the metrics available for the Microsoft.Network/natgateways resource type.
34+
35+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
36+
37+
[!INCLUDE [Microsoft.Network/natgateways](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-network-natgateways-metrics-include.md)]
38+
39+
> [!NOTE]
40+
> Count aggregation is not recommended for any of the NAT gateway metrics. Count aggregation adds up the number of metric values and not the metric values themselves. Use Total aggregation instead to get the best representation of data values for connection count, bytes, and packets metrics.
41+
>
42+
> Use Average for best represented health data for the datapath availability metric.
43+
>
44+
> For information about aggregation types, see [aggregation types](/azure/azure-monitor/essentials/metrics-aggregation-explained#aggregation-types).
45+
46+
For more information, see [How to use NAT gateway metrics](nat-metrics.md#how-to-use-nat-gateway-metrics).
47+
48+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
49+
50+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
51+
52+
- ConnectionState: Attempted, Failed
53+
- Direction: In, Out
54+
- Protocol: 6 TCP, 17 UDP
55+
56+
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
57+
58+
- [Microsoft.Network resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftnetwork)
59+
60+
## Related content
61+
62+
- See [Monitor Azure NAT Gateway](monitor-nat-gateway.md) for a description of monitoring Azure NAT Gateway.
63+
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.

‎articles/nat-gateway/monitor-nat-gateway.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Monitor Azure NAT Gateway
3+
description: Start here to learn how to monitor Azure NAT Gateway by using the available Azure Monitor metrics and alerts.
4+
ms.date: 12/02/2024
5+
ms.custom: horz-monitor
6+
ms.topic: conceptual
7+
author: asudbring
8+
ms.author: allensu
9+
ms.service: azure-nat-gateway
10+
---
11+
12+
# Monitor Azure NAT Gateway
13+
14+
[!INCLUDE [azmon-horz-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-intro.md)]
15+
16+
## Collect data with Azure Monitor
17+
18+
This table describes how you can collect data to monitor your service, and what you can do with the data once collected:
19+
20+
|Data to collect|Description|How to collect and route the data|Where to view the data|Supported data|
21+
|---------|---------|---------|---------|---------|
22+
|Metric data|Metrics are numerical values that describe an aspect of a system at a particular point in time. Metrics can be aggregated using algorithms, compared to other metrics, and analyzed for trends over time.|[- Collected automatically at regular intervals.</br> - You can route some platform metrics to a Log Analytics workspace to query with other data. Check the **DS export** setting for each metric to see if you can use a diagnostic setting to route the metric data.]|[Metrics explorer](/azure/azure-monitor/essentials/metrics-getting-started)| [Azure NAT Gateway metrics supported by Azure Monitor](/azure/nat-gateway/monitor-nat-gateway-reference#metrics)|
23+
|Resource log data|Logs are recorded system events with a timestamp. Logs can contain different types of data, and be structured or free-form text. You can route resource log data to Log Analytics workspaces for querying and analysis.|[Create a diagnostic setting](/azure/azure-monitor/essentials/create-diagnostic-settings) to collect and route resource log data.| [Log Analytics](/azure/azure-monitor/learn/quick-create-workspace)|[Azure NAT Gateway resource log data supported by Azure Monitor](/azure/nat-gateway/monitor-nat-gateway-reference#activity-log) |
24+
|Activity log data|The Azure Monitor activity log provides insight into subscription-level events. The activity log includes information like when a resource is modified or a virtual machine is started.|- Collected automatically.</br> - [Create a diagnostic setting](/azure/azure-monitor/essentials/create-diagnostic-settings) to a Log Analytics workspace at no charge.|[Activity log](/azure/azure-monitor/essentials/activity-log)| |
25+
26+
[!INCLUDE [azmon-horz-supported-data](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-supported-data.md)]
27+
28+
## Built in monitoring for Azure NAT Gateway
29+
30+
[Azure Monitor Network Insights](../network-watcher/network-insights-overview.md) allows you to visualize your Azure infrastructure setup and to review all metrics for your NAT gateway resource from a preconfigured metrics dashboard. These visual tools help you diagnose and troubleshoot any issues with your NAT gateway resource.
31+
32+
For more information on NAT Gateway Insights, see [Network Insights](nat-metrics.md#network-insights).
33+
34+
[!INCLUDE [azmon-horz-tools](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-tools.md)]
35+
36+
[!INCLUDE [azmon-horz-export-data](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-export-data.md)]
37+
38+
[!INCLUDE [azmon-horz-kusto](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-kusto.md)]
39+
40+
[!INCLUDE [azmon-horz-alerts-part-one](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-alerts-part-one.md)]
41+
42+
[!INCLUDE [azmon-horz-alerts-part-two](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-alerts-part-two.md)]
43+
44+
[!INCLUDE [azmon-horz-advisor](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-advisor.md)]
45+
46+
## Related content
47+
48+
- See [Azure NAT Gateway monitoring data reference](monitor-nat-gateway-reference.md) for a reference of the metrics, logs, and other important values created for Azure NAT Gateway.
49+
- See [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for general details on monitoring Azure resources.

‎articles/nat-gateway/nat-metrics.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Get started learning about Azure Monitor metrics and alerts availab
55
author: asudbring
66
ms.service: azure-nat-gateway
77
ms.topic: how-to
8-
ms.date: 04/29/2024
8+
ms.date: 09/16/2024
99
ms.author: allensu
1010
# Customer intent: As an IT administrator, I want to understand available Azure Monitor metrics and alerts for Virtual Network NAT.
1111
---
@@ -25,16 +25,9 @@ Azure NAT Gateway provides the following diagnostic capabilities:
2525

2626
## Metrics overview
2727

28-
NAT gateway provides the following multi-dimensional metrics in Azure Monitor:
28+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
2929

30-
| Metric | Description | Recommended aggregation | Dimensions |
31-
|---|---|---|---|
32-
| Bytes | Bytes processed inbound and outbound | Sum | **Direction (In; Out)**, **Protocol (6 TCP; 17 UDP)** |
33-
| Packets | Packets processed inbound and outbound | Sum | **Direction (In; Out)**, **Protocol (6 TCP; 17 UDP)** |
34-
| Dropped Packets | Packets dropped by the NAT gateway | Sum | / |
35-
| SNAT Connection Count | Number of new SNAT connections over a given interval of time | Sum | **Connection State (Attempted, Failed)**, **Protocol (6 TCP; 17 UDP)** |
36-
| Total SNAT Connection Count | Total number of active SNAT connections | Sum | **Protocol (6 TCP; 17 UDP)** |
37-
| Datapath Availability | Availability of the data path of the NAT gateway. Used to determine whether the NAT gateway endpoints are available for outbound traffic flow. | Avg | **Availability (0, 100)** |
30+
[!INCLUDE [Microsoft.Network/natgateways](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-network-natgateways-metrics-include.md)]
3831

3932
>[!NOTE]
4033
> Count aggregation is not recommended for any of the NAT gateway metrics. Count aggregation adds up the number of metric values and not the metric values themselves. Use Sum aggregation instead to get the best representation of data values for connection count, bytes, and packets metrics.
@@ -77,7 +70,7 @@ The following sections detail how to use each NAT gateway metric to monitor, man
7770

7871
### Bytes
7972

80-
The **Bytes** metric shows you the amount of data going outbound through NAT gateway and returning inbound in response to an outbound connection.
73+
The Bytes metric shows you the amount of data going outbound through NAT gateway and returning inbound in response to an outbound connection.
8174

8275
Use this metric to:
8376

@@ -99,11 +92,11 @@ To view the amount of data passing through NAT gateway:
9992

10093
1. To see data processed inbound or outbound as their own individual lines in the metric graph, select **Apply splitting**.
10194

102-
1. In the **Values** drop-down menu, select **Direction (Out | In)**.
95+
1. In the **Values** drop-down menu, select **Direction (Out | In)**.
10396

10497
### Packets
10598

106-
The packets metric shows you the number of data packets passing through NAT gateway.
99+
The Packets metric shows you the number of data packets passing through NAT gateway.
107100

108101
Use this metric to:
109102

@@ -113,9 +106,9 @@ Use this metric to:
113106

114107
To view the number of packets sent in one or both directions through NAT gateway, follow the same steps in the [Bytes](#bytes) section.
115108

116-
### Dropped packets
109+
### Dropped Packets
117110

118-
The dropped packets metric shows you the number of data packets dropped by NAT gateway when traffic goes outbound or returns inbound in response to an outbound connection.
111+
The Dropped Packets metric shows you the number of data packets dropped by NAT gateway when traffic goes outbound or returns inbound in response to an outbound connection.
119112

120113
Use this metric to:
121114

@@ -127,9 +120,9 @@ Possible reasons for dropped packets:
127120

128121
- Outbound connectivity failure can cause packets to drop. Connectivity failure can happen for various reasons. See the [NAT gateway connectivity troubleshooting guide](/azure/nat-gateway/troubleshoot-nat-connectivity) to help you further diagnose.
129122

130-
### SNAT connection count
123+
### SNAT Connection Count
131124

132-
The SNAT connection count metric shows you the number of new SNAT connections within a specified time frame. This metric can be filtered by **Attempted** and **Failed** connection states. A failed connection volume greater than zero can indicate SNAT port exhaustion.
125+
The SNAT Connection Count metric shows you the number of new SNAT connections within a specified time frame. This metric can be filtered by **Attempted** and **Failed** connection states. A failed connection volume greater than zero can indicate SNAT port exhaustion.
133126

134127
Use this metric to:
135128

@@ -159,9 +152,9 @@ To view the connection state of your connections:
159152

160153
:::image type="content" source="./media/nat-metrics/nat-metrics-3.png" alt-text="Screenshot of the metrics configuration.":::
161154

162-
### Total SNAT connection count
155+
### Total SNAT Connection Count
163156

164-
The **Total SNAT connection count** metric shows you the total number of active SNAT connections passing through NAT gateway.
157+
The Total SNAT Connection Count metric shows you the total number of active SNAT connections passing through NAT gateway.
165158

166159
You can use this metric to:
167160

@@ -178,7 +171,7 @@ Possible reasons for failed connections:
178171
>[!NOTE]
179172
> When NAT gateway is attached to a subnet and public IP address, the Azure platform verifies NAT gateway is healthy by conducting health checks. These health checks appear in NAT gateway's SNAT Connection Count metrics. The amount of health check related connections may vary as the health check service is optimized, but is negligible and doesn’t impact NAT gateway’s ability to connect outbound.
180173
181-
### Datapath availability
174+
### Datapath Availability
182175

183176
The datapath availability metric measures the health of the NAT gateway resource over time. This metric indicates if NAT gateway is available for directing outbound traffic to the internet. This metric is a reflection of the health of the Azure infrastructure.
184177

@@ -238,7 +231,7 @@ Setting the aggregation granularity to less than 5 minutes may trigger false pos
238231

239232
### Alerts for SNAT port exhaustion
240233

241-
Set up an alert on the **SNAT connection count** metric to notify you of connection failures on your NAT gateway. A failed connection volume greater than zero can indicate that you reached the connection limit on your NAT gateway or that you hit SNAT port exhaustion. Investigate further to determine the root cause of these failures.
234+
Set up an alert on the **SNAT Connection Count** metric to notify you of connection failures on your NAT gateway. A failed connection volume greater than zero can indicate that you reached the connection limit on your NAT gateway or that you hit SNAT port exhaustion. Investigate further to determine the root cause of these failures.
242235

243236
To create the alert, use the following steps:
244237

@@ -317,7 +310,7 @@ For more information on what each metric is showing you and how to analyze these
317310

318311
### What type of metrics are available for NAT gateway?
319312

320-
The NAT gateway supports [multi-dimensional metrics](/azure/azure-monitor/essentials/data-platform-metrics#multi-dimensional-metrics). You can filter the multi-dimensional metrics by different dimensions to gain greater insight into the provided data. The [SNAT connection count](#snat-connection-count) metric allows you to filter the connections by Attempted and Failed connections, enabling you to distinguish between different types of connections made by the NAT gateway.
313+
The NAT gateway supports [multi-dimensional metrics](/azure/azure-monitor/essentials/data-platform-metrics#multi-dimensional-metrics). You can filter the multi-dimensional metrics by different dimensions to gain greater insight into the provided data. The [SNAT Connection Count](#snat-connection-count) metric allows you to filter the connections by Attempted and Failed connections, enabling you to distinguish between different types of connections made by the NAT gateway.
321314

322315
Refer to the dimensions column in the [metrics overview](#metrics-overview) table to see which dimensions are available for each NAT gateway metric.
323316

‎articles/nat-gateway/toc.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,12 @@ items:
5252
href: nat-gateway-snat.md
5353
- name: NAT gateway design guidance
5454
href: nat-gateway-design.md
55-
- name: How-to
56-
items:
5755
- name: Metrics and alerts
5856
href: nat-metrics.md
57+
- name: How-to
58+
items:
59+
- name: Monitor NAT gateway
60+
href: monitor-nat-gateway.md
5961
- name: Resource health
6062
href: resource-health.md
6163
- name: Manage NAT gateway
@@ -92,6 +94,8 @@ items:
9294
href: /azure/templates/microsoft.network/allversions
9395
- name: Code samples
9496
href: https://azure.microsoft.com/resources/samples/?service=virtual-network
97+
- name: Monitoring data reference
98+
href: monitor-nat-gateway-reference.md
9599
- name: Resources
96100
items:
97101
- name: Build your skills with Microsoft Learn training

0 commit comments

Comments
 (0)