includes/db/LoadMonitor.php

   1 <?php
   2 /**
   3  * Database load monitoring.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Database
  22  */
  23
  24 /**
  25  * An interface for database load monitoring
  26  *
  27  * @ingroup Database
  28  */
  29 interface LoadMonitor {
  30         /**
  31          * Construct a new LoadMonitor with a given LoadBalancer parent
  32          *
  33          * @param LoadBalancer $parent
  34          */
  35         function __construct( $parent );
  36
  37         /**
  38          * Perform pre-connection load ratio adjustment.
  39          * @param array $loads
  40          * @param string|bool $group The selected query group. Default: false
  41          * @param string|bool $wiki Default: false
  42          */
  43         function scaleLoads( &$loads, $group = false, $wiki = false );
  44
  45         /**
  46          * Return an estimate of replication lag for each server
  47          *
  48          * @param array $serverIndexes
  49          * @param string $wiki
  50          *
  51          * @return array
  52          */
  53         function getLagTimes( $serverIndexes, $wiki );
  54 }
  55
  56 class LoadMonitorNull implements LoadMonitor {
  57         function __construct( $parent ) {
  58         }
  59
  60         function scaleLoads( &$loads, $group = false, $wiki = false ) {
  61         }
  62
  63         /**
  64          * @param array $serverIndexes
  65          * @param string $wiki
  66          * @return array
  67          */
  68         function getLagTimes( $serverIndexes, $wiki ) {
  69                 return array_fill_keys( $serverIndexes, 0 );
  70         }
  71 }
  72
  73 /**
  74  * Basic MySQL load monitor with no external dependencies
  75  * Uses memcached to cache the replication lag for a short time
  76  *
  77  * @ingroup Database
  78  */
  79 class LoadMonitorMySQL implements LoadMonitor {
  80         /** @var LoadBalancer */
  81         public $parent;
  82
  83         /**
  84          * @param LoadBalancer $parent
  85          */
  86         function __construct( $parent ) {
  87                 $this->parent = $parent;
  88         }
  89
  90         /**
  91          * @param array $loads
  92          * @param bool $group
  93          * @param bool $wiki
  94          */
  95         function scaleLoads( &$loads, $group = false, $wiki = false ) {
  96         }
  97
  98         /**
  99          * @param array $serverIndexes
 100          * @param string $wiki
 101          * @return array
 102          */
 103         function getLagTimes( $serverIndexes, $wiki ) {
 104                 if ( count( $serverIndexes ) == 1 && reset( $serverIndexes ) == 0 ) {
 105                         // Single server only, just return zero without caching
 106                         return array( 0 => 0 );
 107                 }
 108
 109                 wfProfileIn( __METHOD__ );
 110                 $expiry = 5;
 111                 $requestRate = 10;
 112
 113                 global $wgMemc;
 114                 if ( empty( $wgMemc ) ) {
 115                         $wgMemc = wfGetMainCache();
 116                 }
 117
 118                 $masterName = $this->parent->getServerName( 0 );
 119                 $memcKey = wfMemcKey( 'lag_times', $masterName );
 120                 $times = $wgMemc->get( $memcKey );
 121                 if ( is_array( $times ) ) {
 122                         # Randomly recache with probability rising over $expiry
 123                         $elapsed = time() - $times['timestamp'];
 124                         $chance = max( 0, ( $expiry - $elapsed ) * $requestRate );
 125                         if ( mt_rand( 0, $chance ) != 0 ) {
 126                                 unset( $times['timestamp'] ); // hide from caller
 127                                 wfProfileOut( __METHOD__ );
 128
 129                                 return $times;
 130                         }
 131                         wfIncrStats( 'lag_cache_miss_expired' );
 132                 } else {
 133                         wfIncrStats( 'lag_cache_miss_absent' );
 134                 }
 135
 136                 # Cache key missing or expired
 137                 if ( $wgMemc->add( "$memcKey:lock", 1, 10 ) ) {
 138                         # Let this process alone update the cache value
 139                         $unlocker = new ScopedCallback( function () use ( $wgMemc, $memcKey ) {
 140                                 $wgMemc->delete( $memcKey );
 141                         } );
 142                 } elseif ( is_array( $times ) ) {
 143                         # Could not acquire lock but an old cache exists, so use it
 144                         unset( $times['timestamp'] ); // hide from caller
 145                         wfProfileOut( __METHOD__ );
 146
 147                         return $times;
 148                 }
 149
 150                 $times = array();
 151                 foreach ( $serverIndexes as $i ) {
 152                         if ( $i == 0 ) { # Master
 153                                 $times[$i] = 0;
 154                         } elseif ( false !== ( $conn = $this->parent->getAnyOpenConnection( $i ) ) ) {
 155                                 $times[$i] = $conn->getLag();
 156                         } elseif ( false !== ( $conn = $this->parent->openConnection( $i, $wiki ) ) ) {
 157                                 $times[$i] = $conn->getLag();
 158                         }
 159                 }
 160
 161                 # Add a timestamp key so we know when it was cached
 162                 $times['timestamp'] = time();
 163                 $wgMemc->set( $memcKey, $times, $expiry + 10 );
 164                 unset( $times['timestamp'] ); // hide from caller
 165
 166                 wfProfileOut( __METHOD__ );
 167
 168                 return $times;
 169         }
 170 }