TCP Bandwidth Limit (proto)

This extension has the qualified name envoy.filters.network.tcp_bandwidth_limit

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

This extension must be configured with one of the following type URLs:

extensions.filters.network.tcp_bandwidth_limit.v3.TcpBandwidthLimit

{
  "stat_prefix": ...,
  "read_limit_kbps": {...},
  "write_limit_kbps": {...},
  "fill_interval": {...},
  "runtime_enabled": {...}
}

stat_prefix: (string, REQUIRED) The human readable prefix to use when emitting stats.

read_limit_kbps: (UInt64Value) The limit for read (onData) bandwidth in KiB/s. If not set, no limit is applied (unlimited bandwidth). If set to 0, all reads are blocked.

write_limit_kbps: (UInt64Value) The limit for write (onWrite) bandwidth in KiB/s. If not set, no limit is applied (unlimited bandwidth). If set to 0, all writes are is blocked.

fill_interval: (Duration) The interval at which to process buffered data and check for available bandwidth. Defaults to 50ms. It must be at least 20ms to avoid too frequent processing.

runtime_enabled: (config.core.v3.RuntimeFeatureFlag) Runtime flag that controls whether the filter is enabled or not. If not specified, defaults to enabled.