-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add RequestSendType.ROUND_ROBIN for per-request IP round-robin #2202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
56d3bab
2e1712c
97873f5
e9501ff
0754d3b
de383cc
031ddb1
8b7a9d8
b5dd3a4
2c16c7c
0b97c0b
7d929a7
23a2a8b
dde7854
6df084a
9b40baa
46dd22a
8aef29a
05880a5
ca8a32c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| /* | ||
| * Copyright (c) 2026 AsyncHttpClient Project. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.asynchttpclient; | ||
|
|
||
| /** | ||
| * Controls how requests are dispatched to a host that resolves to several IP addresses. | ||
| * | ||
| * <p>Configured globally through {@link AsyncHttpClientConfig#getLoadBalance()}. | ||
| */ | ||
| public enum LoadBalance { | ||
|
|
||
| /** | ||
| * Default behavior. The address list returned by DNS is used in its natural order: a new | ||
| * connection always targets the first address and only falls back to the next one when a TCP | ||
| * connection attempt fails. Combined with connection pooling (keyed by host), this means that | ||
| * with keep-alive enabled essentially all traffic to a host stays on the first reachable IP. | ||
| * | ||
| * <p>To spread traffic across a host's IPs in this mode, configure a resolver that rotates its | ||
| * results, such as {@link io.netty.resolver.RoundRobinInetAddressResolver}; the client keeps | ||
| * targeting the first address, and the resolver is what varies which IP that is. | ||
| */ | ||
| DEFAULT, | ||
|
|
||
| /** | ||
| * Strict per-request round-robin across the host's resolved IPs. | ||
| * | ||
| * <p>For each request, the client rotates which resolved IP is targeted first (TCP failover to | ||
| * the remaining IPs is preserved) and makes connection reuse IP-aware, so that pooled HTTP/1.1 | ||
| * connections and multiplexed HTTP/2 connections are kept and reused per IP rather than per | ||
| * host. The net effect is that consecutive requests to a multi-IP host are spread evenly across | ||
| * all of its addresses, even when connections are kept alive. | ||
| * | ||
| * <p>Notes: | ||
| * <ul> | ||
| * <li>Has no effect for hosts that resolve to a single address, literal-IP hosts, requests | ||
| * with an explicit {@link Request#getAddress() address}, or requests routed through a | ||
| * proxy (HTTP or SOCKS) — the socket is established to the proxy, not directly to the | ||
| * rotated target IPs. (Round-robin still applies when the proxy is bypassed for the host.)</li> | ||
| * <li>Connection limits ({@code maxConnectionsPerHost}) remain per host, not per IP.</li> | ||
| * <li>For HTTP/2 this mode deliberately opens more than one connection to the same host and port | ||
| * — one per resolved IP — so streams can be spread across the host's backends. That is a | ||
| * conscious deviation from RFC 9113 (and RFC 7540) Section 9.1, which recommends that clients | ||
| * SHOULD NOT open more than one HTTP/2 connection to a given host and port pair. | ||
| * {@link #DEFAULT} mode preserves the standard single-connection-per-origin behavior.</li> | ||
| * <li>With HTTP/2 and a finite {@code maxConnectionsPerHost} smaller than the number of resolved | ||
| * IPs, a request pinned to an IP that cannot acquire a per-host connection permit will not | ||
| * multiplex onto a sibling connection already open to a different IP (HTTP/2 connections are | ||
| * pooled per IP in this mode); it fails with {@code TooManyConnectionsPerHostException} | ||
| * instead. The default {@code maxConnectionsPerHost} is unlimited, so this only affects | ||
| * clients that set a finite per-host limit below the resolved-IP count; {@link #DEFAULT} mode | ||
| * would multiplex onto the shared per-host connection.</li> | ||
| * <li>The address order comes straight from the configured | ||
| * {@link io.netty.resolver.InetNameResolver}; this mode does not re-sort it. For the | ||
| * rotation to map consistently across requests, use a resolver that returns the addresses | ||
| * in a stable order and does not deliberately reorder them between resolutions (for | ||
| * example {@link io.netty.resolver.dns.DnsNameResolver}). Do not pair this mode with a | ||
| * resolver that intentionally rotates its results, such as | ||
| * {@link io.netty.resolver.RoundRobinInetAddressResolver} — that one is meant for | ||
| * {@link #DEFAULT} mode, where it provides the spreading instead.</li> | ||
| * <li>Rotation is not health-aware: it always cycles through every IP the resolver returns, so | ||
| * a temporarily unreachable IP keeps receiving its share of requests — each then retried | ||
| * via TCP failover to a healthy IP — until the resolver stops returning it. Which IPs are | ||
| * live is expected to be governed at the DNS/resolver level, as it already is in | ||
| * {@link #DEFAULT} mode.</li> | ||
| * </ul> | ||
| */ | ||
| ROUND_ROBIN | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,15 +15,22 @@ | |
| */ | ||
| package org.asynchttpclient.config; | ||
|
|
||
| import org.asynchttpclient.LoadBalance; | ||
| import org.jetbrains.annotations.Nullable; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.time.Duration; | ||
| import java.util.Arrays; | ||
| import java.util.Locale; | ||
| import java.util.Properties; | ||
|
|
||
| public final class AsyncHttpClientConfigDefaults { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(AsyncHttpClientConfigDefaults.class); | ||
|
|
||
| public static final String ASYNC_CLIENT_CONFIG_ROOT = "org.asynchttpclient."; | ||
| public static final String THREAD_POOL_NAME_CONFIG = "threadPoolName"; | ||
| public static final String MAX_CONNECTIONS_CONFIG = "maxConnections"; | ||
|
|
@@ -52,6 +59,7 @@ public final class AsyncHttpClientConfigDefaults { | |
| public static final String STRICT_302_HANDLING_CONFIG = "strict302Handling"; | ||
| public static final String KEEP_ALIVE_CONFIG = "keepAlive"; | ||
| public static final String MAX_REQUEST_RETRY_CONFIG = "maxRequestRetry"; | ||
| public static final String LOAD_BALANCE_CONFIG = "loadBalance"; | ||
| public static final String DISABLE_URL_ENCODING_FOR_BOUND_REQUESTS_CONFIG = "disableUrlEncodingForBoundRequests"; | ||
| public static final String USE_LAX_COOKIE_ENCODER_CONFIG = "useLaxCookieEncoder"; | ||
| public static final String USE_OPEN_SSL_CONFIG = "useOpenSsl"; | ||
|
|
@@ -373,4 +381,19 @@ public static Duration defaultHttp2PingInterval() { | |
| public static boolean defaultHttp2CleartextEnabled() { | ||
| return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + HTTP2_CLEARTEXT_ENABLED_CONFIG); | ||
| } | ||
|
|
||
| public static LoadBalance defaultLoadBalance() { | ||
| String value = AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getString(ASYNC_CLIENT_CONFIG_ROOT + LOAD_BALANCE_CONFIG); | ||
| if (value == null || value.trim().isEmpty()) { | ||
| return LoadBalance.DEFAULT; | ||
| } | ||
| try { | ||
| return LoadBalance.valueOf(value.trim().toUpperCase(Locale.ROOT)); | ||
| } catch (IllegalArgumentException e) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Quietly falling back to DEFAULT when the value doesn't parse will hide typos in someone's config. A warning log that includes the bad value would make that a lot easier to spot.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed |
||
| LOGGER.warn("Invalid value '{}' for {}{}, falling back to {}. Valid values: {}", | ||
| value, ASYNC_CLIENT_CONFIG_ROOT, LOAD_BALANCE_CONFIG, | ||
| LoadBalance.DEFAULT, Arrays.toString(LoadBalance.values())); | ||
| return LoadBalance.DEFAULT; | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing worth stating outright in these notes: in HTTP/2,
ROUND_ROBINdeliberately opens more than one connection to the same host and port, one per resolved IP, so streams can be spread across the host's backends. That goes against the recommendation in RFC 9113 (and RFC 7540) Section 9.1 that clients SHOULD NOT open more than one HTTP/2 connection to a given host and port pair. Since this is a SHOULD, not a MUST, and distributing streams across multiple backend endpoints is a legitimate reason to deviate, this is not a protocol conformance issue. However, it is a conscious tradeoff that differs from the default behavior, so it is worth documenting to avoid surprising users who enable this mode expecting HTTP/2's usual single connection per origin.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done