ASP.NET Session State Caching | Ignite Documentation

Ignite Summit 2023 — Watch on demand — Register now!


ASP.NET Session State Caching


The ASP.NET session state caching is designed to allow you to store user session data in different sources. By default, session state values and information are stored in memory within the ASP.NET process.

Ignite.NET implements a session state store provider that stores session data in a distributed Ignite cluster that spreads the session data across multiple servers in order to provide high availability, load balancing and fault tolerance.


Development and Debugging

During development and debugging, IIS will dynamically detect code changes when you build and run your web application. This, however, does not restart the embedded Ignite instance and can cause exceptions and undesired behavior. Make sure to restart IIS manually when using the Ignite Session State Cache.


  • Binary distribution: add a reference to Apache.Ignite.AspNet.dll

  • NuGet: Install-Package Apache.Ignite.AspNet


To enable the Ignite-based session state storage, modify the web.config file as follows:

  <sessionState mode="Custom" customProvider="IgniteSessionStateProvider">
      <add name="IgniteSessionStateProvider"
           type="Apache.Ignite.AspNet.IgniteSessionStateStoreProvider, Apache.Ignite.AspNet"
           cacheName="aspNetSessionCache" />

While the name and type attributes are required, the other attributes listed below are optional:

Attribute Description


The web.config section name defined in configSections. See Configuration: web.config for more details. This configuration will be used to start Ignite if it is not started yet.


Should only be used when multiple web applications share the same Ignite session state cache. Assign different ID strings to avoid session data conflicts between applications. It is recommended to use a separate cache for each application via cacheName attribute.


Session state provider calls Ignition.TryGetIgnite with this grid name to check whether Ignite is already started.


Session state cache name. Default is ASPNET_SESSION_STATE.

For more details on how to start Ignite within an ASP.NET application, refer to ASP.NET Output Caching. Also, see ASP.NET Deployment for web deployment specifics related to the IGNITE_HOME variable.