Inherits Wikimedia\Rdbms\Replication\ReplicationReporter.

Collaboration diagram for Wikimedia\Rdbms\Replication\MysqlReplicationReporter:

[legend]

Public Member Functions

__construct ( $topologyRole, $logger, $srvCache, $lagDetectionMethod, $lagDetectionOptions, $useGTIDs)

getApproximateLagStatus (IDatabase $conn)

Get a replica DB lag estimate for this server at the start of a transaction.This is a no-op unless the server is known a priori to be a replica DB

Parameters

IDatabase $conn To make queries

Returns: array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)

Since: 1.27 in Database, moved to ReplicationReporter in 1.40

getPrimaryPos (IDatabase $conn)

Get the position of the primary DB from SHOW MASTER STATUS.

getReplicaPos (IDatabase $conn)

Get the position of the primary DB from SHOW SLAVE STATUS.

getReplicationSafetyInfo (IDatabase $conn, $fname)

primaryPosWait (IDatabase $conn, DBPrimaryPos $pos, $timeout)

Parameters

IDatabase	$conn
DBPrimaryPos	$pos
int	$timeout

Returns: int|null

Public Member Functions inherited from Wikimedia\Rdbms\Replication\ReplicationReporter

__construct ( $topologyRole, $logger, $srvCache)

getLag (IDatabase $conn)

getSessionLagStatus (IDatabase $conn)

getTopologyBasedReadOnlyReason ()

getTopologyRole ()

resetReplicationLagStatus (IDatabase $conn)

Protected Member Functions

doGetLag (IDatabase $conn)

Get the amount of replication lag for this database server.Callers should avoid using this method while a transaction is active

See also: getLag()

Parameters

IDatabase $conn To make queries

Returns: float|int|false Database replication lag in seconds or false on error

Exceptions

DBError

fetchSecondsSinceHeartbeat (IDatabase $conn)

getLagFromPtHeartbeat (IDatabase $conn)

getLagFromSlaveStatus (IDatabase $conn)

getServerGTIDs (IDatabase $conn, $fname)

getServerId (IDatabase $conn)

getServerRoleStatus (IDatabase $conn, $role, $fname)

getServerUUID (IDatabase $conn)

useGTIDs ()

Protected Member Functions inherited from Wikimedia\Rdbms\Replication\ReplicationReporter

getLogContext (IDatabase $conn, array $extras=[])

Create a log context to pass to PSR-3 logger functions.

getRecordedTransactionLagStatus (IDatabase $conn)

Get the replica DB lag when the current transaction started.

Protected Attributes
string	$lagDetectionMethod
	Method to detect replica DB lag.

array	$lagDetectionOptions = []
	Method to detect replica DB lag.

MySQLPrimaryPos	$lastKnownReplicaPos

bool	$useGTIDs = false
	bool Whether to use GTID methods

Protected Attributes inherited from Wikimedia\Rdbms\Replication\ReplicationReporter
LoggerInterface	$logger

BagOStuff	$srvCache

string	$topologyRole
	Replication topology role of the server; one of the class ROLE_* constants.

Detailed Description

Access: internal

Since: 1.40

Definition at line 25 of file MysqlReplicationReporter.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::__construct	(	$topologyRole,
		$logger,
		$srvCache,
		$lagDetectionMethod,
		$lagDetectionOptions,
		$useGTIDs )

Parameters

string	$topologyRole
LoggerInterface	$logger
BagOStuff	$srvCache
string	$lagDetectionMethod
array	$lagDetectionOptions
bool	$useGTIDs

Definition at line 50 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\Replication\MysqlReplicationReporter\$lagDetectionMethod, Wikimedia\Rdbms\Replication\MysqlReplicationReporter\$lagDetectionOptions, Wikimedia\Rdbms\Replication\ReplicationReporter\$logger, Wikimedia\Rdbms\Replication\ReplicationReporter\$srvCache, Wikimedia\Rdbms\Replication\ReplicationReporter\$topologyRole, Wikimedia\Rdbms\Replication\MysqlReplicationReporter\$useGTIDs, and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\useGTIDs().

Member Function Documentation

◆ doGetLag()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::doGetLag ( IDatabase $conn )

protected

Get the amount of replication lag for this database server.Callers should avoid using this method while a transaction is active

See also: getLag()

Parameters

IDatabase $conn To make queries

Returns: float|int|false Database replication lag in seconds or false on error

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Replication\ReplicationReporter.

Definition at line 65 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getLagFromPtHeartbeat(), and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getLagFromSlaveStatus().

◆ fetchSecondsSinceHeartbeat()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::fetchSecondsSinceHeartbeat ( IDatabase $conn )

protected

Parameters

IDatabase $conn To make queries

Returns: float|null Elapsed seconds since the newest beat or null if none was found

See also: https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html

Definition at line 143 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\Platform\ISQLPlatform\makeList(), and Wikimedia\Rdbms\IDatabase\query().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getLagFromPtHeartbeat().

◆ getApproximateLagStatus()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getApproximateLagStatus ( IDatabase $conn )

Get a replica DB lag estimate for this server at the start of a transaction.This is a no-op unless the server is known a priori to be a replica DB

Parameters

IDatabase $conn To make queries

Returns: array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)

Since: 1.27 in Database, moved to ReplicationReporter in 1.40

Reimplemented from Wikimedia\Rdbms\Replication\ReplicationReporter.

Definition at line 170 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\IReadableDatabase\getServerName().

◆ getLagFromPtHeartbeat()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getLagFromPtHeartbeat ( IDatabase $conn )

protected

Parameters

IDatabase $conn To make queries

Returns: float|false Seconds of lag

Definition at line 101 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\Replication\MysqlReplicationReporter\fetchSecondsSinceHeartbeat(), Wikimedia\Rdbms\Replication\ReplicationReporter\getLogContext(), and Wikimedia\Rdbms\Replication\ReplicationReporter\getRecordedTransactionLagStatus().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\doGetLag().

◆ getLagFromSlaveStatus()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getLagFromSlaveStatus ( IDatabase $conn )

protected

Parameters

IDatabase $conn To make queries

Returns: int|false Second of lag

Definition at line 77 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\IDatabase\query().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\doGetLag().

◆ getPrimaryPos()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getPrimaryPos ( IDatabase $conn )

Get the position of the primary DB from SHOW MASTER STATUS.

Parameters

IDatabase $conn To make queries

Returns: MySQLPrimaryPos|false

Reimplemented from Wikimedia\Rdbms\Replication\ReplicationReporter.

Definition at line 382 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getServerGTIDs(), Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getServerId(), Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getServerRoleStatus(), Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getServerUUID(), and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\useGTIDs().

◆ getReplicaPos()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getReplicaPos ( IDatabase $conn )

Get the position of the primary DB from SHOW SLAVE STATUS.

Parameters

IDatabase $conn To make queries

Returns: MySQLPrimaryPos|false

Reimplemented from Wikimedia\Rdbms\Replication\ReplicationReporter.

Definition at line 351 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getServerGTIDs(), Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getServerRoleStatus(), and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\useGTIDs().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\primaryPosWait().

◆ getReplicationSafetyInfo()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getReplicationSafetyInfo	(	IDatabase	$conn,
			$fname )

Parameters

IDatabase	$conn	To make queries
string	$fname

Returns: stdClass Process cached row

Definition at line 193 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\IReadableDatabase\selectRow().

◆ getServerGTIDs()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getServerGTIDs	(	IDatabase	$conn,
			$fname )

protected

Parameters

IDatabase	$conn	To make queries
string	$fname

Returns: string[]

Definition at line 472 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\IDatabase\query().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getPrimaryPos(), and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getReplicaPos().

◆ getServerId()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getServerId ( IDatabase $conn )

protected

Parameters

IDatabase $conn To make queries

Returns: string Value of server_id (32-bit integer, unique to the replication topology)

Exceptions

DBQueryError

Definition at line 421 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\IReadableDatabase\getServerName(), and Wikimedia\Rdbms\IDatabase\query().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getPrimaryPos().

◆ getServerRoleStatus()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getServerRoleStatus	(	IDatabase	$conn,
			$role,
			$fname )

protected

Parameters

IDatabase	$conn	To make queries
string	$role	One of "MASTER"/"SLAVE"
string	$fname

Returns: array<string,mixed>|null Latest available server status row; false on failure

Definition at line 511 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\IDatabase\query().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getPrimaryPos(), and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getReplicaPos().

◆ getServerUUID()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::getServerUUID ( IDatabase $conn )

protected

Parameters

IDatabase $conn To make queries

Returns: string|null Value of server_uuid (hyphenated 128-bit hex string, globally unique)

Exceptions

DBQueryError

Definition at line 446 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\IReadableDatabase\getServerName(), and Wikimedia\Rdbms\IDatabase\query().

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getPrimaryPos().

◆ primaryPosWait()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::primaryPosWait	(	IDatabase	$conn,
		DBPrimaryPos	$pos,
			$timeout )

Parameters

IDatabase	$conn
DBPrimaryPos	$pos
int	$timeout

Returns: int|null

Reimplemented from Wikimedia\Rdbms\Replication\ReplicationReporter.

Definition at line 216 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\DBPrimaryPos\__toString(), Wikimedia\Rdbms\Database\DbQuoter\addQuotes(), Wikimedia\Rdbms\Replication\ReplicationReporter\getLogContext(), Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getReplicaPos(), Wikimedia\Rdbms\IDatabase\query(), and Wikimedia\Rdbms\IDatabase\ROLE_STATIC_CLONE.

◆ useGTIDs()

Wikimedia\Rdbms\Replication\MysqlReplicationReporter::useGTIDs ( )

protected

Returns: bool Whether GTID support is used (mockable for testing)

Definition at line 211 of file MysqlReplicationReporter.php.

References Wikimedia\Rdbms\Replication\MysqlReplicationReporter\$useGTIDs.

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\__construct(), Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getPrimaryPos(), and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\getReplicaPos().

Member Data Documentation

◆ $lagDetectionMethod

string Wikimedia\Rdbms\Replication\MysqlReplicationReporter::$lagDetectionMethod

protected

Method to detect replica DB lag.

Definition at line 29 of file MysqlReplicationReporter.php.

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\__construct().

◆ $lagDetectionOptions

array Wikimedia\Rdbms\Replication\MysqlReplicationReporter::$lagDetectionOptions = []

protected

Method to detect replica DB lag.

Definition at line 31 of file MysqlReplicationReporter.php.

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\__construct().

◆ $lastKnownReplicaPos

MySQLPrimaryPos Wikimedia\Rdbms\Replication\MysqlReplicationReporter::$lastKnownReplicaPos

protected

Definition at line 27 of file MysqlReplicationReporter.php.

◆ $useGTIDs

bool Wikimedia\Rdbms\Replication\MysqlReplicationReporter::$useGTIDs = false

protected

bool Whether to use GTID methods

Definition at line 33 of file MysqlReplicationReporter.php.

Referenced by Wikimedia\Rdbms\Replication\MysqlReplicationReporter\__construct(), and Wikimedia\Rdbms\Replication\MysqlReplicationReporter\useGTIDs().

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

includes/libs/Rdbms/Replication/MysqlReplicationReporter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doGetLag()

◆ fetchSecondsSinceHeartbeat()

◆ getApproximateLagStatus()

◆ getLagFromPtHeartbeat()

◆ getLagFromSlaveStatus()

◆ getPrimaryPos()

◆ getReplicaPos()

◆ getReplicationSafetyInfo()

◆ getServerGTIDs()

◆ getServerId()

◆ getServerRoleStatus()

◆ getServerUUID()

◆ primaryPosWait()

◆ useGTIDs()

Member Data Documentation

◆ $lagDetectionMethod

◆ $lagDetectionOptions

◆ $lastKnownReplicaPos

◆ $useGTIDs