stats.proto

Package: stats.options.gloo.solo.io

Types:

Source File: github.com/solo-io/gloo/projects/gloo/api/v1/options/stats/stats.proto

Stats

This plugin provides additional configuration options to expose statistics.

"virtualClusters": []stats.options.gloo.solo.io.VirtualCluster
Field Type Description Default
virtualClusters []stats.options.gloo.solo.io.VirtualCluster Virtual clusters allow exposing additional statistics for traffic served by a Virtual Host.

VirtualCluster

Virtual clusters allow you to expose statistics for virtual host traffic that matches certain criteria. This is useful because what the application considers to be an endpoint does often not map directly to the routing configuration, so Envoy does not emit per endpoint statistics. Using virtual clusters you can define logical endpoints and have Envoy emit dedicated statistics for any matching request. Virtual cluster statistics are emitted on the downstream side and thus include network level failures.

Please note that virtual clusters add overhead to the processing of each requests and should not be overused.

"name": string
"pattern": string
"method": string
Field Type Description Default
name string The name of the virtual cluster. This value will be used together with the virtual host name to compute the name of the statistics emitted by this virtual cluster. Statistics names will be in the form: vhost..vcluster... See the official Envoy documentation for more information about the statistics emitted when virtual cluster configurations are specified. Note: This string should not contain any dots (“.”), as this is a reserved character for Envoy statistics names. Any dot present in the virtual cluster name will be replaced with an underscore (”_“) character by Gloo.
pattern string The regex pattern used by Envoy to decide whether to expose statistics for a particular request. Please note that the entire path of the request must match the regex (e.g. the regex /rides/d+ matches the path /rides/0, but not /rides/123/456). The regex grammar used is defined here.
method string If specified, statistics will be exposed only for requests matching the given HTTP method.