7e5de85900
* Improve various job descriptions where I know.
* Annotate DeletePageJob as since 1.32 (commit ca9f1dabf3),
and consider it stable to construct ("newable") to reflect
the status quo, which is that WMF-deployed extensions do queue
this job sometimes.
* Annotate various other jobs as `@internal` where I believe it is
not intended by the authors for these to be queued by other code
and where no such usage exists.
Follows similar commits to the objectcache, rdbms, profiler,
filerepo components and other areas [1].
* Remove duplicate descriptions from file blocks in favour of class
doc blocks. This reduces needless duplication and was often
incorrect or outdated, and helps (ironically) to make the header
more consistently visually ignorable.
* Remove `ingroup` from file blocks in class files as otherwise
the file is indexed twice (e.g. in Doxygen) which makes
navigation messy.
[1] https://gerrit.wikimedia.org/r/q/message:ingroup+owner:Krinkle
Change-Id: I6509325ee3ddcda733a600db194a63d79dfd5bd0
110 lines
3.6 KiB
PHP
110 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* 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
|
|
*/
|
|
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
|
|
/**
|
|
* Report number of jobs currently waiting in primary database.
|
|
*
|
|
* Based on runJobs.php. Note that this only works for JobQueue backends
|
|
* that implement JobQueue::doGetSize. Implementations based on Kafka,
|
|
* for example, might not have a way to obtain this. In that case,
|
|
* telemetry should be provided externally, e.g. with Grafana/Prometheus.
|
|
*
|
|
* @ingroup Maintenance
|
|
* @author Tim Starling
|
|
* @author Antoine Musso
|
|
*/
|
|
class ShowJobs extends Maintenance {
|
|
protected static $stateMethods = [
|
|
'unclaimed' => 'getAllQueuedJobs',
|
|
'delayed' => 'getAllDelayedJobs',
|
|
'claimed' => 'getAllAcquiredJobs',
|
|
'abandoned' => 'getAllAbandonedJobs',
|
|
];
|
|
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Show number of jobs waiting in primary database' );
|
|
$this->addOption( 'group', 'Show number of jobs per job type' );
|
|
$this->addOption( 'list', 'Show a list of all jobs instead of counts' );
|
|
$this->addOption( 'type', 'Only show/count jobs of a given type', false, true );
|
|
$this->addOption( 'status', 'Filter list by state (unclaimed,delayed,claimed,abandoned)' );
|
|
$this->addOption( 'limit', 'Limit of jobs listed' );
|
|
}
|
|
|
|
public function execute() {
|
|
$typeFilter = $this->getOption( 'type', '' );
|
|
$stateFilter = $this->getOption( 'status', '' );
|
|
$stateLimit = (float)$this->getOption( 'limit', INF );
|
|
|
|
$group = MediaWikiServices::getInstance()->getJobQueueGroup();
|
|
|
|
$filteredTypes = $typeFilter
|
|
? [ $typeFilter ]
|
|
: $group->getQueueTypes();
|
|
$filteredStates = $stateFilter
|
|
? array_intersect_key( self::$stateMethods, [ $stateFilter => 1 ] )
|
|
: self::$stateMethods;
|
|
|
|
if ( $this->hasOption( 'list' ) ) {
|
|
$count = 0;
|
|
foreach ( $filteredTypes as $type ) {
|
|
$queue = $group->get( $type );
|
|
foreach ( $filteredStates as $state => $method ) {
|
|
foreach ( $queue->$method() as $job ) {
|
|
/** @var Job $job */
|
|
$this->output( $job->toString() . " status=$state\n" );
|
|
if ( ++$count >= $stateLimit ) {
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif ( $this->hasOption( 'group' ) ) {
|
|
foreach ( $filteredTypes as $type ) {
|
|
$queue = $group->get( $type );
|
|
$delayed = $queue->getDelayedCount();
|
|
$pending = $queue->getSize();
|
|
$claimed = $queue->getAcquiredCount();
|
|
$abandoned = $queue->getAbandonedCount();
|
|
$active = max( 0, $claimed - $abandoned );
|
|
if ( ( $pending + $claimed + $delayed + $abandoned ) > 0 ) {
|
|
$this->output(
|
|
"{$type}: $pending queued; " .
|
|
"$claimed claimed ($active active, $abandoned abandoned); " .
|
|
"$delayed delayed\n"
|
|
);
|
|
}
|
|
}
|
|
} else {
|
|
$count = 0;
|
|
foreach ( $filteredTypes as $type ) {
|
|
$count += $group->get( $type )->getSize();
|
|
}
|
|
$this->output( "$count\n" );
|
|
}
|
|
}
|
|
}
|
|
|
|
$maintClass = ShowJobs::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|