envoyproxy/envoy

Healthchecking in Lua

Open

#6,901 opened on May 10, 2019

View on GitHub
 (7 comments) (0 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

Hi,

I am trying to deploy various custom and stateful origins behind an Envoy gateway. These origins may have arbitrary logic to their healthchecks such that for a certain type one may want to check if the response is 200 OK and valid JSON with a "foo" key and a "bar" value, and mark the origin healthy if and only if that's the case while some other origin might be okay with just a 200 OK and an empty response body.

As it stands, I think this kind of feature would involve creating a new Healthcheck Filter. Has this been abstracted away by another filter? Any suggestions for such a use case would be appreciated.

Thanks.

Contributor guide

Research direction
Examine the existing health check filter implementation in Envoy (source/extensions/filters/http/health check) and the Lua filter (source/extensions/filters/http/lua). Understand how to integrate Lua scripting into the health check logic to allow custom response validation. Check if there are any prior discussions or prototypes in the issue comments.
Tech stack
cpplua
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
GitC++Lua
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40