package envoy.config.filter.network.thrift_proxy.v2alpha1
Get desktop application:
View/edit binary Protocol Buffers messages
Thrift Protocol types supported by Envoy.
Used in: ,
AUTO_PROTOCOL = 0
For downstream connections, the Thrift proxy will attempt to determine which protocol to use. Note that the older, non-strict (or lax) binary protocol is not included in automatic protocol detection. For upstream connections, the Thrift proxy will use the same protocol as the downstream connection.
BINARY = 1
The Thrift proxy will use the Thrift binary protocol.
LAX_BINARY = 2
The Thrift proxy will use Thrift non-strict binary protocol.
COMPACT = 3
The Thrift proxy will use the Thrift compact protocol.
TWITTER = 4
The Thrift proxy will use the Thrift "Twitter" protocol implemented by the finagle library.
message
route.proto:34Used in:
optional match = 1
Route matching parameters.
optional route = 2
Route request to some upstream cluster.
message
route.proto:79[#next-free-field: 7]
Used in:
oneof cluster_specifier
string cluster = 1
Indicates a single upstream cluster to which the request should be routed to.
weighted_clusters = 2
Multiple upstream clusters can be specified for a given route. The request is routed to one of the upstream clusters based on weights assigned to each cluster.
string cluster_header = 6
Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers. If the header is not found or the referenced cluster does not exist Envoy will respond with an unknown method exception or an internal error exception, respectively.
optional metadata_match = 3
Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered. Note that this will be merged with what's provided in :ref:`WeightedCluster.metadata_match <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.WeightedCluster.ClusterWeight.metadata_match>`, with values there taking precedence. Keys and values should be provided under the "envoy.lb" metadata key.
repeated rate_limits = 4
Specifies a set of rate limit configurations that could be applied to the route. N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders action with the header name ":method-name".
bool strip_service_name = 5
Strip the service prefix from the method name, if there's a prefix. For example, the method call Service:method would end up being just method.
message
route.proto:25Used in:
string name = 1
The name of the route configuration. Reserved for future use in asynchronous route discovery.
repeated routes = 2
The list of routes that will be matched, in order, against incoming requests. The first route that matches will be used.
message
route.proto:42Used in:
oneof match_specifier
string method_name = 1
If specified, the route must exactly match the request method name. As a special case, an empty string matches any request method name.
string service_name = 2
If specified, the route must have the service name as the request method name prefix. As a special case, an empty string matches any service name. Only relevant when service multiplexing.
bool invert = 3
Inverts whatever matching is done in the :ref:`method_name <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.RouteMatch.method_name>` or :ref:`service_name <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.RouteMatch.service_name>` fields. Cannot be combined with wildcard matching as that would result in routes never being matched. .. note:: This does not invert matching done as part of the :ref:`headers field <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.RouteMatch.headers>` field. To invert header matching, see :ref:`invert_match <envoy_api_field_route.HeaderMatcher.invert_match>`.
repeated headers = 4
Specifies a set of headers that the route should match on. The router will check the request’s headers against all the specified headers in the route config. A match will happen if all the headers in the route are present in the request with the same values (or based on presence if the value field is not in the config). Note that this only applies for Thrift transports and/or protocols that support headers.
message
thrift_proxy.proto:88ThriftFilter configures a Thrift filter.
Used in:
string name = 1
The name of the filter to instantiate. The name must match a supported filter. The built-in filters are: [#comment:TODO(zuercher): Auto generate the following list] * :ref:`envoy.filters.thrift.router <config_thrift_filters_router>` * :ref:`envoy.filters.thrift.rate_limit <config_thrift_filters_rate_limit>`
oneof config_type
Filter specific configuration which depends on the filter being instantiated. See the supported filters for further documentation.
config = 2
typed_config = 3
message
thrift_proxy.proto:110ThriftProtocolOptions specifies Thrift upstream protocol options. This object is used in in :ref:`typed_extension_protocol_options<envoy_api_field_Cluster.typed_extension_protocol_options>`, keyed by the name `envoy.filters.network.thrift_proxy`.
TransportType transport = 1
Supplies the type of transport that the Thrift proxy should use for upstream connections. Selecting :ref:`AUTO_TRANSPORT<envoy_api_enum_value_config.filter.network.thrift_proxy.v2alpha1.TransportType.AUTO_TRANSPORT>`, which is the default, causes the proxy to use the same transport as the downstream connection.
ProtocolType protocol = 2
Supplies the type of protocol that the Thrift proxy should use for upstream connections. Selecting :ref:`AUTO_PROTOCOL<envoy_api_enum_value_config.filter.network.thrift_proxy.v2alpha1.ProtocolType.AUTO_PROTOCOL>`, which is the default, causes the proxy to use the same protocol as the downstream connection.
message
thrift_proxy.proto:65[#next-free-field: 6]
TransportType transport = 2
Supplies the type of transport that the Thrift proxy should use. Defaults to :ref:`AUTO_TRANSPORT<envoy_api_enum_value_config.filter.network.thrift_proxy.v2alpha1.TransportType.AUTO_TRANSPORT>`.
ProtocolType protocol = 3
Supplies the type of protocol that the Thrift proxy should use. Defaults to :ref:`AUTO_PROTOCOL<envoy_api_enum_value_config.filter.network.thrift_proxy.v2alpha1.ProtocolType.AUTO_PROTOCOL>`.
string stat_prefix = 1
The human readable prefix to use when emitting statistics.
optional route_config = 4
The route table for the connection manager is static and is specified in this property.
repeated thrift_filters = 5
A list of individual Thrift filters that make up the filter chain for requests made to the Thrift proxy. Order matters as the filters are processed sequentially. For backwards compatibility, if no thrift_filters are specified, a default Thrift router filter (`envoy.filters.thrift.router`) is used.
Thrift transport types supported by Envoy.
Used in: ,
AUTO_TRANSPORT = 0
For downstream connections, the Thrift proxy will attempt to determine which transport to use. For upstream connections, the Thrift proxy will use same transport as the downstream connection.
FRAMED = 1
The Thrift proxy will use the Thrift framed transport.
UNFRAMED = 2
The Thrift proxy will use the Thrift unframed transport.
HEADER = 3
The Thrift proxy will assume the client is using the Thrift header transport.
message
route.proto:121Allows for specification of multiple upstream clusters along with weights that indicate the percentage of traffic to be forwarded to each cluster. The router selects an upstream cluster based on these weights.
Used in:
repeated clusters = 1
Specifies one or more upstream clusters associated with the route.
message
route.proto:122Used in:
string name = 1
Name of the upstream cluster.
optional weight = 2
When a request matches the route, the choice of an upstream cluster is determined by its weight. The sum of weights across all entries in the clusters array determines the total weight.
optional metadata_match = 3
Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field, combined with what's provided in :ref:`RouteAction's metadata_match <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.RouteAction.metadata_match>`, will be considered. Values here will take precedence. Keys and values should be provided under the "envoy.lb" metadata key.