.. _envoy_api_file_envoy/config/filter/network/local_rate_limit/v2alpha/local_rate_limit.proto: Local rate limit ================ .. _extension_envoy.filters.network.local_ratelimit: This extension may be referenced by the qualified name *envoy.filters.network.local_ratelimit* .. note:: This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted. Local rate limit :ref:`configuration overview `. .. _envoy_api_msg_config.filter.network.local_rate_limit.v2alpha.LocalRateLimit: config.filter.network.local_rate_limit.v2alpha.LocalRateLimit ------------------------------------------------------------- `[config.filter.network.local_rate_limit.v2alpha.LocalRateLimit proto] `_ .. code-block:: json { "stat_prefix": "...", "token_bucket": "{...}", "runtime_enabled": "{...}" } .. _envoy_api_field_config.filter.network.local_rate_limit.v2alpha.LocalRateLimit.stat_prefix: stat_prefix (`string `_, *REQUIRED*) The prefix to use when emitting :ref:`statistics `. .. _envoy_api_field_config.filter.network.local_rate_limit.v2alpha.LocalRateLimit.token_bucket: token_bucket (:ref:`type.TokenBucket `, *REQUIRED*) The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain. Each incoming connection processed by the filter consumes a single token. If the token is available, the connection will be allowed. If no tokens are available, the connection will be immediately closed. .. note:: In the current implementation each filter and filter chain has an independent rate limit. .. note:: In the current implementation the token bucket's :ref:`fill_interval ` must be >= 50ms to avoid too aggressive refills. .. _envoy_api_field_config.filter.network.local_rate_limit.v2alpha.LocalRateLimit.runtime_enabled: runtime_enabled (:ref:`core.RuntimeFeatureFlag `) Runtime flag that controls whether the filter is enabled or not. If not specified, defaults to enabled.