Clusters¶

admin.v2alpha.Clusters¶

Admin endpoint uses this wrapper for /clusters to display cluster status information. See /clusters for more information.

{
  "cluster_statuses": []
}

cluster_statuses: (admin.v2alpha.ClusterStatus) Mapping from cluster name to each cluster’s status.

admin.v2alpha.ClusterStatus¶

[admin.v2alpha.ClusterStatus proto]

Details an individual cluster’s current status.

{
  "name": "...",
  "added_via_api": "...",
  "success_rate_ejection_threshold": "{...}",
  "host_statuses": []
}

name: (string) Name of the cluster.

added_via_api: (bool) Denotes whether this cluster was added via API or configured statically.

success_rate_ejection_threshold

(type.Percent) The success rate threshold used in the last interval. The threshold is used to eject hosts based on their success rate. See Cluster outlier detection statistics

Note: this field may be omitted in any of the three following cases:

There were not enough hosts with enough request volume to proceed with success rate based outlier ejection.
The threshold is computed to be < 0 because a negative value implies that there was no threshold for that interval.
Outlier detection is not enabled for this cluster.

host_statuses: (admin.v2alpha.HostStatus) Mapping from host address to the host’s current status.

admin.v2alpha.HostStatus¶

[admin.v2alpha.HostStatus proto]

Current state of a particular host.

{
  "address": "{...}",
  "stats": [],
  "health_status": "{...}",
  "success_rate": "{...}"
}

address: (core.Address) Address of this host.

stats: (admin.v2alpha.SimpleMetric) List of stats specific to this host.

health_status: (admin.v2alpha.HostHealthStatus) The host’s current health status.

success_rate

(type.Percent) Request success rate for this host over the last calculated interval.

Note: the message will not be present if host did not have enough request volume to calculate success rate or the cluster did not have enough hosts to run through success rate outlier ejection.

admin.v2alpha.HostHealthStatus¶

[admin.v2alpha.HostHealthStatus proto]

Health status for a host.

{
  "failed_active_health_check": "...",
  "failed_outlier_check": "...",
  "eds_health_status": "..."
}

failed_active_health_check: (bool) The host is currently failing active health checks.

failed_outlier_check: (bool) The host is currently considered an outlier and has been ejected.

eds_health_status: (core.HealthStatus) Health status as reported by EDS. Note: only HEALTHY and UNHEALTHY are currently supported here. TODO(mrice32): pipe through remaining EDS health status possibilities.