Wikimedia\Rdbms\ILoadMonitor Interface Reference

Database load monitoring interface. More...

Inherits LoggerAwareInterface, and StatsdAwareInterface.

Inherited by Wikimedia\Rdbms\LoadMonitor, and Wikimedia\Rdbms\LoadMonitorNull.

Collaboration diagram for Wikimedia\Rdbms\ILoadMonitor:

Public Member Functions
	__construct (ILoadBalancer $lb, BagOStuff $sCache, WANObjectCache $wCache, array $options=[])
	Construct a new LoadMonitor with a given LoadBalancer parent.
	getLagTimes (array $serverIndexes)
	Get an estimate of replication lag (in seconds) for each server.
	scaleLoads (array &$weightByServer)
	Perform load ratio adjustment before deciding which server to use.
Public Member Functions inherited from StatsdAwareInterface
	setStatsdDataFactory (StatsdDataFactoryInterface $statsFactory)
	Sets a StatsdDataFactory instance on the object.

Detailed Description

Database load monitoring interface.

Definition at line 32 of file ILoadMonitor.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Rdbms\ILoadMonitor::__construct	(	ILoadBalancer	$lb,
		BagOStuff	$sCache,
		WANObjectCache	$wCache,
		array	$options = [] )

Construct a new LoadMonitor with a given LoadBalancer parent.

Parameters

ILoadBalancer	$lb	LoadBalancer this instance serves
BagOStuff	$sCache	Local server memory cache
WANObjectCache	$wCache	Local cluster memory cache
array	$options	Options map

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

Member Function Documentation

getLagTimes()

Wikimedia\Rdbms\ILoadMonitor::getLagTimes

(

array

$serverIndexes

)

Get an estimate of replication lag (in seconds) for each server.

Values may be "false" if replication is too broken to estimate

Parameters

int[]

$serverIndexes

Returns

array Map of (server index => float|int|false)

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

scaleLoads()

Wikimedia\Rdbms\ILoadMonitor::scaleLoads

(

array &

$weightByServer

)

Perform load ratio adjustment before deciding which server to use.

Parameters

int[]

&$weightByServer

Map of (server index => float weight)

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

---

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

• includes/libs/rdbms/loadmonitor/ILoadMonitor.php