Configuring the Session Store Feature
There are three things that you can configure for the session store feature:
- Configure session store parameters for a router or device driver. See Configuring Session Store Parameters for a Device Driver.
- Configure global session store parameters that are shared by all session store instances (active or passive) on the SAE. See Configuring Global Session Store Parameters.
- Reduce the size of session objects that the SAE sends across the network for the session store feature. See Reducing the Size of Objects for the Session Store Feature.
Configuring Session Store Parameters for a Device Driver
This section describes how to configure session store parameters within a router or other device driver configuration.
To use SDX Configuration Editor to configure session store parameters for a router driver or other device driver:
- In the navigation pane, select a configuration file for the SAE that you want to configure.
- Select the Router tab, and expand the driver section.
![]()
- Edit or accept the default values in the fields.
See Session Store Fields.
- Select File > Save.
- Right-click the configuration file, select SDX System Configuration > Export to LDAP Directory.
Session Store Fields
In SDX Configuration Editor, you can edit the following fields for a driver in the Router pane in an SAE configuration file.
Maximum Queue Age [ms]
- Maximum age that a queue of buffered store operations (such as adding a session to the store or removing a session from the store) can reach before the queue is written to a session store file.
- Value—Number of milliseconds in the range 0-2147483647. A value of -1 indicates that there is no limit. A value of zero causes the session store to write each store operation to a session store file immediately.
- Default—5000
- Property name—Router.<deviceType>.sessionStore.maxQueueAge
Maximum Queued Operations
- Number of buffered store operations that are queued before the queue is written to a session store file.
- Value—Integer in the range 0-2147483647. A value of -1 indicates that there is no limit. A value of zero causes the session store to write each store operation to a session store file immediately.
- Default—50
- Property name—Router.<deviceType>.sessionStore.maxQueueOps
Maximum Queue Size [bytes]
- Maximum size that a queue of buffered store operations can reach before the queue is written to a session store file.
- Value—Number of bytes in the range 0-2147483647
- Default—51050
- Property name—Router.<deviceType>.sessionStore.maxQueueBytes
Maximum File Size [bytes]
- Maximum size of session store files. When a file reaches this size, a new file is created.
- Value—Number of bytes in the range 0-2147483647
- Default—25000000
- Property name—Router.<deviceType>.sessionStore.maxFileBytes
Minimum Disk Space Usage
- Percentage of space in all session store files that is used by live sessions. When the percentage of space in the session store files that is used by live sessions decreases to this percentage, the oldest session store file is compacted and appended to the newest session store file, and then the oldest session store file is deleted.
- Value—Percentage of disk space in the range 1-100
- Guidelines—We recommend a range of 30-50.
- Default—40
- Property name—Router.<deviceType>.sessionStore.minDiskSpaceUsage
Rotation Batch Size
- When the oldest session store file is rotated, specifies the number of sessions that are rotated from the oldest file to the newest file at the same time. While a set of sessions is rotated, no other session store activity can take place.
- Value—Integer in the range 0-2147483647
- Default—50
- Property name—Router.<deviceType>.sessionStore.rotationBatchSize
Maximum Session Data [bytes]
- Maximum size of a single subscriber or service session. Use this parameter to reserve memory for an internal buffer.
- Value—Number of bytes in the range 0-2147483647
- Default—10000
- Property name—Router.<deviceType>.sessionStore.maxSessionDataBytes
Disk Load Buffer Size [bytes]
- Size of the buffer that is used to load all of a session store's files from disk at startup.
- Value—Number of bytes in the range 0-2147483647
- Default—1000000
- Property name—Router.<deviceType>.sessionStore.diskLoadBufferBytes
Network Buffer Size [bytes]
- Size of the buffer that holds messages or message segments that are waiting to be sent to passive session stores.
- Value—Number of bytes in the range
21+ <size of maximum session size field>- 2147483647- Default—51050
- Property name—Router.<deviceType>.sessionStore.networkBufferBytes
Retry Interval [ms]
- Time interval between attempts by the active session store to connect to missing passive session stores.
- Value—Number of milliseconds in the range 0-2147483647
- Default—300000
- Property name—Router.<deviceType>.sessionStore.retryInterval
Communications Timeout [ms]
- Amount of time that a session store waits before closing when it is blocked from reading or writing a message. This timeout does not apply when a session store is waiting for a remote session store to load its state from disk.
- Value—Number of milliseconds in the range 0-2147483647
- Default—60000
- Property name—Router.<deviceType>.sessionStore.communicationsTimeout
Load Timeout [ms]
- Amount of time that an active session store waits for a passive session store or a passive session store waits for an active session store to load its data from disk before it closes the connection to the session store.
- Value—Number of milliseconds in the range 0-2147483647
- Default—420000
- Property name—Router.<deviceType>.sessionStore.remoteStoreLoadTimetout
Session Store Idle Timeout [ms]
- Amount of time that a passive session store waits for activity from the active session store before it closes the connection to the active session store. This timeout applies after the session store startup and initial update processes are complete.
- Value—Number of milliseconds in the range 0-2147483647
- Default—3600000
- Property name—Router.<deviceType>.sessionStore.idleTimeout
Maximum Backlog Ratio
- Along with the minimum backlog size, specifies when the active session store closes the connection to a passive session store because of a backlog of messages waiting to be sent. After the startup and initial update processes are complete, if the backlog becomes too large, the connection to the passive session store is closed. After the retry interval ends, a new connection is opened.
If the backlog of unsent operations (in bytes) divided by the total size (in bytes) of all live store operations is greater than this number, the connection is closed.
- Value—Floating point number
- Default—1.5
- Property name—Router.<deviceType>.sessionStore.backlogDeathMaxRatio
Minimum Backlog Size [bytes]
- Along with the maximum backlog ratio, specifies when the active session store closes the connection to a passive session store because of a backlog of messages waiting to be sent to the passive session store. After the startup and initial update processes are complete, if the backlog becomes too large, the connection to the passive session store is closed. After the retry interval ends, a new connection is opened.
If the maximum backlog ratio is met, the active session store does not close the connection unless the backlog of messages (in bytes) is greater than this number.
- Value—Number of bytes in the range 0-2147483647
- Default—5000000
- Property name—Router.<deviceType>.sessionStore.backlogDeathMinBehind
Configuring Global Session Store Parameters
This section describes how to configure global session store parameters that are shared by all session store instances (active or passive) on the SAE. You can also configure session store parameters within a router or other device driver configuration. See Configuring Session Store Parameters for a Device Driver.
To use SDX Configuration Editor to configure global session store parameters:
- In the navigation pane, select a configuration file for the SAE that you want to configure.
- Select the Router tab, and expand the Session Store section.
![]()
- Edit or accept the default values in the fields.
See Global Session Store Fields.
- Select File > Save.
- Right-click the configuration file, select SDX System Configuration > Export to LDAP Directory.
Global Session Store Fields
In SDX Configuration Editor, you can edit the following fields in the Session Store section of the Router pane in an SAE configuration file.
Session Store IP Address
- IP address or hostname that the session store infrastructure on this SAE uses to listen for incoming TCP connections from active session stores.
- Value—IP address. The address must be an IP address configured for the SAE host. If you do not enter an address or if you disable this field, active session stores cannot create passive session stores on this SAE.
- Guidelines—We recommend that you enter an address that is configured in a list of connected SAEs.
- Default—No value
- Property name—Router.sessionStore.ServerIp
Session Store Port
- TCP port number on which the session store infrastructure on this SAE listens for incoming connections from active session stores. Note that this field has no effect if you have not configured a session store IP address.
- Value—Port number
- Default—8820
- Property name—Router.sessionStore.ServerPort
Root Directory
- Root directory in which the session store creates files. Note that this field has no effect if you have not configured a session store IP address.
- Value—Directory name
- Default—var/sessionStore
- Property name—Router.sessionStore.rootDir
Reducing the Size of Objects for the Session Store Feature
You can use serialized data compression to reduce the size of sessions objects that the SAE sends across the network for the session store feature. Enabling this property reduces the size of objects, but increases the CPU load on the SAE.
To use SDX Configuration Editor to specify whether or not session objects are compressed:
- In the navigation pane, select a configuration file for the SAE that you want to configure.
- Select the Miscellaneous tab.
![]()
- Fill in the Compress Serialized Data field.
See Compressed Serialized Data Field.
- Select File > Save.
- Right-click the configuration file, select SDX System Configuration > Export to LDAP Directory.
Compressed Serialized Data Field
In SDX Configuration Editor, you can edit the following field in the Miscellaneous pane in an SAE configuration file.
Compress Serialized Data
- Enables or disables reducing the size of session objects (subscriber and service sessions) that the SAE sends across the network for the session store feature.
- Value—Yes or No
- Guidelines—We recommend that you do not enable this option because of the increase to the CPU load.
- Default—No
- Property name—Main.compressSerializedData