Platform Administration and Architecture

Walkthrough: Configuring a shared session state database using the MongoDB provider

Abstract

How to use MongoDB as your shared session state store.

Note

MongoDB is supported in Sitecore version 9.0.2 and newer. It is not supported in version 9.0 and 9.0.1.

A contact can make multiple visits to a website from different devices or browser sessions at the same time. With shared session-state the session state database collects all the data that can be shared across these multiple sessions. This includes, for example, data related to contacts and devices. This data is still private to the contact but it is accessible from all current sessions made by the same contact.

You must always configure shared session state on your content delivery (CD) servers, regardless of whether you have a single standalone CD server, multiple CD servers, or a clustered environment.

Note

Shared session state is not supported on content management servers.

You can configure shared session state to use any session-state store provider that extends the abstract class SessionStateStoreProviderBase (shipped with ASP.NET). The only additional requirement is that the session-state store provider can invoke the SessionEnd event via SessionStateItemExpireCallback.

Note

The standard OutOfProcSessionStateStore that is shipped with ASP.NET does not support the SessionEnd event and therefore cannot be used with shared session state.

Note

If you are using the xDB Cloud Edition, using the shared session state provider for MongoDB is not included as part of this service.

Follow the steps in this section to use a MongoDB database as your shared session state store using the Sitecore ASP.NET Session State Provider for MongoDB:

Deploy a MongoDB session database

The Sitecore ASP.NET Session State Provider for MongoDB enables you to use MongoDB as your session state store. The provider supports the SessionEnd event, which the xDB needs to track website visits.

To deploy a MongoDB session database:

  1. Install the MongoDB database server version 2.6 or later on a dedicated server using the instructions on the MongoDB website.

  2. In a suitable XML editor, open the ConnectionStrings.config file located here: <sitename>\Website\App_Config and add the following connection string:

    <add name="sharedsession" connectionString="mongodb://_mongo_server_name_:_port_number_/_session_database_name_" />
  3. Configure the connection string so that it points to your session database.

  4. Save your changes.

Configure Sitecore

Note

Do not make changes directly to the configuration files. Instead, you must create a patch file that performs the required changes during runtime.

To configure Sitecore to use the shared session-state provider for MongoDB:

  1. In your website root folder, navigate to the \App_Config\Marketing.Tracking folder.

  2. Open the Sitecore.Analytics.Tracking.config file.

  3. Locate the line where you can define the default shared session state provider using the following path: sitecore/tracking/sharedSessionState.

  4. The default shared session store uses inProc provider (storing data in memory and implemented in the internal ASP.NET class InProcSessionStateStore):

    <sharedSessionState defaultProvider="inProc">
      <providers>
        <clear/>
        <add name="inProc" type="System.Web.SessionState.InProcSessionStateStore" />
      </providers>
    </sharedSessionState>

    Note

    For clustered environments, Sitecore ships with a MongoDB session state store provider.

  5. To configure MongoDB as your shared session-state store provider, change the defaultProvider from inProc to mongo. Also, change the name attribute value to mongo.

    <sharedSessionState defaultProvider="mongo">
      <providers>
        <clear/>
        <add name="mongo"
             type="Sitecore.SessionProvider.MongoDB.MongoSessionStateProvider,
             Sitecore.SessionProvider.MongoDB"
             connectionStringName="sharedsession"
             pollingInterval="2"
             compression="true"
             sessionType="shared"/>
      </providers>
    </sharedSessionState>

Adjust session state settings

In Sitecore, when you configure a session state, you have the following configuration options:

Setting

Description

connectionStringName

Contains the connection string that Sitecore uses to connect to the session database.

Edit to specify the session state database that you want to use.

For example:

connectionStringName="sharedsession"

pollingInterval

Specifies the time interval in seconds that the session-state provider uses to check if any sessions have expired.

For example:

pollingInterval="2"

compression

Indicates that you want session-state data to be compressed.

The default value is true. Compressing session state data reduces the amount of data that you need to transfer between the database and the Sitecore instance. This may cause some additional CPU overhead.

For example:

compression="true"

sessionType

Indicates whether the type of session state is private or shared.

For example:

sessionType="shared"