3 * Database load monitoring.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * An interface for database load monitoring
29 interface LoadMonitor
{
31 * Construct a new LoadMonitor with a given LoadBalancer parent
33 * @param LoadBalancer $parent
35 function __construct( $parent );
38 * Perform pre-connection load ratio adjustment.
40 * @param string|bool $group the selected query group. Default: false
41 * @param string|bool $wiki Default: false
43 function scaleLoads( &$loads, $group = false, $wiki = false );
46 * Perform post-connection backoff.
48 * If the connection is in overload, this should return a backoff factor
49 * which will be used to control polling time. The number of threads
50 * connected is a good measure.
52 * If there is no overload, zero can be returned.
54 * A threshold thread count is given, the concrete class may compare this
55 * to the running thread count. The threshold may be false, which indicates
56 * that the sysadmin has not configured this feature.
58 * @param $conn DatabaseBase
59 * @param $threshold Float
61 function postConnectionBackoff( $conn, $threshold );
64 * Return an estimate of replication lag for each server
66 * @param $serverIndexes
71 function getLagTimes( $serverIndexes, $wiki );
75 * @todo FIXME: Should be LoadMonitorNull per naming conventions.
76 * PHP CodeSniffer Squiz.Classes.ValidClassName.NotCamelCaps
78 class LoadMonitor_Null
implements LoadMonitor
{
79 function __construct( $parent ) {
82 function scaleLoads( &$loads, $group = false, $wiki = false ) {
85 function postConnectionBackoff( $conn, $threshold ) {
89 * @param $serverIndexes
93 function getLagTimes( $serverIndexes, $wiki ) {
94 return array_fill_keys( $serverIndexes, 0 );
99 * Basic MySQL load monitor with no external dependencies
100 * Uses memcached to cache the replication lag for a short time
103 * @todo FIXME: Should be LoadMonitorMySQL per naming conventions.
104 * PHP CodeSniffer Squiz.Classes.ValidClassName.NotCamelCaps
106 class LoadMonitor_MySQL
implements LoadMonitor
{
113 * @param LoadBalancer $parent
115 function __construct( $parent ) {
116 $this->parent
= $parent;
124 function scaleLoads( &$loads, $group = false, $wiki = false ) {
128 * @param $serverIndexes
132 function getLagTimes( $serverIndexes, $wiki ) {
133 if ( count( $serverIndexes ) == 1 && reset( $serverIndexes ) == 0 ) {
134 // Single server only, just return zero without caching
135 return array( 0 => 0 );
138 wfProfileIn( __METHOD__
);
143 if ( empty( $wgMemc ) ) {
144 $wgMemc = wfGetMainCache();
147 $masterName = $this->parent
->getServerName( 0 );
148 $memcKey = wfMemcKey( 'lag_times', $masterName );
149 $times = $wgMemc->get( $memcKey );
150 if ( is_array( $times ) ) {
151 # Randomly recache with probability rising over $expiry
152 $elapsed = time() - $times['timestamp'];
153 $chance = max( 0, ( $expiry - $elapsed ) * $requestRate );
154 if ( mt_rand( 0, $chance ) != 0 ) {
155 unset( $times['timestamp'] ); // hide from caller
156 wfProfileOut( __METHOD__
);
160 wfIncrStats( 'lag_cache_miss_expired' );
162 wfIncrStats( 'lag_cache_miss_absent' );
165 # Cache key missing or expired
166 if ( $wgMemc->add( "$memcKey:lock", 1, 10 ) ) {
167 # Let this process alone update the cache value
168 $unlocker = new ScopedCallback( function () use ( $wgMemc, $memcKey ) {
169 $wgMemc->delete( $memcKey );
171 } elseif ( is_array( $times ) ) {
172 # Could not acquire lock but an old cache exists, so use it
173 unset( $times['timestamp'] ); // hide from caller
174 wfProfileOut( __METHOD__
);
180 foreach ( $serverIndexes as $i ) {
181 if ( $i == 0 ) { # Master
183 } elseif ( false !== ( $conn = $this->parent
->getAnyOpenConnection( $i ) ) ) {
184 $times[$i] = $conn->getLag();
185 } elseif ( false !== ( $conn = $this->parent
->openConnection( $i, $wiki ) ) ) {
186 $times[$i] = $conn->getLag();
190 # Add a timestamp key so we know when it was cached
191 $times['timestamp'] = time();
192 $wgMemc->set( $memcKey, $times, $expiry +
10 );
193 unset( $times['timestamp'] ); // hide from caller
195 wfProfileOut( __METHOD__
);
201 * @param $conn DatabaseBase
205 function postConnectionBackoff( $conn, $threshold ) {
209 $status = $conn->getMysqlStatus( "Thread%" );
210 if ( $status['Threads_running'] > $threshold ) {
211 $server = $conn->getProperty( 'mServer' );
212 wfLogDBError( "LB backoff from $server - Threads_running = {$status['Threads_running']}\n" );
214 return $status['Threads_connected'];