API Reference Guide > Zend Job Queue Daemon - Configuration Directives

Zend Job Queue Daemon - Configuration Directives

This topic lists all the configuration directives for Zend Job Queue Daemon.

Configuration Directives Summary

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

Directive	Default Value	Description
zend_jobqueue.max_http_jobs	4	The maximum number of HTTP based jobs which can be executed simultaneously by a single serve. Or, in a clustered environment - by the entire cluster.
zend_jobqueue.history	7	The maximum time (in days) a completed, failed or removed job is kept in database.
zend_jobqueue.history_failed	0	The maximum time (in days) a failed job is kept in database. If it is not set - the 'history' value is used.
zend_jobqueue.client_keep_alive	3600	Number of seconds the daemon keeps inactive connection from client.
zend_jobqueue.client_read_timeout	30	Number of seconds the daemon tries to read request from client.
zend_jobqueue.client_write_timeout	30	Number of seconds the daemon tries to deliver response to client.
zend_jobqueue.connection_timeout	30	Number of seconds the daemon tries to establish a connection with a back-end server.
zend_jobqueue.http_job_timeout	120	Number of seconds a URL-based job must be completed in.
zend_jobqueue.job_restart_timeout	200	The minimal number of milliseconds between job startups.
zend_jobqueue.http_job_retry_count	10	Number of retries for failed HTTP jobs.
zend_jobqueue.http_job_retry_timeout	1	The number of seconds between retries for failed HTTP jobs.
zend_jobqueue.high_concurrency_margin_allowed	0	Report an event when the Job Queue Daemon reaches a margin between the number of running jobs and the maximum allowed.
zend_jobqueue.job_time_skew_allowed	120	Report an event when a job exceeds its defined execution time.
zend_jobqueue.max_message_size	64	The maximum message size the daemon can accept from the extension.
zend_jobqueue.daemon.log_verbosity_level	2	The Log's verbosity level.
zend_jobqueue.daemon.log_rotation_size	10	The maximum size of the log file before it is rotated.
zend_jobqueue.store_job_output	1	Whether to store job output in DB. If set to '0', no job output is stored.
zend_jobqueue.max_job_output_size	1024	Size in KB of maximal job output size to store in DB.
zend_jobqueue.db_cache_size	2000	DB disk pages (SQLite only).
zend_jobqueue.db_vacuum	0	Whether to run vacuum on the DB file after jobs cleanup (SQLite only).
zend_jobqueue.execution_queues	*	List of queue names for which the daemon should execute jobs.
zend_jobqueue.idle_timeout	10	Time limit to remain idle when there are no jobs to execute.
zend_jobqueue.status_check_interval	0	The interval in which daemons update their status and check status of other daemons. 0 will disable the feature.
zend_jobqueue.jobs_recovery_timeout	60	Recover jobs of daemons whose status is outdated by the time period given by the directive.
zend_jobqueue.db_size_completed	1024	Maximum DB space for completed jobs data.
zend_jobqueue.db_size_failed	1024	Maximum DB space for failed jobs data.
zend_jobqueue.global_directives_ini_file	GLOBAL_DIRECTIVES_INI_FILE	Global Directives ini file.
zend_jobqueue.enable_https	0	Enable support for HTTPS jobs
zend_jobqueue.validate_ssl	1	Whether to validate ssl errors on job requests

Configuration Directives Details

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

zend_jobqueue.max_http_jobs

The maximum number of HTTP based jobs which can be executed simultaneously by a single serve. Or, in a clustered environment - by the entire cluster.

Default Value: 4

Type: int

Available Since Version: 5.0

zend_jobqueue.history

The maximum time (in days) a completed, failed or removed job is kept in database. If no directive is provided, time is unlimited and jobs are never deleted. Other than this directive, setting jobs may be kept forever by also using the "persistent" option. Set to 0 to disable cleanups.

Default Value: 7

Units: days

Type: int

Available Since Version: 5.0

zend_jobqueue.history_failed

The maximum time (in days) a failed job is kept in database. If it is not set - the 'history' value is used. Set to 0 to disable cleanups.

Default Value: 0

Units: days

Type: int

Available Since Version: 5.0

zend_jobqueue.client_keep_alive

Number of seconds the daemon keeps inactive connection from client. If the client does not send any request during this time, the daemon closes the client's connection (default 3600 seconds = 1 hour).

Default Value: 3600

Type: int

Available Since Version: 5.0

zend_jobqueue.client_read_timeout

Number of seconds the daemon tries to read request from client. If the client does not respond during this time, daemon closes the client's connection (default 10 seconds).

Default Value: 30

Type: int

Available Since Version: 5.0

zend_jobqueue.client_write_timeout

Number of seconds the daemon tries to deliver response to client. If the client does not respond during this time, daemon closes the client's connection (default 10 seconds).

Default Value: 30

Type: int

Available Since Version: 5.0

zend_jobqueue.connection_timeout

Number of seconds the daemon tries to establish a connection with a back-end server.

Default Value: 30

Units: seconds

Type: int

Available Since Version: 5.0

zend_jobqueue.http_job_timeout

Number of seconds a URL-based job must be completed in. After the timeout expires, daemons drops the connection to the back-end server and sets job status to "failed" and completion status to "timeout".

Default Value: 120

Units: seconds

Type: int

Available Since Version: 5.0

zend_jobqueue.job_restart_timeout

The minimal number of microlliseconds between job startups.

Default Value: 200

Type: int

Available Since Version: 5.0

zend_jobqueue.http_job_retry_count

Number of retries for failed HTTP jobs.

Default Value: 10

Type: int

Available Since Version: 5.0

zend_jobqueue.http_job_retry_timeout

The number of seconds between retries for failed HTTP jobs.

Default Value: 1

Units: seconds

Type: int

Available Since Version: 5.0

zend_jobqueue.high_concurrency_margin_allowed

Report an event when the Job Queue Daemon reaches a margin between the number of running jobs and the maximum allowed.

Default Value: 0

Type: int

Available Since Version: 5.0

zend_jobqueue.job_time_skew_allowed

Report an event when a job exceeds its defined execution time.

Default Value: 120

Units: seconds

Type: int

Available Since Version: 5.0

zend_jobqueue.max_message_size

The maximum message size the daemon can accept from the extension.

Default Value: 64

Units: KBytes

Type: int

Available Since Version: 5.0

zend_jobqueue.daemon.log_verbosity_level

The Log's verbosity level.

Default Value: 2

Type: int

Available Since Version: 5.0

zend_jobqueue.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_jobqueue.store_job_output

Whether to store job output in DB. If set to '0', no job output is stored.

Default Value: 1

Type: boolean

Available Since Version: 5.0

zend_jobqueue.max_job_output_size

Size in KB of maximal job output size to store in DB.

Default Value: 1024

Units: KBytes

Type: int

Available Since Version: 5.0

zend_jobqueue.db_cache_size

The suggested maximum number of database disk pages that the DB will hold in memory (SQLite only).

Default Value: 2000

Type: int

Available Since Version: 5.1

zend_jobqueue.db_vacuum

Whether to run vacuum on the DB file after jobs cleanup (SQLite only).

Default Value: 0

Type: boolean

Available Since Version: 5.5

zend_jobqueue.execution_queues

List of queue names for which the daemon should execute jobs. The list should be comma separated. '*' means any queue.

Default Value: *

Type: string

Available Since Version: 5.6

zend_jobqueue.idle_timeout

Time limit to remain idle when there are no jobs to execute.

Default Value: 10

Units: seconds

Type: int

Available Since Version: 5.6

zend_jobqueue.status_check_interval

The interval in which daemons update their status and check status of other daemons. 0 will disable the feature.

Default Value: 0

Units: seconds

Type: int

Available Since Version: 5.6

zend_jobqueue.jobs_recovery_timeout

Recover jobs of daemons whose status is outdated by the time period given by the directive. Will be disabled if 'status_check_interval' is disabled.

Default Value: 60

Units: seconds

Type: int

Available Since Version: 5.6

zend_jobqueue.db_size_completed

Maximum DB space for completed jobs data. 0 for unlimited.

Default Value: 1024

Units: MBytes

Type: int

Available Since Version: 6.1

zend_jobqueue.db_size_failed

Maximum DB space for failed jobs data. 0 for unlimited.

Default Value: 1024

Units: MBytes

Type: int

Available Since Version: 6.1

zend_jobqueue.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_jobqueue.enable_https

Enable support for HTTPS jobs

Default Value: 0

Type: boolean

Available Since Version: 6.3

zend_jobqueue.validate_ssl

Whether to validate ssl errors on job requests

Default Value: 1

Type: boolean

Available Since Version: 6.3