package envoy.extensions.filters.network.tcp_proxy.v3

Get desktop application:
View/edit binary Protocol Buffers messages

[#next-free-field: 20]

• string stat_prefix = 1

  The prefix to use when emitting :ref:`statistics <config_network_filters_tcp_proxy_stats>`.

• oneof cluster_specifier

  • string cluster = 2

    The upstream cluster to connect to.

  • TcpProxy.WeightedCluster weighted_clusters = 10

    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.

• optional TcpProxy.OnDemand on_demand = 14

  The on demand policy for the upstream cluster. It applies to both :ref:`TcpProxy.cluster <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.cluster>` and :ref:`TcpProxy.weighted_clusters <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.weighted_clusters>`.

• optional config.core.v3.Metadata metadata_match = 9

  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 for load balancing. The filter name should be specified as ``envoy.lb``.

• optional google.protobuf.Duration idle_timeout = 8

  The idle timeout for connections managed by the TCP proxy filter. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. It is possible to dynamically override this configuration by setting a per-connection filter state object for the key ``envoy.tcp_proxy.per_connection_idle_timeout_ms``. .. warning:: Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP FIN packets, etc.

• optional google.protobuf.Duration downstream_idle_timeout = 3

  [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter. The idle timeout is defined as the period in which there is no active traffic. If not set, there is no idle timeout. When the idle timeout is reached the connection will be closed. The distinction between downstream_idle_timeout/upstream_idle_timeout provides a means to set timeout based on the last byte sent on the downstream/upstream connection.

• optional google.protobuf.Duration upstream_idle_timeout = 4

  [#not-implemented-hide:]

• repeated config.accesslog.v3.AccessLog access_log = 5

  Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the this tcp_proxy.

• optional google.protobuf.UInt32Value max_connect_attempts = 7

  The maximum number of unsuccessful connection attempts that will be made before giving up. If the parameter is not specified, 1 connection attempt will be made.

• optional config.core.v3.BackoffStrategy backoff_options = 18

  Sets the backoff strategy. If not set, the retries are performed without backoff.

• repeated type.v3.HashPolicy hash_policy = 11

  Optional configuration for TCP proxy hash policy. If hash_policy is not set, the hash-based load balancing algorithms will select a host randomly. Currently the number of hash policies is limited to 1.

• optional TcpProxy.TunnelingConfig tunneling_config = 12

  If set, this configures tunneling, e.g. configuration options to tunnel TCP payload over HTTP CONNECT. If this message is absent, the payload will be proxied upstream as per usual. It is possible to dynamically override this configuration and disable tunneling per connection, by setting a per-connection filter state object for the key ``envoy.tcp_proxy.disable_tunneling``.

• optional google.protobuf.Duration max_downstream_connection_duration = 13

  The maximum duration of a connection. The duration is defined as the period since a connection was established. If not set, there is no max duration. When max_downstream_connection_duration is reached the connection will be closed. Duration must be at least 1ms.

• optional google.protobuf.Duration access_log_flush_interval = 15

  Note that if both this field and :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>` are specified, the former (deprecated field) is ignored. .. attention:: This field is deprecated in favor of :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>`.

• bool flush_access_log_on_connected = 16

  Note that if both this field and :ref:`flush_access_log_on_connected <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.flush_access_log_on_connected>` are specified, the former (deprecated field) is ignored. .. attention:: This field is deprecated in favor of :ref:`flush_access_log_on_connected <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.flush_access_log_on_connected>`.

• optional TcpProxy.TcpAccessLogOptions access_log_options = 17

  Additional access log options for TCP Proxy.

• repeated config.core.v3.TlvEntry proxy_protocol_tlvs = 19

  If set, the specified PROXY protocol TLVs (Type-Length-Value) will be added to the PROXY protocol state created by the TCP proxy filter. These TLVs will be sent in the PROXY protocol v2 header to upstream. This field only takes effect when the TCP proxy filter is creating new PROXY protocol state and there is an upstream proxy protocol transport socket configured in the cluster. If the connection already contains PROXY protocol state (including any TLVs) parsed by a downstream proxy protocol listener filter, the TLVs specified here are ignored. .. note:: To ensure specified TLVs are allowed in the upstream PROXY protocol header, you must also configure the passthrough TLVs on the upstream proxy protocol transport. See :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>` for details.

Used in: TcpProxy

• optional config.core.v3.ConfigSource odcds_config = 1

  An optional configuration for on-demand cluster discovery service. If not specified, the on-demand cluster discovery will be disabled. When it's specified, the filter will pause a request to an unknown cluster and will begin a cluster discovery process. When the discovery is finished (successfully or not), the request will be resumed.

• string resources_locator = 2

  xdstp:// resource locator for on-demand cluster collection. [#not-implemented-hide:]

• optional google.protobuf.Duration timeout = 3

  The timeout for on demand cluster lookup. If the CDS cannot return the required cluster, the downstream request will be closed with the error code detail NO_CLUSTER_FOUND. [#not-implemented-hide:]

Used in: TcpProxy

• optional google.protobuf.Duration access_log_flush_interval = 1

  The interval to flush access log. The TCP proxy will flush only one access log when the connection is closed by default. If this field is set, the TCP proxy will flush access log periodically with the specified interval. The interval must be at least 1ms.

• bool flush_access_log_on_connected = 2

  If set to true, access log will be flushed when the TCP proxy has successfully established a connection with the upstream. If the connection failed, the access log will not be flushed.

Configuration for tunneling TCP over other transports or application layers. Tunneling is supported over both HTTP/1.1 and HTTP/2. Upstream protocol is determined by the cluster configuration. [#next-free-field: 7]

Used in: TcpProxy

• string hostname = 1

  The hostname to send in the synthesized CONNECT headers to the upstream proxy. This field evaluates command operators if set, otherwise returns hostname as is. Example: dynamically set hostname using downstream SNI .. code-block:: yaml tunneling_config: hostname: "%REQUESTED_SERVER_NAME%:443" Example: dynamically set hostname using dynamic metadata .. code-block:: yaml tunneling_config: hostname: "%DYNAMIC_METADATA(tunnel:address)%"

• bool use_post = 2

  Use POST method instead of CONNECT method to tunnel the TCP stream. The 'protocol: bytestream' header is also NOT set for HTTP/2 to comply with the spec. The upstream proxy is expected to convert POST payload as raw TCP.

• repeated config.core.v3.HeaderValueOption headers_to_add = 3

  Additional request headers to upstream proxy. This is mainly used to trigger upstream to convert POST requests back to CONNECT requests. Neither ``:-prefixed`` pseudo-headers nor the Host: header can be overridden.

• bool propagate_response_headers = 4

  Save the response headers to the downstream info filter state for consumption by the network filters. The filter state key is ``envoy.tcp_proxy.propagate_response_headers``.

• string post_path = 5

  The path used with POST method. Default path is ``/``. If post path is specified and :ref:`use_post field <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig.use_post>` isn't true, it will be rejected.

• bool propagate_response_trailers = 6

  Save the response trailers to the downstream info filter state for consumption by the network filters. The filter state key is ``envoy.tcp_proxy.propagate_response_trailers``.

Allows 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: TcpProxy

• repeated WeightedCluster.ClusterWeight clusters = 1

  Specifies one or more upstream clusters associated with the route.

Used in: WeightedCluster

• string name = 1

  Name of the upstream cluster.

• uint32 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 config.core.v3.Metadata 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 for load balancing. Note that this will be merged with what's provided in :ref:`TcpProxy.metadata_match <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.metadata_match>`, with values here taking precedence. The filter name should be specified as ``envoy.lb``.