From a7f993c7f2560d9c73999e96c3dade1d0c3dc0d8 Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Wed, 26 Oct 2016 15:17:08 -0700 Subject: [PATCH] Improve getLagTimes.php output and add statsD flag * The script now lists all DBs in the LBFactory, not just those of the current wiki cluster. * Add a --report option to send the metrics to statsD so that the MediaWiki view of lag can be measured, rather than just the DB-level view. This avoids some noise with depooled servers. Bug: T149210 Change-Id: I6eae25e29aecf21251ad0eec53c56a86f35007f5 --- includes/libs/rdbms/lbfactory/ILBFactory.php | 16 +++++++++++++ .../libs/rdbms/lbfactory/LBFactoryMulti.php | 20 ++++++++++++++++ .../libs/rdbms/lbfactory/LBFactorySimple.php | 13 ++++++++++ .../libs/rdbms/lbfactory/LBFactorySingle.php | 14 +++++++++++ maintenance/getLagTimes.php | 24 +++++++++++++------ 5 files changed, 80 insertions(+), 7 deletions(-) diff --git a/includes/libs/rdbms/lbfactory/ILBFactory.php b/includes/libs/rdbms/lbfactory/ILBFactory.php index ff1bd4370b..5288c24908 100644 --- a/includes/libs/rdbms/lbfactory/ILBFactory.php +++ b/includes/libs/rdbms/lbfactory/ILBFactory.php @@ -106,6 +106,22 @@ interface ILBFactory { */ public function getExternalLB( $cluster ); + /** + * Get cached (tracked) load balancers for all main database clusters + * + * @return LoadBalancer[] Map of (cluster name => LoadBalancer) + * @since 1.29 + */ + public function getAllMainLBs(); + + /** + * Get cached (tracked) load balancers for all external database clusters + * + * @return LoadBalancer[] Map of (cluster name => LoadBalancer) + * @since 1.29 + */ + public function getAllExternalLBs(); + /** * Execute a function for each tracked load balancer * The callback is called with the load balancer as the first parameter, diff --git a/includes/libs/rdbms/lbfactory/LBFactoryMulti.php b/includes/libs/rdbms/lbfactory/LBFactoryMulti.php index a7cc16c643..1d22873640 100644 --- a/includes/libs/rdbms/lbfactory/LBFactoryMulti.php +++ b/includes/libs/rdbms/lbfactory/LBFactoryMulti.php @@ -284,6 +284,26 @@ class LBFactoryMulti extends LBFactory { return $this->extLBs[$cluster]; } + public function getAllMainLBs() { + $lbs = []; + foreach ( $this->sectionsByDB as $db => $section ) { + if ( !isset( $lbs[$section] ) ) { + $lbs[$section] = $this->getMainLB( $db ); + } + } + + return $lbs; + } + + public function getAllExternalLBs() { + $lbs = []; + foreach ( $this->externalLoads as $cluster => $unused ) { + $lbs[$cluster] = $this->getExternalLB( $cluster ); + } + + return $lbs; + } + /** * Make a new load balancer object based on template and load array * diff --git a/includes/libs/rdbms/lbfactory/LBFactorySimple.php b/includes/libs/rdbms/lbfactory/LBFactorySimple.php index 1e69d8fd3c..5bf50323df 100644 --- a/includes/libs/rdbms/lbfactory/LBFactorySimple.php +++ b/includes/libs/rdbms/lbfactory/LBFactorySimple.php @@ -108,6 +108,19 @@ class LBFactorySimple extends LBFactory { return $this->extLBs[$cluster]; } + public function getAllMainLBs() { + return [ 'DEFAULT' => $this->getMainLB() ]; + } + + public function getAllExternalLBs() { + $lbs = []; + foreach ( $this->externalClusters as $cluster => $unused ) { + $lbs[$cluster] = $this->getExternalLB( $cluster ); + } + + return $lbs; + } + private function newLoadBalancer( array $servers ) { $lb = new LoadBalancer( array_merge( $this->baseLoadBalancerParams(), diff --git a/includes/libs/rdbms/lbfactory/LBFactorySingle.php b/includes/libs/rdbms/lbfactory/LBFactorySingle.php index 94246140b6..819375d797 100644 --- a/includes/libs/rdbms/lbfactory/LBFactorySingle.php +++ b/includes/libs/rdbms/lbfactory/LBFactorySingle.php @@ -78,6 +78,20 @@ class LBFactorySingle extends LBFactory { throw new BadMethodCallException( "Method is not supported." ); } + /** + * @return LoadBalancerSingle[] Map of (cluster name => LoadBalancer) + */ + public function getAllMainLBs() { + return [ 'DEFAULT' => $this->lb ]; + } + + /** + * @return LoadBalancerSingle[] Map of (cluster name => LoadBalancer) + */ + public function getAllExternalLBs() { + return []; + } + /** * @param string|callable $callback * @param array $params diff --git a/maintenance/getLagTimes.php b/maintenance/getLagTimes.php index c2c6958733..677bfa223f 100644 --- a/maintenance/getLagTimes.php +++ b/maintenance/getLagTimes.php @@ -23,6 +23,8 @@ require_once __DIR__ . '/Maintenance.php'; +use MediaWiki\MediaWikiServices; + /** * Maintenance script that displays replication lag times. * @@ -32,27 +34,35 @@ 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() { - $lb = wfGetLB(); + $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory(); + $stats = MediaWikiServices::getInstance()->getStatsdDataFactory(); - if ( $lb->getServerCount() == 1 ) { - $this->error( "This script dumps replication lag times, but you don't seem to have\n" - . "a multi-host db server configuration." ); - } else { + $lbs = $lbFactory->getAllMainLBs() + $lbFactory->getAllExternalLBs(); + foreach ( $lbs as $cluster => $lb ) { + if ( $lb->getServerCount() <= 1 ) { + continue; + } $lags = $lb->getLagTimes(); - foreach ( $lags as $n => $lag ) { - $host = $lb->getServerName( $n ); + 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' ) ) { + $stats->gauge( "loadbalancer.lag.$cluster.$host", $lag ); + } } } } -- 2.20.1