Skip to content
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.

Sign up for GitHub

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

[improve][broker] Add haProxyProtocolEnabled more description #19967

Merged
merged 2 commits into from
May 10, 2023
Merged

[improve][broker] Add haProxyProtocolEnabled more description #19967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a87627b
[improve][broker] Add haProxyProtocolEnabled description
crossoverJie Mar 29, 2023
6392a08
Merge branch 'master' into add-proxy-doc
tisonkun May 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions conf/broker.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ advertisedAddress=
# internalListenerName=

# Enable or disable the HAProxy protocol.
# If true, the real IP addresses of consumers and producers can be obtained when getting topic statistics data.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Real might be misleading here. I think the IP address is the remote IP address from the proxy's perspective? If you agree, I think we should clarify further to prevent confusion. This is relevant when traffic ingresses to the proxy through any kind of NAT. A good example is a kubernetes load balancer with externalTrafficPolicy: cluster.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also found this setting very misleading the first time I encountered it. We're not really even using the HA Proxy protocol. It seems that we appropriated the protocol message to propagate the client IP address, which seems worth documenting since the HAProxy part is largely irrelevant here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like I might be somewhat mistaken. This PR has some relevant details #16045. The edge case is that you can get the "wrong" address if the inbound connection to the pulsar proxy does not start with the HAProxy message. Here is the relevant code:

pulsar/pulsar-proxy/src/main/java/org/apache/pulsar/proxy/server/DirectProxyHandler.java

Lines 240 to 261 in 1545396

private void writeHAProxyMessage() {
if (proxyConnection.hasHAProxyMessage()) {
final ByteBuf msg = encodeProxyProtocolMessage(proxyConnection.getHAProxyMessage());
writeAndFlush(msg);
} else {
if (inboundChannel.remoteAddress() instanceof InetSocketAddress
&& inboundChannel.localAddress() instanceof InetSocketAddress) {
InetSocketAddress clientAddress = (InetSocketAddress) inboundChannel.remoteAddress();
String sourceAddress = clientAddress.getAddress().getHostAddress();
int sourcePort = clientAddress.getPort();
InetSocketAddress proxyAddress = (InetSocketAddress) inboundChannel.localAddress();
String destinationAddress = proxyAddress.getAddress().getHostAddress();
int destinationPort = proxyAddress.getPort();
HAProxyMessage msg = new HAProxyMessage(HAProxyProtocolVersion.V1, HAProxyCommand.PROXY,
HAProxyProxiedProtocol.TCP4, sourceAddress, destinationAddress, sourcePort,
destinationPort);
final ByteBuf encodedMsg = encodeProxyProtocolMessage(msg);
writeAndFlush(encodedMsg);
msg.release();
}
}
}

haProxyProtocolEnabled=false

# Number of threads to config Netty Acceptor. Default is 1
Expand Down
1 change: 1 addition & 0 deletions conf/proxy.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ bindAddress=0.0.0.0
advertisedAddress=

# Enable or disable the HAProxy protocol.
# If true, the real IP addresses of consumers and producers can be obtained when getting topic statistics data.
haProxyProtocolEnabled=false

# Enables zero-copy transport of data across network interfaces using the splice system call.
Expand Down
1 change: 1 addition & 0 deletions conf/standalone.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ bindAddresses=
advertisedAddress=

# Enable or disable the HAProxy protocol.
# If true, the real IP addresses of consumers and producers can be obtained when getting topic statistics data.
haProxyProtocolEnabled=false

# Number of threads to use for Netty IO. Default is set to 2 * Runtime.getRuntime().availableProcessors()
Expand Down
4 changes: 3 additions & 1 deletion pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,9 @@ public class ServiceConfiguration implements PulsarConfiguration {
private String bindAddresses;

@FieldContext(category = CATEGORY_SERVER,
doc = "Enable or disable the proxy protocol.")
doc = "Enable or disable the proxy protocol."
+ " If true, the real IP addresses of consumers and producers can be obtained"
+ " when getting topic statistics data.")
private boolean haProxyProtocolEnabled;

@FieldContext(
Expand Down