MediaWiki  master
getLagTimes.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
27 
33 class GetLagTimes extends Maintenance {
34  public function __construct() {
35  parent::__construct();
36  $this->addDescription( 'Dump replication lag times' );
37  $this->addOption( 'report', "Report the lag values to StatsD" );
38  }
39 
40  public function execute() {
41  $services = MediaWikiServices::getInstance();
42  $lbFactory = $services->getDBLoadBalancerFactory();
43  $stats = $services->getStatsdDataFactory();
44  $lbsByType = [
45  'main' => $lbFactory->getAllMainLBs(),
46  'external' => $lbFactory->getAllExternalLBs()
47  ];
48 
49  foreach ( $lbsByType as $type => $lbs ) {
50  foreach ( $lbs as $cluster => $lb ) {
51  if ( $lb->getServerCount() <= 1 ) {
52  continue;
53  }
54  $lags = $lb->getLagTimes();
55  foreach ( $lags as $serverIndex => $lag ) {
56  $host = $lb->getServerName( $serverIndex );
57  if ( IP::isValid( $host ) ) {
58  $ip = $host;
59  $host = gethostbyaddr( $host );
60  } else {
61  $ip = gethostbyname( $host );
62  }
63 
64  $starLen = min( intval( $lag ), 40 );
65  $stars = str_repeat( '*', $starLen );
66  $this->output( sprintf( "%10s %20s %3d %s\n", $ip, $host, $lag, $stars ) );
67 
68  if ( $this->hasOption( 'report' ) ) {
69  $group = ( $type === 'external' ) ? 'external' : $cluster;
70  $stats->gauge( "loadbalancer.lag.$group.$host", intval( $lag * 1e3 ) );
71  }
72  }
73  }
74  }
75  }
76 }
77 
78 $maintClass = GetLagTimes::class;
79 require_once RUN_MAINTENANCE_IF_MAIN;
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:86
hasOption( $name)
Checks to see if a particular option exists.
$maintClass
Definition: getLagTimes.php:78
Maintenance script that displays replication lag times.
Definition: getLagTimes.php:33
static isValid( $ip)
Validate an IP address.
Definition: IP.php:111
addDescription( $text)
Set the description text.
output( $out, $channel=null)
Throw some output to the user.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.