SiteStatsUpdate.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Deferred;
 
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\SiteStats\SiteStats;
use UnexpectedValueException;
use Wikimedia\Assert\Assert;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\RawSQLValue;
 
class SiteStatsUpdate implements DeferrableUpdate, MergeableUpdate {
    protected $edits = 0;
    protected $pages = 0;
    protected $articles = 0;
    protected $users = 0;
    protected $images = 0;
 
    private const SHARDS_OFF = 1;
    public const SHARDS_ON = 10;
 
    private const COUNTERS = [
        'ss_total_edits'   => 'edits',
        'ss_total_pages'   => 'pages',
        'ss_good_articles' => 'articles',
        'ss_users'         => 'users',
        'ss_images'        => 'images'
    ];
 
    public function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
        $this->edits = $edits;
        $this->articles = $good;
        $this->pages = $pages;
        $this->users = $users;
    }
 
    public function merge( MergeableUpdate $update ) {
        Assert::parameterType( __CLASS__, $update, '$update' );
        '@phan-var SiteStatsUpdate $update';
 
        foreach ( self::COUNTERS as $field ) {
            $this->$field += $update->$field;
        }
    }
 
    public static function factory( array $deltas ) {
        $update = new self( 0, 0, 0 );
 
        foreach ( $deltas as $name => $unused ) {
            if ( !in_array( $name, self::COUNTERS ) ) { // T187585
                throw new UnexpectedValueException( __METHOD__ . ": no field called '$name'" );
            }
        }
 
        foreach ( self::COUNTERS as $field ) {
            $update->$field = $deltas[$field] ?? 0;
        }
 
        return $update;
    }
 
    public function doUpdate() {
        $services = MediaWikiServices::getInstance();
        $stats = $services->getStatsFactory();
        $shards = $services->getMainConfig()->get( MainConfigNames::MultiShardSiteStats )
            ? self::SHARDS_ON
            : self::SHARDS_OFF;
 
        $deltaByType = [];
        foreach ( self::COUNTERS as $type ) {
            $delta = $this->$type;
            $deltaByType[$type] = $delta;
 
            // T392258: This is an operational metric for site activity and server load,
            // e.g. edit submissions and account creations.
            // When MediaWiki adjusts the "total" downward, e.g. after a re-count or
            // page deletion, we should ignore that. We have to anyway, as Prometheus
            // requires counters to monotonically increase.
            // https://prometheus.io/docs/concepts/metric_types/#counter
            if ( $delta > 0 ) {
                $stats->getCounter( 'site_stats_total' )
                    ->setLabel( 'engagement', $type )
                    ->incrementBy( $delta );
            }
        }
 
        ( new AutoCommitUpdate(
            $services->getConnectionProvider()->getPrimaryDatabase(),
            __METHOD__,
            static function ( IDatabase $dbw, $fname ) use ( $deltaByType, $shards ) {
                $set = [];
                $initValues = [];
                if ( $shards > 1 ) {
                    $shard = mt_rand( 1, $shards );
                } else {
                    $shard = 1;
                }
 
                $hasNegativeDelta = false;
                foreach ( self::COUNTERS as $field => $type ) {
                    $delta = (int)$deltaByType[$type];
                    $initValues[$field] = $delta;
                    if ( $delta > 0 ) {
                        $set[$field] = new RawSQLValue( $dbw->addIdentifierQuotes( $field ) . '+' . abs( $delta ) );
                    } elseif ( $delta < 0 ) {
                        $hasNegativeDelta = true;
                        $set[$field] = new RawSQLValue( $dbw->buildGreatest(
                            [ 'new' => $dbw->addIdentifierQuotes( $field ) ],
                            abs( $delta )
                        ) . '-' . abs( $delta ) );
                    }
                }
 
                if ( $set ) {
                    if ( $hasNegativeDelta ) {
                        $dbw->newUpdateQueryBuilder()
                            ->update( 'site_stats' )
                            ->set( $set )
                            ->where( [ 'ss_row_id' => $shard ] )
                            ->caller( $fname )->execute();
                    } else {
                        $dbw->newInsertQueryBuilder()
                            ->insertInto( 'site_stats' )
                            ->row( $initValues + [ 'ss_row_id' => $shard ] )
                            ->onDuplicateKeyUpdate()
                            ->uniqueIndexFields( [ 'ss_row_id' ] )
                            ->set( $set )
                            ->caller( $fname )->execute();
                    }
                }
            }
        ) )->doUpdate();
 
        // Invalidate cache used by parser functions
        SiteStats::unload();
    }
 
    public static function cacheUpdate( IDatabase $dbw ) {
        $services = MediaWikiServices::getInstance();
        $config = $services->getMainConfig();
 
        $rcl = $services->getRecentChangeLookup();
        $dbr = $services->getConnectionProvider()->getReplicaDatabase( false, 'vslow' );
        # Get non-bot users that did some recent action other than making accounts.
        # If account creation is included, the number gets inflated ~20+ fold on enwiki.
        $activeUsers = $dbr->newSelectQueryBuilder()
            ->select( 'COUNT(DISTINCT rc_actor)' )
            ->from( 'recentchanges' )
            ->join( 'actor', 'actor', 'actor_id=rc_actor' )
            ->where( [
                $dbr->expr( 'rc_source', '=', $rcl->getPrimarySources() ),
                $dbr->expr( 'actor_user', '!=', null ),
                $dbr->expr( 'rc_bot', '=', 0 ),
                $dbr->expr( 'rc_log_type', '!=', 'newusers' )->or( 'rc_log_type', '=', null ),
                $dbr->expr( 'rc_timestamp', '>=',
                    $dbr->timestamp( time() - $config->get( MainConfigNames::ActiveUserDays ) * 24 * 3600 ) )
            ] )
            ->caller( __METHOD__ )
            ->fetchField();
        $dbw->newUpdateQueryBuilder()
            ->update( 'site_stats' )
            ->set( [ 'ss_active_users' => intval( $activeUsers ) ] )
            ->where( [ 'ss_row_id' => 1 ] )
            ->caller( __METHOD__ )->execute();
 
        // Invalid cache used by parser functions
        SiteStats::unload();
 
        return $activeUsers;
    }
}
 
class_alias( SiteStatsUpdate::class, 'SiteStatsUpdate' );