envoyproxy/envoy

feature: Cluster level HTTP health check port setting

Open

#14,045 opened on Nov 16, 2020

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

Repository metrics

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

Description

Description: There's currently a configuration option within config.endpoint.v3.Endpoint.HealthCheckConfig for overriding the port_value.

The issue with this, or rather, the inconvenience, is that this is configurable per-endpoint. Ideally, we'd have the ability to configure this also at the cluster config.core.v3.HealthCheck level as well, with the current setting operating as an override if there is no cluster level setting set. This would work (assumingly) identical to the hostname value inside of the HealthCheckConfig today based on it's documentation:

By default, the host header for L7 health checks is controlled by cluster level configuration (see: host and authority). Setting this to a non-empty value allows overriding the cluster level configuration for a specific endpoint.

Contributor guide

Research direction
Examine the existing per endpoint health check port configuration and the cluster level health check config. Understand how to add a new field in the HealthCheck protobuf and modify the health check filter to use it.
Tech stack
cpp
Domain
backendinfrastructure
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++Envoyprotobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30