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.execute_jobs

1

Enable jobs executions

zend_jobqueue.queue_name

An optional queue name, which may be used to run several queues with the same database.

zend_jobqueue.binding

tcp://127.0.0.1:10085 / unix://jobqueue.sock

An address of TCP or UNIX socket to listen for requests from clients and management GUI.

zend_jobqueue.back_end_server

http://127.0.0.1

An address of HTTP server to handle URL based jobs.

zend_jobqueue.max_http_jobs

12

The maximum number of HTTP based jobs which can be executed simultaneously by a single server. 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.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

63

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.store_only_failed_jobs_output

0

Store only outputs for failed jobs

zend_jobqueue.max_job_output_size

63

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.use_db_shared_lock

1

Use an internal Mysql mutex when getting the jobs-to-execute list.

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.database.type

Database Type (MYSQL)

zend_jobqueue.database.name

Name of the database.

zend_jobqueue.database.host_name

Host name of the Database machine (server DB only).

zend_jobqueue.database.port

3306

Port of the Databse (server DB only).

zend_jobqueue.database.user

User-name to connect to the database (server db only)

zend_jobqueue.database.password

Password to connect to the database (server DB only).

zend_jobqueue.start_jobs_chunked

1

Use batch update when marking jobs as started.

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 / 1

Enable support for HTTPS jobs

zend_jobqueue.keep_http_mechanism

1

zend_jobqueue.validate_ssl

1

Whether to validate ssl errors on job requests

zend_jobqueue.max_http_jobs_for_entire_cluster

1

Concurrency limits will be cluster-wide and not per server

zend_jobqueue.queues_update_frequency

60

Frequency check-up of queues list

zend_jobqueue.certificates_update_frequency

1

Frequency check-up of ca certificates list

zend_jobqueue.reschedule_missed_jobs

0

Reschedule all jobs that were missed during downtime

zend_jobqueue.reschedule_by_exec_time

1

Reschedule jobs according to execution time

zend_jobqueue.pulse.enable

1

Enable Pulse statistics

zend_jobqueue.pulse.stats_interval

60

Miminal period of time for Pulse data aggregation

zend_jobqueue.pulse.history

0

History to keep Pulse statistics. 0 to follow edition restrictions.

zend_jobqueue.pulse.retro_analyze_days

30

Days back to analyze when importing jobs data on upgrade

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.execute_jobs

Enable jobs executions

Default Value: 1

Type: boolean

Available Since Version: 9.1

zend_jobqueue.queue_name

An optional queue name, which may be used to run several queues with the same database.

Default Value:

Type: string

Available Since Version: 5.0

zend_jobqueue.binding

An address of TCP or UNIX socket to listen for requests from clients and management GUI.

Default Value:

  • Windows: tcp://127.0.0.1:10085
  • : unix://jobqueue.sock

Type: string

Available Since Version: 5.0

zend_jobqueue.back_end_server

An address of HTTP server to handle URL based jobs. The default value is "http://127.0.0.1". All URLs with unspecified server goes to back_end server. It is possible to define several back_end servers. The less loaded server (the server which is executing the less number of jobs) will be used to perform URL based job in this case.

Default Value: http://127.0.0.1

Type: string

Available Since Version: 5.0

zend_jobqueue.max_http_jobs

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

Default Value: 12

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.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: 63

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.store_only_failed_jobs_output

Store only outputs for failed jobs

Default Value: 0

Type: boolean

Available Since Version: 8.5

zend_jobqueue.max_job_output_size

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

Default Value: 63

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.use_db_shared_lock

Use an internal Mysql mutex when getting the jobs-to-execute list.

Default Value: 1

Type: boolean

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.database.type

The type of the database to be used. Choose from the following values: MYSQL.

Default Value:

Type: string

Available Since Version: 5.6

zend_jobqueue.database.name

The name of the database. MYSQL: schema-name.

Default Value:

Type: string

Available Since Version: 5.6

zend_jobqueue.database.host_name

The host name of the Database machine. MYSQL: machine-name/ip.

Default Value:

Type: string

Available Since Version: 5.6

zend_jobqueue.database.port

The port, in-which the database is listening on. MYSQL: port

Default Value: 3306

Type: int

Available Since Version: 5.6

zend_jobqueue.database.user

The user-name to connect to the DB. MYSQL: machine-name/ip

Default Value:

Type: string

Available Since Version: 5.6

zend_jobqueue.database.password

The password to connect to the DB. MYSQL: machine-name/ip.

Default Value:

Type: string

Available Since Version: 5.6

zend_jobqueue.start_jobs_chunked

Use batch update when marking jobs as started.

Default Value: 1

Type: boolean

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:

  • Windows: 0
  • Linux, Mac OS X, IBMi: 1

Type: boolean

Available Since Version: 6.3

zend_jobqueue.keep_http_mechanism

Default Value: 1

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

zend_jobqueue.max_http_jobs_for_entire_cluster

Concurrency limits will be cluster-wide and not per server

Default Value: 1

Type: boolean

Available Since Version: 8.5

zend_jobqueue.queues_update_frequency

Frequency check-up of queues list

Default Value: 60

Units: seconds

Type: int

Available Since Version: 8.5

zend_jobqueue.certificates_update_frequency

Frequency check-up of ca certificates list

Default Value: 1

Units: minutes

Type: int

Available Since Version: 8.5

zend_jobqueue.reschedule_missed_jobs

Reschedule all jobs that were missed during downtime

Default Value: 0

Type: boolean

Available Since Version: 9.0.1

zend_jobqueue.reschedule_by_exec_time

Reschedule jobs according to execution time (and not according to schedule time)

Default Value: 1

Type: boolean

Available Since Version: 9.2

zend_jobqueue.pulse.enable

Enable Pulse statistics

Default Value: 1

Type: boolean

Available Since Version: 9.1

zend_jobqueue.pulse.stats_interval

Miminal period of time for Pulse data aggregation

Default Value: 60

Units: seconds

Type: int

Available Since Version: 9.1

zend_jobqueue.pulse.history

History to keep Pulse statistics. 0 to follow edition restrictions.

Default Value: 0

Units: days

Type: int

Available Since Version: 9.1

zend_jobqueue.pulse.retro_analyze_days

Days back to analyze when importing jobs data on upgrade

Default Value: 30

Units: days

Type: int

Available Since Version: 9.1