Skip to content

Commit 5dc7ae1

Browse files
author
Jill Grant
authored
Merge pull request #281881 from TimShererWithAquent/us248136s
Q&M Convert 20 services v3 template: Azure Load Balancer
2 parents 793a370 + 705ac1e commit 5dc7ae1

File tree

3 files changed

+129
-165
lines changed

3 files changed

+129
-165
lines changed

‎articles/load-balancer/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
href: instance-metadata-service-load-balancer.md
129129
- name: Health monitoring
130130
items:
131-
- name: Monitor load balancer
131+
- name: Monitor Load Balancer
132132
href: monitor-load-balancer.md
133133
- name: Monitoring data reference
134134
href: monitor-load-balancer-reference.md

‎articles/load-balancer/monitor-load-balancer-reference.md

Lines changed: 77 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,105 @@
11
---
2-
title: Load balancer metrics and log definitions
3-
titleSuffix: Azure Load Balancer
4-
description: Important reference material needed when you monitor Load Balancer.
5-
author: mbender-ms
2+
title: Monitoring data reference for Azure Load Balancer
3+
description: This article contains important reference material you need when you monitor Azure Load Balancer by using Azure Monitor.
4+
ms.date: 08/21/2024
5+
ms.custom: horz-monitor
66
ms.topic: reference
7+
author: mbender-ms
78
ms.author: mbender
89
ms.service: azure-load-balancer
9-
ms.date: 05/24/2024
10-
ms.custom: subject-monitoring
1110
---
1211

13-
# Monitoring load balancer data reference
12+
# Azure Load Balancer monitoring data reference
13+
14+
[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
15+
16+
See [Monitor Azure Load Balancer](monitor-load-balancer.md) for details on the data you can collect for Load Balancer and how to use it.
17+
18+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
19+
20+
### Supported metrics for Microsoft.Network/loadBalancers
21+
22+
The following table lists the metrics available for the Microsoft.Network/loadBalancers resource type.
23+
24+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
25+
26+
<!-- [!INCLUDE [Microsoft.Network/loadBalancers](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-network-loadbalancers-metrics-include.md)] -->
27+
28+
<!-- Manually included due to inprocess dimensions. Once those dimensions are completed, please reinstate this include and remove the manual copy. Please do not remove this comment. rboucher 2024_08_23 -->
1429

15-
See [Monitoring Load Balancer](monitor-load-balancer.md) for details on collecting and analyzing monitoring data for Load Balancer.
30+
|Metric|Name in REST API|Unit|Aggregation|Dimensions|Time Grains|DS Export|
31+
|---|---|---|---|---|---|---|
32+
|**Allocated SNAT Ports**<br><br>Total number of SNAT ports allocated within time period |`AllocatedSnatPorts` |Count |Average |`FrontendIPAddress`, `BackendIPAddress`, `ProtocolType` |PT1M |No|
33+
|**Byte Count**<br><br>Total number of Bytes transmitted within time period |`ByteCount` |Bytes |Total |`FrontendIPAddress`, `FrontendPort`, `Direction`|PT1M |Yes|
34+
|**Health Probe Status**<br><br>Average Load Balancer health probe status per time duration |`DipAvailability` |Count |Average |`ProtocolType`, `BackendPort`, `FrontendIPAddress`, `FrontendPort`, `BackendIPAddress`|PT1M |Yes|
35+
|**Health Probe Status**<br><br>Azure Cross-region Load Balancer backend health and status per time duration |`GlobalBackendAvailability` |Count |Average |`FrontendIPAddress`, `FrontendPort`, `BackendIPAddress`, `ProtocolType` |PT1M |Yes|
36+
|**Packet Count**<br><br>Total number of Packets transmitted within time period |`PacketCount` |Count |Total |`FrontendIPAddress`, `FrontendPort`, `Direction`|PT1M |Yes|
37+
|**SNAT Connection Count**<br><br>Total number of new SNAT connections created within time period |`SnatConnectionCount` |Count |Total |`FrontendIPAddress`, `BackendIPAddress`, `ConnectionState`|PT1M |Yes|
38+
|**SYN Count**<br><br>Total number of SYN Packets transmitted within time period |`SYNCount` |Count |Total |`FrontendIPAddress`, `FrontendPort`, `Direction`|PT1M |Yes|
39+
|**Used SNAT Ports**<br><br>Total number of SNAT ports used within time period |`UsedSnatPorts` |Count |Average |`FrontendIPAddress`, `BackendIPAddress`, `ProtocolType` |PT1M |No|
40+
|**Data Path Availability**<br><br>Average Load Balancer data path availability per time duration |`VipAvailability` |Count |Average |`FrontendIPAddress`, `FrontendPort`|PT1M |Yes|
1641

17-
## Metrics
42+
### Load balancer metrics
1843

19-
### Load balancer metrics
44+
This table includes additional information about metrics from the Microsoft.Network/loadBalancers table:
2045

21-
| **Metric** | **Resource type** | **Description** | **Recommended aggregation** |
22-
| ------ | ------------- | ----------- | ----------------------- |
23-
| Data path availability | Public and internal load balancer | Standard Load Balancer continuously exercises the data path from within a region to the load balancer front end, all the way to the SDN stack that supports your VM. As long as healthy instances remain, the measurement follows the same path as your application's load-balanced traffic. The data path that your customer's use is also validated. The measurement is invisible to your application and doesn't interfere with other operations. | Average |
24-
| Health probe status | Public and internal load balancer | Standard Load Balancer uses a distributed health-probing service that monitors your application endpoint's health according to your configuration settings. This metric provides an aggregate or per-endpoint filtered view of each instance endpoint in the load balancer pool. You can see how Load Balancer views the health of your application, as indicated by your health probe configuration. | Average |
25-
| SYN (synchronize) count | Public and internal load balancer | Standard Load Balancer doesn’t terminate Transmission Control Protocol (TCP) connections or interact with TCP or User Data-gram Packet (UDP) flows. Flows and their handshakes are always between the source and the VM instance. To better troubleshoot your TCP protocol scenarios, you can make use of SYN packets counters to understand how many TCP connection attempts are made. The metric reports the number of TCP SYN packets that were received. | Average |
26-
| SNAT connection count | Public load balancer | Standard Load Balancer reports the number of outbound flows that are masqueraded to the Public IP address front end. Source network address translation (SNAT) ports are an exhaustible resource. This metric can give an indication of how heavily your application is relying on SNAT for outbound originated flows. Counters for successful and failed outbound SNAT flows are reported and can be used to troubleshoot and understand the health of your outbound flows. | Sum |
27-
| Allocated SNAT ports | Public load balancer | Standard Load Balancer reports the number of SNAT ports allocated per backend instance. | Average |
28-
| Used SNAT ports | Public load balancer | Standard Load Balancer reports the number of SNAT ports that are utilized per backend instance. | Average |
29-
| Byte count | Public and internal load balancer | Standard Load Balancer reports the data processed per front end. You may notice that the bytes aren't distributed equally across the backend instances. This is expected as Azure's Load Balancer algorithm is based on flows. | Sum |
30-
| Packet count | Public and internal load balancer | Standard Load Balancer reports the packets processed per front end. | Sum |
46+
| Metric | Resource type | Description |
47+
|:------ |:------------- |:----------- |
48+
| Allocated SNAT ports | Public load balancer | Standard Load Balancer reports the number of SNAT ports allocated per backend instance. |
49+
| Byte count | Public and internal load balancer | Standard Load Balancer reports the data processed per front end. You might notice that the bytes aren't distributed equally across the backend instances. This behavior is expected as Azure's Load Balancer algorithm is based on flows. |
50+
| Health probe status | Public and internal load balancer | Standard Load Balancer uses a distributed health-probing service that monitors your application endpoint's health according to your configuration settings. This metric provides an aggregate or per-endpoint filtered view of each instance endpoint in the load balancer pool. You can see how Load Balancer views the health of your application, as indicated by your health probe configuration. |
51+
| SNAT connection count | Public load balancer | Standard Load Balancer reports the number of outbound flows that are masqueraded to the Public IP address front end. Source network address translation (SNAT) ports are an exhaustible resource. This metric can give an indication of how heavily your application is relying on SNAT for outbound originated flows. Counters for successful and failed outbound SNAT flows are reported and can be used to troubleshoot and understand the health of your outbound flows. |
52+
| SYN count (synchronize) | Public and internal load balancer | Standard Load Balancer doesn’t terminate Transmission Control Protocol (TCP) connections or interact with TCP or User Data-gram Packet (UDP) flows. Flows and their handshakes are always between the source and the virtual machine instance. To better troubleshoot your TCP protocol scenarios, you can make use of SYN packets counters to understand how many TCP connection attempts are made. The metric reports the number of TCP SYN packets that were received. |
53+
| Used SNAT ports | Public load balancer | Standard Load Balancer reports the number of SNAT ports that are utilized per backend instance. |
54+
| Data path availability | Public and internal load balancer | Standard Load Balancer continuously exercises the data path from within a region to the load balancer front end, all the way to the SDN stack that supports your virtual machine. As long as healthy instances remain, the measurement follows the same path as your application's load-balanced traffic. The data path that your customer's use is also validated. The measurement is invisible to your application and doesn't interfere with other operations. |
3155

3256
### Global load balancer metrics
3357

34-
| **Metric** | **Resource type** | **Description** | **Recommended aggregation** |
35-
| ------ | ------------- | ----------- | ----------------------- |
36-
| Data path availability | Public global load balancer| Global load balancer continuously exercises the data path from within a region to the load balancer front end, all the way to the SDN stack that supports your VM. As long as healthy instances remain, the measurement follows the same path as your application's load-balanced traffic. The data path that your customer's use is also validated. The measurement is invisible to your application and doesn't interfere with other operations. | Average |
37-
| Health probe status | Public global load balancer | Global load balancer uses a distributed health-probing service that monitors your application endpoint's health according to your configuration settings. This metric provides an aggregate or per-endpoint filtered view of each instance regional load balancer in the global load balancer's backend pool. You can see how global load balancer views the health of your application, as indicated by your health probe configuration. | Average |
58+
This table includes additional information about global metrics from the Microsoft.Network/loadBalancers table:
3859

39-
For more information, see a list of [all platform metrics supported in Azure Monitor for load balancer](../azure-monitor/essentials/metrics-supported.md#microsoftnetworkloadbalancers).
60+
| Metric | Resource type | Description |
61+
|:------ |:------------- |:----------- |
62+
| Health probe status | Public global load balancer | Global load balancer uses a distributed health-probing service that monitors your application endpoint's health according to your configuration settings. This metric provides an aggregate or per-endpoint filtered view of each instance regional load balancer in the global load balancer's backend pool. You can see how global load balancer views the health of your application, as indicated by your health probe configuration. |
63+
| Data path availability | Public global load balancer| Global load balancer continuously exercises the data path from within a region to the load balancer front end, all the way to the SDN stack that supports your virtual machine. As long as healthy instances remain, the measurement follows the same path as your application's load-balanced traffic. The data path that your customer's use is also validated. The measurement is invisible to your application and doesn't interfere with other operations. |
4064

41-
## Metric dimensions
65+
> [!NOTE]
66+
> Bandwidth-related metrics such as SYN packet, byte count, and packet count doesn't capture any traffic to an internal load balancer by using a UDR, such as from an NVA or firewall.
67+
>
68+
> Max and min aggregations are not available for the SYN count, packet count, SNAT connection count, and byte count metrics.
69+
> Count aggregation is not recommended for Data path availability and health probe status. Use average instead for best represented health data.
4270
43-
For more information on what metric dimensions are, see [Multi-dimensional metrics](../azure-monitor/essentials/data-platform-metrics.md#multi-dimensional-metrics).
71+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
4472

45-
Load Balancer has the following **dimensions** associated with its metrics.
73+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
4674

47-
| **Dimension Name** | **Description** |
48-
| -------------- | ----------- |
49-
| Frontend IP | The frontend IP address of one or more relevant load balancing rules |
50-
| Frontend Port | The frontend port of one or more relevant load balancing rules |
51-
| Backend IP | The backend IP address of one or more relevant load balancing rules |
52-
| Backend Port | The backend port of one or more relevant load balancing rules |
53-
| Protocol Type | The protocol of the relevant load balancing rule. The protocol can be TCP or UDP |
54-
| Direction | The direction traffic is flowing. This can be inbound or outbound. |
55-
| Connection state | The state of SNAT connection. The state can be pending, successful, or failed |
75+
| Dimension | Name | Description |
76+
|:----------|:-----|:------------|
77+
| BackendIPAddress | Backend IP | The backend IP address of one or more relevant load balancing rules |
78+
| BackendPort | Backend Port | The backend port of one or more relevant load balancing rules |
79+
| ConnectionState | Connection state | The state of SNAT connection. The state can be pending, successful, or failed |
80+
| Direction | Direction | The direction traffic is flowing. This value can be inbound or outbound. |
81+
| FrontendIPAddress | Frontend IP | The frontend IP address of one or more relevant load balancing rules |
82+
| FrontendPort | Frontend Port | The frontend port of one or more relevant load balancing rules |
83+
| ProtocolType | Protocol Type | The protocol of the relevant load balancing rule. The protocol can be TCP or UDP |
5684

57-
## Resource logs
85+
[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
5886

59-
Azure Load Balancer supports Azure Activity logs and the LoadBalancerHealthEvent log category.
87+
### Supported resource logs for Microsoft.Network/loadBalancers
6088

61-
### LoadBalancerHealthEvent logs
89+
[!INCLUDE [<ResourceType/namespace>](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-network-loadbalancers-logs-include.md)]
6290

63-
For more information on the LoadBalancerHealthEvent log category, see [Azure Load Balancer health event logs](load-balancer-health-event-logs.md).
91+
[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
6492

65-
### Azure Activity logs
93+
### Load Balancer Microsoft.Network/LoadBalancers
6694

67-
The following table lists the **operations** related to Load Balancer that may be created in the Activity log.
95+
- [ALBHealthEvent](/azure/azure-monitor/reference/tables/albhealthevent#columns)
96+
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
6897

69-
| **Operation** | **Description** |
70-
| --- | --- |
71-
| Microsoft.Network/loadBalancers/read | Gets a load balancer definition |
72-
| Microsoft.Network/loadBalancers/write | Creates a load balancer or updates an existing load balancer |
73-
| Microsoft.Network/loadBalancers/delete | Deletes a load balancer |
74-
| Microsoft.Network/loadBalancers/backendAddressPools/queryInboundNatRulePortMapping/action | Query inbound Nat rule port mapping. |
75-
| Microsoft.Network/loadBalancers/backendAddressPools/read | Gets a load balancer backend address pool definition |
76-
| Microsoft.Network/loadBalancers/backendAddressPools/write | Creates a load balancer backend address pool or updates an existing load balancer backend address pool |
77-
| Microsoft.Network/loadBalancers/backendAddressPools/delete | Deletes a load balancer backend address pool |
78-
| Microsoft.Network/loadBalancers/backendAddressPools/join/action | Joins a load balancer backend address pool. Not Alertable. |
79-
| Microsoft.Network/loadBalancers/backendAddressPools/backendPoolAddresses/read | Lists the backend addresses of the Load Balancer backend address pool |
80-
| Microsoft.Network/loadBalancers/frontendIPConfigurations/read | Gets a load balancer frontend IP configuration definition |
81-
| Microsoft.Network/loadBalancers/frontendIPConfigurations/join/action | Joins a Load Balancer Frontend IP Configuration. Not alertable. |
82-
| Microsoft.Network/loadBalancers/inboundNatPools/read | Gets a load balancer inbound nat pool definition |
83-
| Microsoft.Network/loadBalancers/inboundNatPools/join/action | Joins a load balancer inbound NAT pool. Not alertable. |
84-
| Microsoft.Network/loadBalancers/inboundNatRules/read | Gets a load balancer inbound nat rule definition |
85-
| Microsoft.Network/loadBalancers/inboundNatRules/write | Creates a load balancer inbound nat rule or updates an existing load balancer inbound nat rule |
86-
| Microsoft.Network/loadBalancers/inboundNatRules/delete | Deletes a load balancer inbound nat rule |
87-
| Microsoft.Network/loadBalancers/inboundNatRules/join/action | Joins a load balancer inbound nat rule. Not Alertable. |
88-
| Microsoft.Network/loadBalancers/loadBalancingRules/read | Gets a load balancer load balancing rule definition |
89-
| Microsoft.Network/loadBalancers/networkInterfaces/read | Gets references to all the network interfaces under a load balancer |
90-
| Microsoft.Network/loadBalancers/outboundRules/read | Gets a load balancer outbound rule definition |
91-
| Microsoft.Network/loadBalancers/probes/read | Gets a load balancer probe |
92-
| Microsoft.Network/loadBalancers/probes/join/action | Allows using probes of a load balancer. For example, with this permission healthProbe property of virtual machine scale set can reference the probe. Not alertable. |
93-
| Microsoft.Network/loadBalancers/virtualMachines/read | Gets references to all the virtual machines under a load balancer |
98+
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
9499

95-
For more information on the schema of Activity Log entries, see [Activity Log schema](../azure-monitor/essentials/activity-log-schema.md).
100+
- [Microsoft.Network resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftnetwork)
96101

97-
## See Also
102+
## Related content
98103

99-
- See [Monitoring Azure Load Balancer](./monitor-load-balancer.md) for a description of monitoring Azure Load Balancer.
104+
- See [Monitor Azure Load Balancer](monitor-load-balancer.md) for a description of monitoring Load Balancer.
105+
- 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)