/
action-scheduler-high-volume.php
125 lines (114 loc) · 5.29 KB
/
action-scheduler-high-volume.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<?php
/**
* Plugin Name: Action Scheduler High Volume
* Plugin URI: https://github.com/prospress/action-scheduler-high-volume
* Description: Increase Action Scheduler batch size, concurrency and timeout period to process large queues of actions more quickly on servers with more server resources.
* Author: Prospress Inc.
* Author URI: http://prospress.com/
* Version: 1.1.0
*
* Copyright 2018 Prospress, Inc. (email : freedoms@prospress.com)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @author Brent Shepherd
* @since 1.0
*/
/**
* Action scheduler claims a batch of actions to process in each request. It keeps the batch
* fairly small (by default, 25) in order to prevent errors, like memory exhaustion.
*
* This method increases it so that more actions are processed in each queue, which speeds up the
* overall queue processing time due to latency in requests and the minimum 1 minute between each
* queue being processed.
*
* For more details, see: https://actionscheduler.org/perf/#increasing-batch-size
*/
function ashp_increase_queue_batch_size( $batch_size ) {
return $batch_size * 4;
}
add_filter( 'action_scheduler_queue_runner_batch_size', 'ashp_increase_queue_batch_size' );
/**
* Action scheduler processes queues of actions in parallel to speed up the processing of large numbers
* If each queue takes a long time, this will result in multiple PHP processes being used to process actions,
* which can prevent PHP processes being available to serve requests from visitors. This is why it defaults to
* only 5. However, on high volume sites, this can be increased to speed up the processing time for actions.
*
* This method hextuples the default so that more queues can be processed concurrently. Use with caution as doing
* this can take down your site completely depending on your PHP configuration.
*
* For more details, see: https://actionscheduler.org/perf/#increasing-concurrent-batches
*/
function ashp_increase_concurrent_batches( $concurrent_batches ) {
return $concurrent_batches * 2;
}
add_filter( 'action_scheduler_queue_runner_concurrent_batches', 'ashp_increase_concurrent_batches' );
/**
* Action scheduler reset actions claimed for more than 5 minutes. Because we're increasing the batch size, we
* also want to increase the amount of time given to queues before reseting claimed actions.
*/
function ashp_increase_timeout( $timeout ) {
return $timeout * 3;
}
add_filter( 'action_scheduler_timeout_period', 'ashp_increase_timeout' );
add_filter( 'action_scheduler_failure_period', 'ashp_increase_timeout' );
/**
* Action scheduler initiates one queue runner every time the 'action_scheduler_run_queue' action is triggered.
*
* Because this action is only triggered at most once every minute, that means it would take 30 minutes to spin
* up 30 queues. To handle high volume sites with powerful servers, we want to initiate additional queue runners
* whenever the 'action_scheduler_run_queue' is run, so we'll kick off secure requests to our server to do that.
*/
function ashp_request_additional_runners() {
// allow self-signed SSL certificates
add_filter( 'https_local_ssl_verify', '__return_false', 100 );
for ( $i = 0; $i < 5; $i++ ) {
$response = wp_remote_post( admin_url( 'admin-ajax.php' ), array(
'method' => 'POST',
'timeout' => 45,
'redirection' => 5,
'httpversion' => '1.0',
'blocking' => false,
'headers' => array(),
'body' => array(
'action' => 'ashp_create_additional_runners',
'instance' => $i,
'ashp_nonce' => wp_create_nonce( 'ashp_additional_runner_' . $i ),
),
'cookies' => array(),
) );
}
}
add_action( 'action_scheduler_run_queue', 'ashp_request_additional_runners', 0 );
/**
* Handle requests initiated by ashp_request_additional_runners() and start a queue runner if the request is valid.
*/
function ashp_create_additional_runners() {
if ( isset( $_POST['ashp_nonce'] ) && isset( $_POST['instance'] ) && wp_verify_nonce( $_POST['ashp_nonce'], 'ashp_additional_runner_' . $_POST['instance'] ) ) {
ActionScheduler_QueueRunner::instance()->run();
}
wp_die();
}
add_action( 'wp_ajax_nopriv_ashp_create_additional_runners', 'ashp_create_additional_runners', 0 );
/**
* Action Scheduler provides a default maximum of 30 seconds in which to process actions. Increase this to 120
* seconds for hosts like Pantheon which support such a long time limit, or if you know your PHP and Apache, Nginx
* or other web server configs support a longer time limit.
*
* Note, WP Engine only supports a maximum of 60 seconds - if using WP Engine, this will need to be decreased to 60.
*/
function ashp_increase_time_limit() {
return 120;
}
add_filter( 'action_scheduler_queue_runner_time_limit', 'ashp_increase_time_limit' );