MediaWiki master
Public Member Functions | Public Attributes | List of all members
Wikimedia\Rdbms\ILoadMonitor Interface Reference
Database

Database load monitoring interface. More...

Inherited by Wikimedia\Rdbms\LoadMonitor.

Public Member Functions

 __construct (ILoadBalancer $lb, BagOStuff $sCache, WANObjectCache $wCache, LoggerInterface $logger, StatsFactory $statsFactory, $options)
 Construct a new LoadMonitor with a given LoadBalancer parent.
 
 scaleLoads (array &$weightByServer)
 Perform load ratio adjustment before deciding which server to use.
 

Public Attributes

const STATE_AS_OF = 'time'
 
const STATE_CONN_COUNT = 'conn_count'
 
const STATE_UP = 'up'
 

Detailed Description

Database load monitoring interface.

Access: internal
This class should not be called outside of LoadBalancer

Definition at line 19 of file ILoadMonitor.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\ILoadMonitor::__construct ( ILoadBalancer $lb,
BagOStuff $sCache,
WANObjectCache $wCache,
LoggerInterface $logger,
StatsFactory $statsFactory,
$options )

Construct a new LoadMonitor with a given LoadBalancer parent.

Parameters
ILoadBalancer$lbLoadBalancer this instance serves
BagOStuff$sCacheLocal server memory cache
WANObjectCache$wCacheLocal cluster memory cache
LoggerInterface$loggerPSR-3 logger instance
StatsFactory$statsFactoryStatsFactory instance
array$optionsAdditional parameters include:
  • maxConnCount: maximum number of connections before circuit breaking applies [default: infinity]

Implemented in Wikimedia\Rdbms\LoadMonitor.

Member Function Documentation

◆ scaleLoads()

Wikimedia\Rdbms\ILoadMonitor::scaleLoads ( array & $weightByServer)

Perform load ratio adjustment before deciding which server to use.

Parameters
array<int,int|float>&$weightByServer Map of (server index => weight)

Implemented in Wikimedia\Rdbms\LoadMonitor, and Wikimedia\Rdbms\LoadMonitorNull.

Member Data Documentation

◆ STATE_AS_OF

const Wikimedia\Rdbms\ILoadMonitor::STATE_AS_OF = 'time'

Definition at line 22 of file ILoadMonitor.php.

◆ STATE_CONN_COUNT

const Wikimedia\Rdbms\ILoadMonitor::STATE_CONN_COUNT = 'conn_count'

Definition at line 21 of file ILoadMonitor.php.

◆ STATE_UP

const Wikimedia\Rdbms\ILoadMonitor::STATE_UP = 'up'

Definition at line 20 of file ILoadMonitor.php.

The documentation for this interface was generated from the following file: