grpc/grpc-java

Add support for HAProxy Protocol ("proxy protocol")

Open

#8,949 opened on Feb 28, 2022

View on GitHub
 (12 comments) (0 reactions) (0 assignees)Java (11,124 stars) (3,742 forks)batch import
enhancementhelp wanted

Description

Is there a way to add a CustomHandler to ChannelPipeline using NettyServerBuilder ?

I initialize my GrpcNettyServer by below:

NettyServerBuilder serverBuilder = 
    NettyServerBuilder
      .forPort(config.getPort())
      .addService();
      .intercept();
      .executor();
      .build();

All I want is to get the channel from the server and add a custom handler to the channel pipeline. Does NettyServerBuilder supports that option ?

Contributor guide

Tech stack
java
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Java programminggRPC knowledgeNetty basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how to add a custom ChannelHandler to the Netty pipeline in gRPC Java. Look at NettyServerBuilder and the ServerImpl classes to find where the pipeline is configured. The HAProxy protocol requires reading the proxy protocol header before the gRPC handler. Consider using a custom ServerBuilder or intercepting the channel initialization. Review existing PRs or comments in this issue for pointers. Check the Netty documentation for HAProxy support.