envoyproxy/envoy

enhancement, api: consider creating a unify fault type for database filter?

Open

#15,597 opened on Mar 22, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/faultdesign proposalhelp wanted

Repository metrics

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

Description

Title: consider create a unify fault type for database filter

Description: I'm trying to implement fault injection for mysql proxy, the fault message definition is totally migrated from RedisFault https://github.com/envoyproxy/envoy/blob/a240824c376693b16ca8be51e435b95c42f3449f/api/envoy/extensions/filters/network/redis_proxy/v3/redis_proxy.proto#L186-L207 In the mean while, I notice that in filters/common/fault/v3 https://github.com/envoyproxy/envoy/blob/a240824c376693b16ca8be51e435b95c42f3449f/api/envoy/extensions/filters/common/fault/v3/fault.proto#L53-L57, The common fault delay is very limit that it cannot let users inject fault base on command type, mongo filter uses this fault type, but redis uses its own fault type, I guess they will reimplement their own fault type once some contributors want to extend other filters. It's there any plans to give a unified fault api for those filters?

Contributor guide

Research direction
Review existing fault types in filters/common/fault/v3 and redis proxy, then design a unified fault message that supports command based injection. Consider extending the common fault delay to include fault types for different filters.
Tech stack
cpp
Domain
backendapi
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.
Mostly clear
Prerequisites
Protocol BuffersEnvoy development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40