Thrift proxy

  • This filter should be configured with the type URL type.googleapis.com/envoy.extensions.filters.network.thrift_proxy.v3.ThriftProxy.

  • v3 API reference

Statistics

Every configured Thrift proxy filter emits the following statistics:

Name

Type

Description

cx_destroy_local_with_active_rq

Counter

Connections destroyed locally with an active request

cx_destroy_remote_with_active_rq

Counter

Connections destroyed remotely with an active request

downstream_cx_max_requests

Counter

Connections that have been closed due to reaching the max requests limit

downstream_response_drain_close

Counter

Connections that have received the drain close header in a response

request

Counter

Total number of requests

request_call

Counter

Total number of requests of type call

request_decoding_error

Counter

Total number of requests that caused a decoding error

request_invalid_type

Counter

Total number of requests with an invalid type

request_oneway

Counter

Total number of requests of type oneway

request_passthrough

Counter

Total number of requests with payload passthrough enabled

request_internal_error

Counter

Total number of requests that caused an internal error

response

Counter

Total number of responses

response_decoding_error

Counter

Total number of responses with a decoding error

response_error

Counter

Total number of responses with an error

response_exception

Counter

Total number of responses with an exception

response_invalid_type

Counter

Total number of responses with an invalid type

response_passthrough

Counter

Total number of responses with payload passthrough enabled

response_reply

Counter

Total number of responses of type reply

response_success

Counter

Total number of responses of type success

request_active

Gauge

Number of currently active requests

request_time_ms

Histogram

Request time in millisecondse

Cluster Protocol Options

Thrift connections to upstream hosts can be configured by adding an entry to the appropriate Cluster’s extension_protocol_options keyed by envoy.filters.network.thrift_proxy. The ThriftProtocolOptions message describes the available options.

Downstream Requests Limit

Thrift Proxy can set the maximum number of requests that each downstream connection can handle. When the number of requests exceeds the connection limit, Thrift Proxy will actively disconnect from the Thrift client.

Thrift Request Metadata

The HEADER transport support metadata. In particular, the Header transport supports informational key/value pairs.

Header Transport Metadata

Header transport key/value pairs are available for routing as headers.

Metadata Interoperability

Request metadata that is available for routing (see above) is automatically converted between wire formats when translation between downstream and upstream connections occurs.