ADx 2.1.225 (26/02/2020) Patch Release Notes
This is a patch release to ADx 2.1, improving the retry mechanism introduced in ADx 2.1.220. This patch extends the retry mechanism to cover more edge cases (such as jobs waiting in a queue for hours due to heavy Conversion load).
Time intervals controlling the retry mechanism for both ADx Content Representation Jobs and Conversion Jobs were optimized, as explained in Configuration Changes below - please read this section carefully.
For information about the 2.1 release, please read ADx 2.1 Release Notes.
For information about the 2.1.220 patch release, please read ADx 2.1.220 Patch Release Notes.
Installation
You can install this release from the provided package. Follow Installation Instructions if you're installing from scratch.
Updating Conversion and ADx
For information on how to update previously installed Conversion and ADx, see the following:
Note that this release includes configuration changes - please update your settings file accordingly if you want to re-use it.
Configuration changes
Conversion Package
Conversion retry settings are now set to the following values in the installation settings file:
##############################################################################
# Conversion Retry Settings
# This mechanism periodically checks for stale jobs and revives them.
##############################################################################
# The interval (in ms) of the Job Scheduler checking for stale jobs.
CONV_JOB_SCHEDULER_INTERVAL: "300000" # 5 minutes
# The maximum interval of inactivity before a job gets restarted.
CONV_MAX_INACTIVITY_BEFORE_RETRY: "3600000" # 60 minutes
# The maximum number of retries for a single job. If this number is reached,
# there will be no further retries and the problem has to be analyzed and fixed manually.
CONV_MAX_RETRIES: "3"
While CONV_JOB_SCHEDULER_INTERVAL could be set to as low as 60000 (one minute), we do not recommend shortening the inactivity period set in CONV_MAX_INACTIVITY_BEFORE_RETRY. Note that if for any reason Conversion is not able to update the Last Updated Time time stamp while working on the job (for example there is a PDF page that takes very long to convert), it will result in an unnecessary retry when the value is set too low. Maximum inactivity time must be higher than the highest expected time a single part of a Job can take. Since this is impossible to predict with 100% accuracy, we recommend to set this time span to at least one hour.
ADx Package
ADx retry settings are now set to the following values in the installation settings file:
##############################################################################
# ADx Conversion Jobs Retry Settings
# This mechanism periodically checks for stale ADx jobs and revives them.
# (The settings below are for now global settings, which means they can't be
# configured on repository level via the administration UI yet.)
##############################################################################
# The interval between checks for stale ADx Content representation jobs.
# Allowed units: year (y), month (m), day (d), hour (h), minute (min), second (s)
ADX_DEFAULT_JOB_REVIVE_WORKER_CHECK_INTERVAL: "5 min"
# Maximum inactivity period of a stale job before a retry.
# Allowed units: year (y), month (m), day (d), hour (h), minute (min), second (s)
ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_INACTIVITY_BEFORE_RETRY: "60 min"
# The maximum number of retries for a single job. If this number is reached,
# there will be no further retries and the problem has to be analyzed and fixed manually.
ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_TRIES: "3"
Similarly as in Conversion, you can set ADX_DEFAULT_JOB_REVIVE_WORKER_CHECK_INTERVAL as low as one minute, but we do not recommend decreasing ADX_DEFAULT_JOB_REVIVE_WORKER_MAX_INACTIVITY_BEFORE_RETRY.
New Runtime Properties
None.
Changed Runtime Properties
Default values of retry-related properties have changed, as explained in Configuration Changes.
Removed Runtime Properties
None.