Try it free

Set up load balancer

  • How-to guide
  • 5-min read

To set up an external load balancer as an additional load-balancing tier in front of your Managed Cluster, follow the steps below.

For how NGINX load-balances traffic between Cluster nodes and when to add an external load balancer, see Load balancing in Dynatrace Managed.

Configuration guidelines

Load balancer configuration depends on how the particular load balancer will be used. The following are general guidelines.

Target configuration

The list of target nodes should contain IP addresses of Cluster nodes intended to receive the web traffic, including user-generated traffic and REST API calls. Typically, the list should contain all Cluster nodes. This list needs to be updated after node join or removal.

In the Cluster Management Console (CMC), you can exclude a node from web UI traffic. This feature affects the NGINX configuration and the automatically provisioned domain (xyz.dynatrace-managed.com). When you use an external load balancer, nodes need to be excluded from the list of target nodes; otherwise, they will still receive network traffic. For details, see Configure Cluster node capabilities.

Forward traffic to HTTPS port 443 of NGINX. Do not alter the request path or parameters in any way; custom path suffixes are not supported.

Timeouts

Set the timeout value for the target response to no less than what's configured in NGINX by default (120 seconds).

Health checks

Configure health checks for all of the target nodes. If you don't configure health checks for all of the target nodes, the load balancer might attempt to forward traffic to a node that isn't monitored by the health check and that might be down due to failure.

Use the /rest/health endpoint for the health check, with an expected response code of HTTP 200.

Session persistence and affinity

Session persistence and affinity are configured and realized by the Dynatrace Managed Cluster. No configuration is required.

Domain and certificates

Optional

Configuration of a domain name pointing to the load balancer and a TLS certificate is optional. You can disable the automatic domain and certificate handling option of Dynatrace. For details, see Configure DNS entries.

Configure load balancer

Configure the endpoint settings that match the traffic types you want to route through the external load balancer.

Configure web UI traffic

Configure OneAgent traffic

Configure real user monitoring, mobile, and Synthetic traffic

Configure web UI traffic

If you plan to use the load balancer for web UI traffic, configure the following setting in addition to the general guidelines.

Public endpoint configuration

  1. In the CMC, go to Settings > Public endpoints.
  2. Adjust Dynatrace Web UI URL to point to your load balancer.
Chat not available

If you change the Dynatrace Web UI URL, or if more than one domain points to your Managed Cluster, in-product chat assistance might be affected.

Restore in-product chat assistance

  1. Add every domain that reaches your Managed Cluster as an additional address. Send a POST request to /endpoint/additionalWebUiAddresses with the following body. For authentication and the full request, see Post cluster UI addresses used for help chat.

    {
    "additionalAddresses": ["https://<your-domain>"]
    }

    The request replaces the existing list, so include all additional addresses.

  2. In the CMC, go to Settings > Public endpoints. The addresses appear under Additional addresses, below Dynatrace Web UI URL.

Configure OneAgent traffic

Load balancing is less needed for OneAgent traffic because OneAgent is capable of switching between endpoints and performing client-side load balancing. If you plan to use the load balancer for OneAgent traffic, configure the following setting in addition to the general guidelines.

OneAgent endpoint configuration

  1. In the CMC, go to Deployment Status > Cluster nodes.
  2. On each node's details page, select Configure and, in Customize node endpoints, adjust IP address and port for OneAgent traffic to point to the load balancer and not to the node directly.

Configure real user monitoring, mobile, and Synthetic traffic

If you plan to use the load balancer where agentless real user monitoring (RUM) or mobile app monitoring is used, Dynatrace recommends configuring a load balancer, either in front of Cluster ActiveGates or directly in front of the Managed Cluster. Due to the possibility of high-volume TLS connection and request spikes, offloading TLS termination to a load balancer is beneficial, particularly if the load balancer has hardware-accelerated TLS handling or autoscaling capabilities. TLS offloading can shield the Managed Cluster from overload and separate the access path between beacon traffic and web UI and OneAgent traffic.

If you plan to use the load balancer for RUM, mobile, and Synthetic traffic, configure the following setting in addition to the general guidelines.

Public endpoint configuration

  1. In the CMC, go to Settings > Public endpoints.
  2. Adjust Cluster ActiveGate URL to point to your load balancer.
    You can do it even if you don't have any Cluster ActiveGates or the load balancer points directly to the Managed Cluster.