- Compatible XF Versions
- 2.2
- 2.3
- Additional Requirements
- You must be able to set up a unix cron task or similar on your server to execute this command.
This XenForo 2.2 addon implements an advanced CLI triggered job runner for use with Unix cron as a replacement for the built-in xf:run-jobs command introduced in XF 2.2
The command is called hg:run-jobs and does the same thing that xf:run-jobs does, but with more options and functionality.
Features
Main features of this addon:
Requirements
This addon requires PHP 7.0 or higher and has been tested on XenForo 2.2.0 beta 1
Installation
Install as per normal addon installation.
Once installed, go to the System and performance options page as change the Job run trigger setting to "Server based trigger"
First, you should test that your job runner is functioning - execute the following command from your CLI:
For example, if your forum root is /srv/www/xenforo/community, then the job runner command would be:
Running this command will execute any outstanding jobs and then finish with a message about whether there are more jobs waiting to be executed or not. When executing this command from cron, it is recommended that you use the --quiet (or -q) flag to suppress output.
Once you are happy that the job runner functions correctly, you will need to create your own cron task to run it on a schedule of your choosing.
NOTE: if you already have a cron task set up to run xf:run-jobs simply disable that and replace it with an identical task which runs hg:run-jobs instead.
Approach #1 using crontab:
It is highly recommended that you have your cron task run as the web server user to prevent potential permission problems.
For example, on Ubuntu with a web server user of www-data, install a cron task by running the following command:
Edit the crontab file and add:
Save the crontab.
Approach #2 using cron.d:
Instead of using a crontab, some Linux distributions create a well-known directory which is automatically checked for cron tasks to execute. In the case of Ubuntu, you can create files in /etc/cron.d/ where you specify the schedule, the user to execute the command as, and the command itself.
Create a file in /etc/cron.d/ with the following contents:
... where webserver-user is changed to the name of the user your web server runs as and change the path to your forum root.
Again, using our previous example where web server user is www-data and our forum root is
/srv/www/xenforo/community, I would execute the following command to create the cron file:
Both options (crontab and cron.d) will execute the job runner every minute, checking for outstanding jobs to be run.
By default, the job runner will run for a maximum of 30 seconds, executing any outstanding jobs until there are no more runnable jobs in the queue.
Upgrading from addon v1.x after upgrading XenForo to v2.2
v2.0 of this addon changes the command name and the maximum permitted run time. Note also that the --time option in v1.x has been renamed to --max-execution-time in line with the core job runner provided in XF v2.2.
To upgrade:
Configuration
You may adjust the maximum execution time of the job runner by specifying the --max-execution-time=[TIME] option on the command line.
For example, to allow the job runner to execute for a maximum of 45 seconds:
This addon uses lock files to prevent multiple job runner commands to execute at the same time, which also allows us to have the command run for longer periods on busy sites.
The maximum execution time allowed is 10 minutes (600 seconds). The command will execute until it finds no more outstanding jobs and then stop - so execution time is typically only a few seconds.
For further customisation of your job execution, you may also adjust the maximum time that each job is permitted to run.
This is configured via a XenForo config.php Option:
The jobMaxRunTime option configures the amount of time in seconds that processing jobs will be allowed to run before they are suspended for further processing on another go-around, if possible. The default setting is optimised for the browser-triggered job runner and so to allow jobs to execute longer in a CLI environment, you may want to adjust this to a higher value.
In general it is suggested that this setting be kept to a relatively small value to avoid the situation where a single very long job may prevent other jobs from executing in a timely manner. Some experimentation may be required to find the optimal value for your server load and forum size. If in doubt, leave it as the default setting of 8 seconds.
Usage
The run-jobs command should be executed automatically using a cron task as per the instructions above.
Show Jobs
The hg:show-jobs command outputs a list of all the currently pending jobs, so you can see how full the jobs queue is.
By default only the next scheduled 100 jobs will be shown, you may use the --all option to show a complete list of all pending jobs.
There should always be at least two jobs showing: the main Cron job and the Upgrade Check job.
Debugging Jobs
There are extensive debugging tools to help identify issues with Jobs and Cron tasks.
To run in debug mode, first disable the Unix cron which runs jobs automatically (don't forget to turn it back on again once you are finished debugging!) and then use the verbosity options (Verbose: -v, Very verbose: -vv or Debug: -vvv) for the hg:run-jobs command to specify the level of output to show on the console.
Output is to the console and is in a format similar to that used by the Monolog library (although we do not use Monolog to generate the output).
For example, Verbose option -v:
The Very Verbose option -vv adds context, typically about the JobResult:
And finally the Debug option -vvv adds extra information about the job:
Custom job debugging
You can add additional debugging to your custom jobs.
Add the following function to your job class to call the logJobProgress function of our Logger class:
Then you can call the log() function in your job code to send information to the console when the Job Runner is executed in verbose mode.
For example - see the test job included in this addon Hampel\JobRunner\Job\TestJob:
The above code will generate the following output when the Job Runner is in debug mode:
No output will be shown when run in quiet mode - and more importantly, if this addon is disabled the logging code will not need to be removed. The important part is the if (!isset(\XF::app['cli.logger'])) return; line, which will abort if our Logger is not available.
Custom Cron task debugging
Using a similar mechanism, we can add debugging code to our custom Cron tasks too:
Add a slightly different function to your Cron tasks to call the log() function of our Logger class:
Then, simply call something like: self::log("some message about something happening", ['key' => 'value']); within your code to output information to the console when the Job Runner is executed in verbose mode.
Logger Trait
There is also a trait you can include in your classes: Hampel\JobRunner\Cli\LoggerTrait which implements some basic logging functions you may call from your code:
The command is called hg:run-jobs and does the same thing that xf:run-jobs does, but with more options and functionality.
Features
Main features of this addon:
- allows commands to process jobs/crons for up to 10 minutes at a time, even when triggered every minute from a cron task (uses a lock file to prevent multiple executions in parallel) - ideal for improving job performance on high traffic sites
- extensive debugging output available for testing and identifying issues with jobs and cron tasks
- drop-in replacement for xf:run-jobs
Requirements
This addon requires PHP 7.0 or higher and has been tested on XenForo 2.2.0 beta 1
Installation
Install as per normal addon installation.
Once installed, go to the System and performance options page as change the Job run trigger setting to "Server based trigger"
First, you should test that your job runner is functioning - execute the following command from your CLI:
Code:
$ php <path to your forum root>/cmd.php hg:run-jobsFor example, if your forum root is /srv/www/xenforo/community, then the job runner command would be:
Code:
$ php /srv/www/xenforo/community/cmd.php hg:run-jobsRunning this command will execute any outstanding jobs and then finish with a message about whether there are more jobs waiting to be executed or not. When executing this command from cron, it is recommended that you use the --quiet (or -q) flag to suppress output.
Once you are happy that the job runner functions correctly, you will need to create your own cron task to run it on a schedule of your choosing.
NOTE: if you already have a cron task set up to run xf:run-jobs simply disable that and replace it with an identical task which runs hg:run-jobs instead.
Approach #1 using crontab:
It is highly recommended that you have your cron task run as the web server user to prevent potential permission problems.
For example, on Ubuntu with a web server user of www-data, install a cron task by running the following command:
Code:
$ sudo crontab -u www-data -eEdit the crontab file and add:
Code:
* * * * * php /path/to/your/forum/root/cmd.php --quiet hg:run-jobsSave the crontab.
Approach #2 using cron.d:
Instead of using a crontab, some Linux distributions create a well-known directory which is automatically checked for cron tasks to execute. In the case of Ubuntu, you can create files in /etc/cron.d/ where you specify the schedule, the user to execute the command as, and the command itself.
Create a file in /etc/cron.d/ with the following contents:
Code:
* * * * * webserver-user php /path/to/your/forum/root/cmd.php --quiet hg:run-jobs... where webserver-user is changed to the name of the user your web server runs as and change the path to your forum root.
Again, using our previous example where web server user is www-data and our forum root is
/srv/www/xenforo/community, I would execute the following command to create the cron file:
Code:
echo "* * * * * www-data php /srv/www/xenforo/community/cmd.php --quiet hg:run-jobs" | sudo tee -a /etc/cron.d/xenforoBoth options (crontab and cron.d) will execute the job runner every minute, checking for outstanding jobs to be run.
By default, the job runner will run for a maximum of 30 seconds, executing any outstanding jobs until there are no more runnable jobs in the queue.
Upgrading from addon v1.x after upgrading XenForo to v2.2
v2.0 of this addon changes the command name and the maximum permitted run time. Note also that the --time option in v1.x has been renamed to --max-execution-time in line with the core job runner provided in XF v2.2.
To upgrade:
- Upgrade to XF v2.2 RC2 or later
- Install v2.0.x of the addon
- change your unix cron entry to execute hg:run-jobs instead of xf:run-jobs
- if you use the --time option, rename this to --max-execution-time
- optional: adjust the --max-execution-time option to anything up to 600 seconds (10 minutes) to allow job processing to take as long as it needs. For example: --max-execution-time=180 will allow the Job Runner to execute for up to 3 minutes at a time
Configuration
You may adjust the maximum execution time of the job runner by specifying the --max-execution-time=[TIME] option on the command line.
For example, to allow the job runner to execute for a maximum of 45 seconds:
Code:
$ php <path to your forum root>/cmd.php --max-execution-time=45 hg:run-jobsThis addon uses lock files to prevent multiple job runner commands to execute at the same time, which also allows us to have the command run for longer periods on busy sites.
The maximum execution time allowed is 10 minutes (600 seconds). The command will execute until it finds no more outstanding jobs and then stop - so execution time is typically only a few seconds.
For further customisation of your job execution, you may also adjust the maximum time that each job is permitted to run.
This is configured via a XenForo config.php Option:
Code:
$config['jobMaxRunTime'] = 8;The jobMaxRunTime option configures the amount of time in seconds that processing jobs will be allowed to run before they are suspended for further processing on another go-around, if possible. The default setting is optimised for the browser-triggered job runner and so to allow jobs to execute longer in a CLI environment, you may want to adjust this to a higher value.
In general it is suggested that this setting be kept to a relatively small value to avoid the situation where a single very long job may prevent other jobs from executing in a timely manner. Some experimentation may be required to find the optimal value for your server load and forum size. If in doubt, leave it as the default setting of 8 seconds.
Usage
The run-jobs command should be executed automatically using a cron task as per the instructions above.
Show Jobs
The hg:show-jobs command outputs a list of all the currently pending jobs, so you can see how full the jobs queue is.
By default only the next scheduled 100 jobs will be shown, you may use the --all option to show a complete list of all pending jobs.
There should always be at least two jobs showing: the main Cron job and the Upgrade Check job.
Code:
$ php cmd.php xf:show-jobs
2 pending jobs found
+----------------+-----------------+----------------------+----------------------+
| Key | Class | Next Run | Last Run |
+----------------+-----------------+----------------------+----------------------+
| cron | XF\Job\Cron | 11-Apr-2019 10:52:01 | 11-Apr-2019 10:52:31 |
| xfUpgradeCheck | XF:UpgradeCheck | 12-Apr-2019 00:12:21 | 10-Apr-2019 21:24:03 |
+----------------+-----------------+----------------------+----------------------+
The current time is: 11-Apr-2019 10:52:31 (UTC+10:00)Debugging Jobs
There are extensive debugging tools to help identify issues with Jobs and Cron tasks.
To run in debug mode, first disable the Unix cron which runs jobs automatically (don't forget to turn it back on again once you are finished debugging!) and then use the verbosity options (Verbose: -v, Very verbose: -vv or Debug: -vvv) for the hg:run-jobs command to specify the level of output to show on the console.
Output is to the console and is in a format similar to that used by the Monolog library (although we do not use Monolog to generate the output).
For example, Verbose option -v:
Code:
$ php cmd.php hg:run-jobs -v
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry XF\Cron\CleanUp::runUserDowngrade executed in 0.01 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry Hampel\LogDigest\Cron\SendLogs::serverError executed in 0.00 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry XF\Cron\MemberStats::rebuildMemberStatsCache executed in 0.00 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry Hampel\Slack\Cron\NotifyLogs::notify executed in 0.03 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry XF\Cron\Feeder::importFeeds executed in 0.01 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry XFMG\Cron\RandomCache::generateRandomMediaCache executed in 0.07 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry XF\Cron\EmailBounce::process executed in 0.00 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Cron entry XF\Cron\Counters::rebuildForumStatistics executed in 0.02 seconds
[2019-11-27 23:53:09] XF\Job\Cron: Job executed in 0.20 seconds
No more runnable jobs pendingThe Very Verbose option -vv adds context, typically about the JobResult:
Code:
$ php cmd.php hg:run-jobs -vv
[2019-11-27 23:49:49] XF\Job\Cron: Cron entry Hampel\Slack\Cron\NotifyLogs::notify executed in 0.01 seconds {"entry_id":"slackNotifyServerErrors","cron_class":"Hampel\\Slack\\Cron\\NotifyLogs","cron_method":"notify","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":-1}},"active":true,"next_run":1574898543,"addon_id":"Hampel\/Slack"}
[2019-11-27 23:49:49] XF\Job\Cron: Cron entry Hampel\SparkPost\Cron\MessageEvents::fetchMessageEvents executed in 0.00 seconds {"entry_id":"sparkpostMessageEvents","cron_class":"Hampel\\SparkPost\\Cron\\MessageEvents","cron_method":"fetchMessageEvents","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":19,"1":49}},"active":true,"next_run":1574898543,"addon_id":"Hampel\/SparkPost"}
[2019-11-27 23:49:49] XF\Job\Cron: Job executed in 0.03 seconds {"completed":false,"jobId":2,"continueDate":1574898603,"continueDate_formatted":"2019-11-27 23:50:03 UTC","statusMessage":"Running... Cron entries"}
[2019-11-27 23:49:49] Hampel\SparkPost:MessageEvent: Job executed in 0.83 seconds {"completed":true,"jobId":12,"continueDate":null,"continueDate_formatted":"","statusMessage":""}
No more runnable jobs pendingAnd finally the Debug option -vvv adds extra information about the job:
Code:
$ php cmd.php hg:run-jobs -vvv
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XF\Cron\Feeder::importFeeds executed in 0.01 seconds {"entry_id":"feeder","cron_class":"XF\\Cron\\Feeder","cron_method":"importFeeds","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":2,"1":12,"2":22,"3":32,"4":42,"5":52}},"active":true,"next_run":1574879524,"addon_id":"XF"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XF\Cron\Counters::rebuildForumStatistics executed in 0.02 seconds {"entry_id":"forumStatistics","cron_class":"XF\\Cron\\Counters","cron_method":"rebuildForumStatistics","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":3,"1":13,"2":23,"3":33,"4":43,"5":53}},"active":true,"next_run":1574879584,"addon_id":"XF"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XF\Cron\MemberStats::rebuildMemberStatsCache executed in 0.03 seconds {"entry_id":"memberStatsCache","cron_class":"XF\\Cron\\MemberStats","cron_method":"rebuildMemberStatsCache","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":0,"1":10,"2":20,"3":30,"4":40,"5":50}},"active":true,"next_run":1574880004,"addon_id":"XF"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XF\Cron\Trophy::runTrophyCheck executed in 0.00 seconds {"entry_id":"trophy","cron_class":"XF\\Cron\\Trophy","cron_method":"runTrophyCheck","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":40}},"active":true,"next_run":1574880004,"addon_id":"XF"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XFMG\Cron\Statistics::cacheGalleryStatistics executed in 0.01 seconds {"entry_id":"xfmgCacheStats","cron_class":"XFMG\\Cron\\Statistics","cron_method":"cacheGalleryStatistics","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":10,"1":40}},"active":true,"next_run":1574880004,"addon_id":"XFMG"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XF\Cron\CleanUp::expireTempUserChanges executed in 0.00 seconds {"entry_id":"expireTempUserChanges","cron_class":"XF\\Cron\\CleanUp","cron_method":"expireTempUserChanges","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":42}},"active":true,"next_run":1574880124,"addon_id":"XF"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XFMG\Cron\RandomCache::generateRandomAlbumCache executed in 0.02 seconds {"entry_id":"xfmgGenerateRandomAlbum","cron_class":"XFMG\\Cron\\RandomCache","cron_method":"generateRandomAlbumCache","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":12,"1":42}},"active":true,"next_run":1574880124,"addon_id":"XFMG"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XF\Cron\EmailUnsubscribe::process executed in 0.00 seconds {"entry_id":"emailUnsubscribe","cron_class":"XF\\Cron\\EmailUnsubscribe","cron_method":"process","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":13,"1":43}},"active":true,"next_run":1574880184,"addon_id":"XF"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Cron entry XF\Cron\Ban::deleteExpiredBans executed in 0.01 seconds {"entry_id":"deleteExpiredBans","cron_class":"XF\\Cron\\Ban","cron_method":"deleteExpiredBans","run_rules":{"day_type":"dom","dom":{"0":-1},"hours":{"0":-1},"minutes":{"0":45}},"active":true,"next_run":1574880304,"addon_id":"XF"} {}
[2019-11-27 23:48:03] XF\Job\Cron: Job executed in 0.32 seconds {"completed":false,"jobId":2,"continueDate":1574898543,"continueDate_formatted":"2019-11-27 23:49:03 UTC","statusMessage":"Running... Cron entries"} {"job_id":2,"unique_key":"cron","execute_class":"XF\\Job\\Cron","execute_data":{},"manual_execute":0,"trigger_date":1574879464,"last_run_date":1574879405,"trigger_date_formatted":"2019-11-27 18:31:04 UTC","last_run_date_formatted":"2019-11-27 18:30:05 UTC"}
[2019-11-27 23:48:03] Hampel\SparkPost:MessageEvent: Job executed in 0.90 seconds {"completed":true,"jobId":10,"continueDate":null,"continueDate_formatted":"","statusMessage":""} {"job_id":10,"unique_key":"SparkPostMessageEvents","execute_class":"Hampel\\SparkPost:MessageEvent","execute_data":{},"manual_execute":0,"trigger_date":1574898483,"last_run_date":null,"trigger_date_formatted":"2019-11-27 23:48:03 UTC","last_run_date_formatted":""}
[2019-11-27 23:48:03] Hampel\SparkPost:EmailBounce: Job executed in 0.02 seconds {"completed":true,"jobId":11,"continueDate":null,"continueDate_formatted":"","statusMessage":""} {"job_id":11,"unique_key":"SparkPostEmailBounce","execute_class":"Hampel\\SparkPost:EmailBounce","execute_data":{},"manual_execute":0,"trigger_date":1574898483,"last_run_date":null,"trigger_date_formatted":"2019-11-27 23:48:03 UTC","last_run_date_formatted":""}
No more runnable jobs pendingCustom job debugging
You can add additional debugging to your custom jobs.
Add the following function to your job class to call the logJobProgress function of our Logger class:
Code:
protected function log($message, array $context = [])
{
// check to see if we actually have a logger available and abort if not
if (!isset($this->app['cli.logger'])) return;
/** @var Logger $logger */
$logger = $this->app['cli.logger'];
$logger->logJobProgress($message, $context, $this);
}Then you can call the log() function in your job code to send information to the console when the Job Runner is executed in verbose mode.
For example - see the test job included in this addon Hampel\JobRunner\Job\TestJob:
Code:
public function run($maxRunTime)
{
$this->log("About to start test job", $this->data);
$mail = $this->app->mailer()->newMail();
$mail->setTo($this->data['email']);
$mail->setContent(
"Test job",
"This is an email sent from a test job"
);
$sent = $mail->send();
$this->log("Sent mail", ['sent' => $sent]);
return $this->complete();
}The above code will generate the following output when the Job Runner is in debug mode:
Code:
$ php cmd.php hg:run-jobs -vvv
[2019-11-28 00:26:21] Hampel\JobRunner:TestJob: About to start test job {"email":"[email protected]"} {"job_id":17,"class":"Hampel\\JobRunner\\Job\\TestJob","status_message":"Testing jobs","data":{"email":"[email protected]"},"execution_time":"0.00"}
[2019-11-28 00:26:21] Hampel\JobRunner:TestJob: Sent mail {"sent":1} {"job_id":17,"class":"Hampel\\JobRunner\\Job\\TestJob","status_message":"Testing jobs","data":{"email":"[email protected]"},"execution_time":"0.95"}
[2019-11-28 00:26:21] Hampel\JobRunner:TestJob: Job executed in 0.95 seconds {"completed":true,"jobId":17,"continueDate":null,"continueDate_formatted":"","statusMessage":""} {"job_id":17,"unique_key":null,"execute_class":"Hampel\\JobRunner:TestJob","execute_data":{"email":"[email protected]"},"manual_execute":0,"trigger_date":1574900777,"last_run_date":null,"trigger_date_formatted":"2019-11-28 00:26:17 UTC","last_run_date_formatted":""}
No more runnable jobs pendingNo output will be shown when run in quiet mode - and more importantly, if this addon is disabled the logging code will not need to be removed. The important part is the if (!isset(\XF::app['cli.logger'])) return; line, which will abort if our Logger is not available.
Custom Cron task debugging
Using a similar mechanism, we can add debugging code to our custom Cron tasks too:
Add a slightly different function to your Cron tasks to call the log() function of our Logger class:
Code:
protected static function log($message, array $context = [])
{
// check to see if we actually have a logger available and abort if not
if (!isset(\XF::app['cli.logger'])) return;
/** @var Logger $logger */
$logger = \XF::app['cli.logger'];
$logger->log("XF\Job\Cron", $message, $context);
}Then, simply call something like: self::log("some message about something happening", ['key' => 'value']); within your code to output information to the console when the Job Runner is executed in verbose mode.
Logger Trait
There is also a trait you can include in your classes: Hampel\JobRunner\Cli\LoggerTrait which implements some basic logging functions you may call from your code:
- getLogger
- log
- logQuiet (will show even if the -q option is specified for the Job Runner) - use this for critical errors only
- logNormal (will show for no verbosity or higher)
- logVerbose (will show only for the -v option or higher)
- logVeryVerbose (will show only for the -vv option or higher)
- debug (will show only if the -vvv option option is specified for the Job Runner)
![[OzzModz] Job Runner Manager](/data/resource_icons/8/8952.jpg?1664750286){kind=icon}
