envoyproxy/envoy

Exposing Wasm VM state in a health check endpoint

Open

#34,881 opened on Jun 25, 2024

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

Repository metrics

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

Description

Title: Exposing Wasm VM state in a health check endpoint

Description: Any unrecoverable error in the Wasm VM will panic it, and all coming requests will get 503. Users have to reload the wasm filter or restart the envoy process to eliminate the issue.

I didn't find any specific mechanism/API from Envoy documents that can help users identify the status of the Wasm VM. This is useful for building a liveness probe to have the envoy process restart without any human interaction.

Thank you!

Contributor guide

Research direction
Investigate how Envoy's existing health check endpoints work and how Wasm VM state is tracked. Look for Wasm VM lifecycle events and error states to expose in a new health check endpoint.
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++Envoy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60