Zend Session Clustering Daemon - Configuration Directives

This topic lists all the configuration directives for Zend Session Clustering Daemon.

Configuration Directives Summary

The table below is a summary of all the Zend Session Clustering Daemon configuration directives, and displays the directive name, its default value, and a description:

Directive

Default Value

Description

zend_sc.global_directives_ini_file

GLOBAL_DIRECTIVES_INI_FILE

Global Directives ini file.

zend_sc.daemon.enable

0

Should the daemon start in normal run or stand by.

zend_sc.daemon.log_verbosity_level

2

The Log's verbosity level.

zend_sc.daemon.log_rotation_size

10

The maximum size of the log file before it is rotated.

zend_sc.number_of_threads

10

The number of worker threads.

zend_sc.network.hostname

localhost

The identification of the running machine.

zend_sc.network.tcp_port_remote

10060

The port via which the daemon will receive connections from other daemons.

zend_sc.network.use_unix_sockets

1

Communication with the mod cluster: 0 TCP, 1 Unix socket.

zend_sc.network.tcp_port_local

10062

The TCP port SC daemon listens to communicate with the local mod cluster.

zend_sc.network.unix_socket_permissions

0600

When the daemon is run, it creates a scd.sock file with these permissions [octal permission].

zend_sc.ha.enabled

1

zend_sc.debug.logs_cache_enable

0

For Zend Support Only. Enable/Disable cache log. Buffer to hold the log messages before dumping them to the log

zend_sc.debug.log_cache_size

1000

For Zend Support Only. Size of the log cache buffer in number of lines

zend_sc.debug.time_for_verbosity_level_five

7

For Zend Support Only. Time in seconds of verbosity level 5 after the dropping of the log cache buffer

zend_sc.debug.error_ids_list

For Zend Support Only. A comma separated list of error ids. These error ids indicate when to drop the log buffer.

zend_sc.ha.udp_port

10070

Port which is used for broadcasts for things like graceful shutdown and HA.

zend_sc.ha.use_broadcast

1

Indicate whether notifications between the cluster daemons should be done using broadcast or unicast.

zend_sc.ha.broadcast_delta

10

The time between broadcasts.

zend_sc.ha.broadcast_address

255.255.255.255

The broadcast mask.

zend_sc.allowed_hosts

A comma separated list of IPs or IP masks. These masks indicate with which machines the daemon will both agree to connect to and agree to receive connections from (this list is used for both broadcast and unicast methods).

zend_sc.ha.cluster_members

Comma separated list of IPs to indicate which nodes are members of the cluster (this list is used when the use_broadcast directive is set to 0).

zend_sc.session_lifetime

1400

The lifetime of a session.

zend_sc.garbage_collection_delta

1440

The time interval (in seconds) between two executions of the garbage collector.

zend_sc.statistics_delta_minutes

60

The time interval (in minutes) between statistics dump to the log file.

zend_sc.storage.memory_cache_size

800

Specifies the number of bytes for memory caching of sessions.

zend_sc.storage.flush_delta

0

The frequency at which sessions are flushed.

zend_sc.storage.save_path

sessions

The location on the disk where the saved sessions are stored.

zend_sc.storage.dir_levels

2

Specifies the number of directory levels used in saving files.

zend_sc.storage.filename_cache_num_entries

512

The number of entries in an internal cache.

zend_sc.message_server_port

10061

The port on which the daemon listens for control messages.

zend_sc.max_outgoing_queue_size

500

The maximum size of the queue that is used by the SC daemon to deliver messages to other daemons.

zend_sc.graceful_transfer_max_size

10

The maximum size of a chunk of sessions when transferring to the replacment server during a graceful shutdown.

zend_sc.graceful_max_time

60

The maximum time allowed for a graceful shutdown to take place.

zend_sc.graceful_transfer_port

10063

The port used by the daemon to transfer sessions to its replacement server.

zend_sc.graceful_compress_chunks

0

Compress each check of sessions before transfer.

zend_sc.graceful_primary_replacement

Primary replacement server for graceful shutdown.

zend_sc.graceful_secondary_replacement

Secondary replacement server for graceful shutdown.

zend_sc.relay_session_timeout

0

Defines the timeout for relay sessions (in seconds). If 0 is set, then no timeout is used.

zend_sc.use_cpu_load

1

For machine load - use CPU percenatege instead of open connections count.

Configuration Directives Details

The list below contains information for all the available configuration directives for Zend Session Clustering Daemon: their description, type, units, default value, modification scope, and the Zend Server version they became available in.

zend_sc.global_directives_ini_file

The .ini file that contains the global directives, as defined in ZendGlobalDirectiveDD.xml.

Default Value: GLOBAL_DIRECTIVES_INI_FILE

Type: string

Available Since Version: 5.0

zend_sc.daemon.enable

Should the daemon start in normal run or stand by.

Default Value: 0

Type: boolean

Available Since Version: 5.0

zend_sc.daemon.log_verbosity_level

The Log's verbosity level.

Default Value: 2

Type: int

Available Since Version: 5.0

zend_sc.daemon.log_rotation_size

The maximum size of the log file before it is rotated.

Default Value: 10

Units: MBytes

Type: int

Available Since Version: 5.0

zend_sc.number_of_threads

The number of worker threads. This can be increased if the running machine is strong enough.

Default Value: 10

Type: int

Available Since Version: 5.0

zend_sc.network.hostname

The identification of the running machine.

Default Value: localhost

Type: string

Available Since Version: 5.0

zend_sc.network.tcp_port_remote

The port via which the daemon will receive connections from other daemons.

Default Value: 10060

Type: int

Available Since Version: 5.0

zend_sc.network.use_unix_sockets

Communication with the mod cluster: 0 TCP, 1 Unix socket.

Applicable On: Linux, Mac OS X, IBMi

Default Value: 1

Type: boolean

Available Since Version: 5.0

zend_sc.network.tcp_port_local

The TCP port SC daemon listens to communicate with the local mod cluster.

Default Value: 10062

Type: int

Available Since Version: 5.0

zend_sc.network.unix_socket_permissions

When the daemon is run, it creates a scd.sock file with these permissions [octal permission].

Applicable On: Linux, Mac OS X, IBMi

Default Value: 0600

Type: string

Available Since Version: 5.0

zend_sc.ha.enabled

Default Value: 1

Type: boolean

Available Since Version: 5.0

zend_sc.debug.logs_cache_enable

For Zend Support Only. Enable/Disable cache log. Buffer to hold the log messages before dumping them to the log

Default Value: 0

Type: boolean

Available Since Version: 6.2

zend_sc.debug.log_cache_size

For Zend Support Only. Size of the log cache buffer in number of lines

Default Value: 1000

Type: int

Available Since Version: 6.2

zend_sc.debug.time_for_verbosity_level_five

For Zend Support Only. Time in seconds of verbosity level 5 after the dropping of the log cache buffer

Default Value: 7

Units: seconds

Type: int

Available Since Version: 6.2

zend_sc.debug.error_ids_list

For Zend Support Only. A comma separated list of error ids. These error ids indicate when to drop the log cache buffer.

Default Value:

Type: string

Available Since Version: 6.2

zend_sc.ha.udp_port

Port which is used for broadcasts for things like graceful shutdown and HA.

Default Value: 10070

Type: int

Available Since Version: 5.0

zend_sc.ha.use_broadcast

Indicate whether notifications between the cluster daemons should be done using broadcast or unicast.

Default Value: 1

Type: boolean

Available Since Version: 5.0

zend_sc.ha.broadcast_delta

The time between broadcasts.

Default Value: 10

Units: seconds

Type: int

Available Since Version: 5.0

zend_sc.ha.broadcast_address

The broadcast mask (used in HA mode).

Default Value: 255.255.255.255

Type: string

Available Since Version: 5.0

zend_sc.allowed_hosts

A comma separated list of IPs or IP masks. These masks indicate with which machines the daemon will both agree to connect to and agree to receive connections from (this list is used for both broadcast and unicast methods).

Default Value:

Type: string

Available Since Version: 5.0

zend_sc.ha.cluster_members

Comma separated list of IPs to indicate which nodes are members of the cluster (this list is used when the use_broadcast directive is set to 0).

Default Value:

Type: string

Available Since Version: 5.0

zend_sc.session_lifetime

The lifetime of a session. Sessions older than the defined value will be removed during garbage collection.

Default Value: 1400

Units: seconds

Type: int

Available Since Version: 5.0

zend_sc.garbage_collection_delta

The time interval (in seconds) between two executions of the garbage collector.

Default Value: 1440

Units: seconds

Type: int

Available Since Version: 5.0

zend_sc.statistics_delta_minutes

The time interval (in minutes) between statistics dump to the log file.

Default Value: 60

Units: minutes

Type: int

Available Since Version: 5.0

zend_sc.storage.memory_cache_size

Specifies the number of bytes for memory caching of sessions.

Default Value: 800

Units: KBytes

Type: int

Available Since Version: 5.0

zend_sc.storage.flush_delta

If 0, then sessions are written write-through. Otherwise, write-back is used, with this argument as the delay.

Default Value: 0

Units: seconds

Type: int

Available Since Version: 5.0

zend_sc.storage.save_path

The location on the disk where the saved sessions are stored.

Default Value: sessions

Type: string

Available Since Version: 5.0

zend_sc.storage.dir_levels

Specifies the number of directory levels used in saving files.

Default Value: 2

Type: int

Available Since Version: 5.0

zend_sc.storage.filename_cache_num_entries

The number of entries in an internal cache.

Default Value: 512

Type: int

Available Since Version: 5.0

zend_sc.message_server_port

The port on which the daemon listens for control messages (which can be sent using the messenger utility).

Default Value: 10061

Type: int

Available Since Version: 5.0

zend_sc.max_outgoing_queue_size

The maximum size of the queue that is used by the SC daemon to deliver messages to other daemons.

Applicable On: Windows

Default Value: 500

Type: int

Available Since Version: 5.0

zend_sc.graceful_transfer_max_size

The maximum size of a chunk of sessions when transferring to the replacment server during a graceful shutdown.

Default Value: 10

Units: MBytes

Type: int

Available Since Version: 5.0

zend_sc.graceful_max_time

The maximum time allowed for a graceful shutdown to take place.

Default Value: 60

Units: minutes

Type: int

Available Since Version: 5.0

zend_sc.graceful_transfer_port

The port used by the daemon to transfer sessions to its replacement server.

Default Value: 10063

Type: int

Available Since Version: 5.0

zend_sc.graceful_compress_chunks

Compress each check of sessions before transfer.

Default Value: 0

Type: boolean

Available Since Version: 5.0

zend_sc.graceful_primary_replacement

Primary replacement server for graceful shutdown.

Default Value:

Type: string

Available Since Version: 5.0

zend_sc.graceful_secondary_replacement

Secondary replacement server for graceful shutdown.

Default Value:

Type: string

Available Since Version: 5.0

zend_sc.relay_session_timeout

Defines the timeout for relay sessions (in seconds). If 0 is set, then no timeout is used.

Default Value: 0

Type: int

Available Since Version: 5.0

zend_sc.use_cpu_load

For machine load - use CPU percenatege instead of open connections count.

Default Value: 1

Type: boolean

Available Since Version: 6.0