Troubleshooting intermittent outbound connection errors in Azure App Service
This article helps you troubleshoot intermittent connection errors and related performance issues in Azure App Service. This topic will provide more information on, and troubleshooting methodologies for, exhaustion of source address network translation (SNAT) ports. If you require more help at any point in this article, contact the Azure experts at the Azure support. Alternatively, file an Azure support incident. Go to the Azure Support site.
Symptoms
Applications and Functions hosted on Azure App service may exhibit one or more of the following symptoms:
- Slow response times on all or some of the instances in a service plan.
- Intermittent 5xx or Bad Gateway errors
- Timeout error messages
- Couldn't connect to external endpoints (like SQLDB, Service Fabric, other App services etc.)
Cause
The major cause for intermittent connection issues is hitting a limit while making new outbound connections. The limits you can hit include:
- TCP Connections: There's a limit on the number of outbound connections that can be made. The limit on outbound connections is associated with the size of the worker used.
- SNAT ports: Outbound connections in Azure describes SNAT port restrictions and how they affect outbound connections. Azure uses source network address translation (SNAT) and Load Balancers (not exposed to customers) to communicate with public IP addresses. Each instance on Azure App service is initially given a preallocated number of 128 SNAT ports. The SNAT port limit affects opening connections to the same address and port combination. If your app creates connections to a mix of address and port combinations, you won't use up your SNAT ports. The SNAT ports are used up when you have repeated calls to the same address and port combination. Once a port has been released, the port is available for reuse as needed. The Azure Network load balancer reclaims SNAT port from closed connections only after waiting for 4 minutes.
When applications or functions rapidly open a new connection, they can quickly exhaust their preallocated quota of the 128 ports. They're then blocked until a new SNAT port becomes available, either through dynamically allocating more SNAT ports, or through reuse of a reclaimed SNAT port. If your app runs out of SNAT ports, it will have intermittent outbound connectivity issues.
Avoiding the problem
There are a few solutions that let you avoid SNAT port limitations. They include:
- connection pools: By pooling your connections, you avoid opening new network connections for calls to the same address and port.
- service endpoints: You don't have a SNAT port restriction to the services secured with service endpoints.
- private endpoints: You don't have a SNAT port restriction to services secured with private endpoints.
- NAT gateway: With a NAT gateway, you have 64k outbound SNAT ports that are usable by the resources sending traffic through it.
To avoid the SNAT port problem, you prevent the creation of new connections repetitively to the same host and port. Connection pools are one of the more obvious ways to solve that problem.
If your destination is an Azure service that supports service endpoints, you can avoid SNAT port exhaustion issues by using regional VNet Integration and service endpoints or private endpoints. When you use regional VNet Integration and place service endpoints on the integration subnet, your app outbound traffic to those services won't have outbound SNAT port restrictions. Likewise, if you use regional VNet Integration and private endpoints, you won't have any outbound SNAT port issues to that destination.
If your destination is an external endpoint outside of Azure, using a NAT gateway gives you 64k outbound SNAT ports. It also gives you a dedicated outbound address that you don't share with anybody.
If possible, improve your code to use connection pools and avoid the entire situation. It isn't always possible to change code fast enough to mitigate this situation. For the cases where you can't change your code in time, take advantage of the other solutions. The best solution to the problem is to combine all of the solutions as best you can. Try to use service endpoints and private endpoints to Azure services and the NAT gateway for the rest.
General strategies for mitigating SNAT port exhaustion are discussed in the Problem-solving section of the Outbound connections of Azure documentation. Of these strategies, the following are applicable to apps and functions hosted on Azure App service.
Modify the application to use connection pooling
- For pooling HTTP connections, review Pool HTTP connections with HttpClientFactory.
- For information on SQL Server connection pooling, review SQL Server Connection Pooling (ADO.NET).
Here's a collection of links for implementing Connection pooling by different solution stack.
Node
By default, connections for NodeJS aren't kept alive. Below are the popular databases and packages for connection pooling which contain examples for how to implement them.
HTTP Keep-alive
Java
Below are the popular libraries used for JDBC connection pooling which contain examples for how to implement them: JDBC Connection Pooling.
HTTP Connection Pooling
PHP
Although PHP doesn't support connection pooling, you can try using persistent database connections to your back-end server.
MySQL server
- MySQLi connections for newer versions
- mysql_pconnect for older versions of PHP
Other data Sources
Python
Below are the popular databases and modules for connection pooling which contain examples for how to implement them.
HTTP Connection Pooling
Modify the application to reuse connections
- For more pointers and examples on managing connections in Azure functions, review Manage connections in Azure Functions.
Modify the application to use less aggressive retry logic
- For more guidance and examples, review Retry pattern.
Use keepalives to reset the outbound idle timeout
- For implementing keepalives for Node.js apps, review My node application is making excessive outbound calls.
More guidance specific to App Service:
- Scale out the App Service plan to more instances. For more information on scaling, see Scale an app in Azure App Service. Each worker instance in an app service plan is allocated a number of SNAT ports. If you spread your usage across more instances, you might get the SNAT port usage per instance below the recommended limit of 100 outbound connections, per unique remote endpoint.
- Consider moving to App Service Environment (ASE), where you're allotted a single outbound IP address, and the limits for connections and SNAT ports are higher. In an ASE, the number of SNAT ports per instance is based on the Azure load balancer preallocation table. For example, an ASE with 1-50 worker instances has 1024 preallocated ports per instance, while an ASE with 51-100 worker instances has 512 preallocated ports per instance.
Avoiding the outbound TCP limits is easier to solve, as the limits are set by the size of your worker. You can see the limits in Sandbox Cross VM Numerical Limits - TCP Connections
Limit name | Description | Small (A1) | Medium (A2) | Large (A3) | Isolated tier (ASE) |
---|---|---|---|---|---|
Connections | Number of connections across entire VM | 1920 | 3968 | 8064 | 16,000 |
To avoid outbound TCP limits, you can either increase the size of your workers, or scale out horizontally.
Troubleshooting
Knowing the two types of outbound connection limits, and what your app does, should make it easier to troubleshoot. If you know that your app makes many calls to the same storage account, you might suspect a SNAT limit. If your app creates a great many calls to endpoints all over the internet, you would suspect you're reaching the VM limit.
If you don't know the application behavior enough to determine the cause quickly, there are some tools and techniques available in App Service to help with that determination.
Find SNAT port allocation information
- To access App Service diagnostics, navigate to your App Service web app or App Service Environment in the Azure portal. In the left navigation, select Diagnose and solve problems.
- Select Availability and Performance Category
- Select SNAT Port Exhaustion tile in the list of available tiles under the category. The practice is to keep it below 128. If you do need it, you can still open a support ticket, and the support engineer will get the metric from back-end for you.
Since SNAT port usage isn't available as a metric, it isn't possible to either autoscale based on SNAT port usage, or to configure auto scale based on SNAT ports allocation metric.
TCP Connections and SNAT Ports
TCP connections and SNAT ports aren't directly related. A TCP connections usage detector is included in the Diagnose and Solve Problems management page of any App Service app. Search for the phrase "TCP connections" to find it.
- The SNAT Ports are only used for external network flows, while the total TCP Connections includes local loopback connections.
- A SNAT port can be shared by different flows, if the flows are different in either protocol, IP address or port. The TCP Connections metric counts every TCP connection.
- The TCP connections limit happens at the worker instance level. The Azure Network outbound load balancing doesn't use the TCP Connections metric for SNAT port limiting.
- The TCP connections limits are described in Sandbox Cross VM Numerical Limits - TCP Connections
- Existing TCP sessions fail when new outbound TCP sessions are added from Azure App Service source port. You can either use a single IP or reconfigure backend pool members to avoid conflicts.
Limit name | Description | Small (A1) | Medium (A2) | Large (A3) | Isolated tier (ASE) |
---|---|---|---|---|---|
Connections | Number of connections across entire VM | 1920 | 3968 | 8064 | 16,000 |
WebJobs and Database connections
If SNAT ports are exhausted, and WebJobs are unable to connect to SQL Database, there's no metric to show how many connections are opened by each individual web application process. To find the problematic WebJob, move several WebJobs out to another App Service plan to see if the situation improves, or if an issue remains in one of the plans. Repeat the process until you find the problematic WebJob.