envoyproxy/envoy

Setting TLVs in Proxy Protocol V2 header

Open

#18,520 opened on Oct 8, 2021

View on GitHubContributor guide
 (8 comments) (9 reactions) (0 assignees)C++ (5,373 forks)batch import
area/proxy_protohelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Title: Setting TLVs in Proxy Protocol V2 header

Description: Proxy Protocol V2 allows application specific TLVs in the header (https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt). Currently, the listener filter for proxy protocol has mechanism to read those TLVs but the upstream transport socket for PPV2 does not allow setting your own TLVs. It would be helpful because proxy protocol can then carry addition information such as instance id, cluster name etc.

Contributor guide

Research direction
Implement a mechanism to set custom TLVs in the upstream transport socket for Proxy Protocol V2, allowing users to pass additional metadata like instance ID or cluster name. Study the existing Proxy Protocol V2 implementation in Envoy, particularly the listener filter for reading TLVs and the upstream transport socket. Explore how to extend the transport socket configuration to accept and inject TLVs into the proxy protocol header when connecting to upstream hosts.
Tech stack
cpp
Domain
backend
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++EnvoyProxy Protocol
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40