MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / maintenance / getLagTimes.php

diff --git a/maintenance/getLagTimes.php b/maintenance/getLagTimes.php
index d39345925a8b367fdbc68c2333533487a5ba1e05..ad2fdf88fc383a94fd2e08412229931ea6b875a7 100644 (file)
--- a/maintenance/getLagTimes.php
+++ b/maintenance/getLagTimes.php
@@ -1,23 +1,79 @@
 <?php
+/**
+ * Display replication lag times.
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Maintenance
+ */
 
-require 'commandLine.inc';
-
-if( empty( $wgDBservers ) ) {
-       echo "This script dumps replication lag times, but you don't seem to have\n";
-       echo "a multi-host db server configuration.\n";
-} else {
-       $lags = $wgLoadBalancer->getLagTimes();
-       foreach( $lags as $n => $lag ) {
-               $host = $wgDBservers[$n]["host"];
-               if( IP::isValid( $host ) ) {
-                       $ip = $host;
-                       $host = gethostbyaddr( $host );
-               } else {
-                       $ip = gethostbyname( $host );
+require_once __DIR__ . '/Maintenance.php';
+
+use MediaWiki\MediaWikiServices;
+
+/**
+ * Maintenance script that displays replication lag times.
+ *
+ * @ingroup Maintenance
+ */
+class GetLagTimes extends Maintenance {
+       public function __construct() {
+               parent::__construct();
+               $this->addDescription( 'Dump replication lag times' );
+               $this->addOption( 'report', "Report the lag values to StatsD" );
+       }
+
+       public function execute() {
+               $services = MediaWikiServices::getInstance();
+               $lbFactory = $services->getDBLoadBalancerFactory();
+               $stats = $services->getStatsdDataFactory();
+               $lbsByType = [
+                       'main' => $lbFactory->getAllMainLBs(),
+                       'external' => $lbFactory->getAllExternalLBs()
+               ];
+
+               foreach ( $lbsByType as $type => $lbs ) {
+                       foreach ( $lbs as $cluster => $lb ) {
+                               if ( $lb->getServerCount() <= 1 ) {
+                                       continue;
+                               }
+                               $lags = $lb->getLagTimes();
+                               foreach ( $lags as $serverIndex => $lag ) {
+                                       $host = $lb->getServerName( $serverIndex );
+                                       if ( IP::isValid( $host ) ) {
+                                               $ip = $host;
+                                               $host = gethostbyaddr( $host );
+                                       } else {
+                                               $ip = gethostbyname( $host );
+                                       }
+
+                                       $starLen = min( intval( $lag ), 40 );
+                                       $stars = str_repeat( '*', $starLen );
+                                       $this->output( sprintf( "%10s %20s %3d %s\n", $ip, $host, $lag, $stars ) );
+
+                                       if ( $this->hasOption( 'report' ) ) {
+                                               $group = ( $type === 'external' ) ? 'external' : $cluster;
+                                               $stats->gauge( "loadbalancer.lag.$group.$host", intval( $lag * 1e3 ) );
+                                       }
+                               }
+                       }
                }
-               $starLen = min( intval( $lag ), 40 );
-               $stars = str_repeat( '*', $starLen );
-               printf( "%10s %20s %3d %s\n", $ip, $host, $lag, $stars );
        }
 }
 
+$maintClass = "GetLagTimes";
+require_once RUN_MAINTENANCE_IF_MAIN;