Skip to content

docs: add new percentage-based response option to health check filter #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattklein123 merged 2 commits into from
Jan 22, 2018
Merged

docs: add new percentage-based response option to health check filter #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c199bf
docs: add new percentage-based response option to health check filter
Jan 21, 2018
279d56a
Fix doc build error due to extraneous space, and add deep link to new…
Jan 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions api/filter/http/health_check.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ message HealthCheck {
// that the filter should cache the upstream response.
google.protobuf.Duration cache_time = 3;

// [#not-implemented-hide:]
// If operating in non-pass-through mode, specifies a set of upstream cluster
// names and the minimum percentage of servers in each of those clusters that
// must be healthy in order for the filter to return a 200.
// must be healthy in order for the filter to return a 200.
map<string, Percent> cluster_min_healthy_percentages = 4;
}
5 changes: 5 additions & 0 deletions docs/root/intro/arch_overview/health_checking.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ operation:

* **No pass through**: In this mode, the health check request is never passed to the local service.
Envoy will respond with a 200 or a 503 depending on the current draining state of the server.
* **No pass through, computed from upstream cluster health**: In this mode, the health checking
Copy link
Member

@mattklein123 mattklein123 Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be nice to deep link into v2 doc option that implements this.

filter will return a 200 or a 503 depending on whether at least a :ref:`specified percentage
<envoy_api_field_filter.http.HealthCheck.cluster_min_healthy_percentages>` of the
servers are healthy in one or more upstream clusters. (If the Envoy server is in a draining
state, though, it will respond with a 503 regardless of the upstream cluster health.)
* **Pass through**: In this mode, Envoy will pass every health check request to the local service.
The service is expected to return a 200 or a 503 depending on its health state.
* **Pass through with caching**: In this mode, Envoy will pass health check requests to the local
Expand Down