envoyproxy/envoy

Overload manager action to fail readiness check

Open

#33,168 opened on Mar 27, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/overload_managerenhancementhelp wanted

Repository metrics

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

Description

The recommendation in https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge for configuring an overload manager looks like so:

  - name: "envoy.overload_actions.shrink_heap"
    triggers:
    - name: "envoy.resource_monitors.fixed_heap"
      threshold:
        value: 0.95
  - name: "envoy.overload_actions.stop_accepting_requests"
    triggers:
    - name: "envoy.resource_monitors.fixed_heap"
      threshold:
        value: 0.98

For folks who are running envoy in a cloud native environment, would it not be better to provide an action that will start failing the healtcheck, so the /ready endpoint starts failing? In this scenario, traffic won't be sent to the pod until the service is healthy again.

Contributor guide

Research direction
Investigate how to add a new overload action that fails the /ready health check endpoint in Envoy's overload manager. Study existing overload actions (e.g., shrink heap, stop accepting requests) and the health check filter's /ready implementation. Design a new action that triggers a failure on the readiness check when resource pressure is high. Implement the action and add tests.
Tech stack
cpp
Domain
backendinfrastructurecloud
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++Envoy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45