Header based stateful session extension (proto)


[extensions.http.stateful_session.header.v3.HeaderBasedSessionState proto]

This extension allows the session state to be tracked via request headers.

This extension encodes the address of the upstream host selected by the load balancer into a response header with the header configuration. When new requests are incoming, this extension will try to parse the specific upstream host address by header name. If the address parsed from the header corresponds to a valid upstream host, this upstream host will be selected first. See stateful session filter.

For example, if the header name is set to session-header, Envoy will prefer as the upstream host when the request contains the following header:

session-header: "MS4yLjMuNDo4MA=="

When processing the upstream response, if is indeed the final choice the extension does nothing. If is not the final choice, the new selected host will be set to response headers (via the session-header response header).

This extension has the qualified name envoy.http.stateful_session.header


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.


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

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

  "name": ...

(string, REQUIRED) The name that will be used to obtain header value from downstream HTTP request or generate new header for downstream.