AGENTS.md

1# Stateful Session Filter
2 
3This directory contains a client-side filter for providing cookie-based stateful session affinity.
4 
5## Overarching Purpose
6 
7The stateful session filter provides a mechanism for routing requests to the same backend endpoint that handled previous requests from the same client. This is useful for applications that require session affinity, such as those that use in-memory caches or other stateful resources.
8 
9## Files
10 
11*   `stateful_session_filter.h`, `stateful_session_filter.cc`: These files define the `StatefulSessionFilter` class, a client-side filter that provides cookie-based stateful session affinity.
12 
13## Major Classes
14 
15*   `grpc_core::StatefulSessionFilter`: The channel filter implementation.
16*   `grpc_core::XdsOverrideHostAttribute`: A call attribute that is used to pass state between the `StatefulSessionFilter` and the `xds_override_host` load balancing policy.
17 
18## Notes
19 
20*   The stateful session filter works in conjunction with the `xds_override_host` load balancing policy. The filter extracts a cookie from the incoming request's metadata, which the LB policy then uses to select an endpoint.
21*   The filter is designed to be used with xDS, which can be used to dynamically update the stateful session configuration at runtime.
22*   This filter is an important component of gRPC's load balancing story, as it enables applications to maintain session affinity across multiple requests.
23