envoyproxy/envoy

FAQ for default settings for safety, benchmarking, etc.

Open

#5,348 opened on Dec 19, 2018

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

Repository metrics

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

Description

Envoy has default settings that can surprise new users and hurt Envoy's perceived performance in benchmarks. For example, I think at the Pinterest EnvoyCon talk (@derekargueta) mentioned the default circuit breaker settings limiting the number of concurrent requests.

We've had reports from folks who have compared Envoy's performance with other proxies using default settings and found it underwhelming. We know that horse race numbers can be significantly improved by disabling dynamic stats, etc.

Should we be making changes to default settings or (more likely) better capture best practices for Envoy production and benchmarking configuration?

Contributor guide

Research direction
Review Envoy documentation for default settings and gather community best practices for production and benchmarking configurations.
Tech stack
cpp
Domain
infrastructure
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
Envoy configuration basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60