envoyproxy/envoy

Use response_headers_to_add for Envoy-generated error responses

Open

#8,944 opened on Nov 8, 2019

View on GitHub
 (2 comments) (2 reactions) (0 assignees)C++ (5,373 forks)batch import
enhancementhelp wanted

Repository metrics

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

Description

On events like a request timeout, Envoy sends a locally generated response (the sendLocalReply function). But it doesn't use the response_headers_to_add config option. Which could be useful when response_headers_to_add has some diagnostic information (e.g. the %REQ(x-request-id)% which was added in #8683)

We can fix this by adding finalizeResponseHeaders calls before sendLocalReply calls, in functions like onUpstreamAbort.

Contributor guide

Research direction
Inspect the sendLocalReply function in Envoy's source and trace how response headers to add is applied. Look for where finalizeResponseHeaders is called to understand where to add it before sendLocalReply invocations like onUpstreamAbort.
Tech stack
cpp
Domain
backendinfrastructure
Issue type
Bug
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-3 hours
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++Envoy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60