MediaWiki  master
Wikimedia\Rdbms\TransactionProfiler Class Reference

Helper class that detects high-contention DB queries via profiling calls. More...

Inheritance diagram for Wikimedia\Rdbms\TransactionProfiler:
Collaboration diagram for Wikimedia\Rdbms\TransactionProfiler:

Public Member Functions

 __construct ()
 
 recordConnection ($server, $db, $isMaster)
 Mark a DB as having been connected to with a new handle. More...
 
 recordQueryCompletion ($query, $sTime, $isWrite=false, $n=0)
 Register the name and time of a method for slow DB trx detection. More...
 
 resetExpectations ()
 Reset performance expectations and hit counters. More...
 
 setExpectation ($event, $value, $fname)
 Set performance expectations. More...
 
 setExpectations (array $expects, $fname)
 Set multiple performance expectations. More...
 
 setLogger (LoggerInterface $logger)
 
 setSilenced ($value)
 
 transactionWritingIn ($server, $db, $id)
 Mark a DB as in a transaction with one or more writes pending. More...
 
 transactionWritingOut ($server, $db, $id, $writeTime=0.0, $affected=0)
 Mark a DB as no longer in a transaction. More...
 

Protected Member Functions

 reportExpectationViolated ($expect, $query, $actual)
 

Protected Attributes

float $dbLockThreshold = 3.0
 Seconds. More...
 
array $dbTrxHoldingLocks = []
 transaction ID => (write start time, list of DBs involved) More...
 
array $dbTrxMethodTimes = []
 transaction ID => list of (query name, start time, end time) More...
 
float $eventThreshold = 0.25
 Seconds. More...
 
array array $expect
 
array array array $expectBy = []
 
array $hits
 
bool $silenced = false
 

Private Attributes

LoggerInterface $logger
 

Detailed Description

Helper class that detects high-contention DB queries via profiling calls.

This class is meant to work with an IDatabase object, which manages queries

Since
1.24

Definition at line 38 of file TransactionProfiler.php.

Constructor & Destructor Documentation

Wikimedia\Rdbms\TransactionProfiler::__construct ( )

Member Function Documentation

Wikimedia\Rdbms\TransactionProfiler::recordConnection (   $server,
  $db,
  $isMaster 
)

Mark a DB as having been connected to with a new handle.

Note that there can be multiple connections to a single DB.

Parameters
string$serverDB server
string$dbDB name
bool$isMaster

Definition at line 156 of file TransactionProfiler.php.

References Wikimedia\Rdbms\TransactionProfiler\reportExpectationViolated().

Wikimedia\Rdbms\TransactionProfiler::recordQueryCompletion (   $query,
  $sTime,
  $isWrite = false,
  $n = 0 
)

Register the name and time of a method for slow DB trx detection.

This assumes that all queries are synchronous (non-overlapping)

Parameters
string$queryFunction name or generalized SQL
float$sTimeStarting UNIX wall time
bool$isWriteWhether this is a write query
int$nNumber of affected rows

Definition at line 204 of file TransactionProfiler.php.

References $name, $query, as, and Wikimedia\Rdbms\TransactionProfiler\reportExpectationViolated().

Wikimedia\Rdbms\TransactionProfiler::reportExpectationViolated (   $expect,
  $query,
  $actual 
)
protected
Parameters
string$expect
string$query
string | float | int$actual

Definition at line 334 of file TransactionProfiler.php.

References $query.

Referenced by Wikimedia\Rdbms\TransactionProfiler\recordConnection(), Wikimedia\Rdbms\TransactionProfiler\recordQueryCompletion(), and Wikimedia\Rdbms\TransactionProfiler\transactionWritingOut().

Wikimedia\Rdbms\TransactionProfiler::resetExpectations ( )

Reset performance expectations and hit counters.

Since
1.25

Definition at line 135 of file TransactionProfiler.php.

References as.

Wikimedia\Rdbms\TransactionProfiler::setExpectation (   $event,
  $value,
  $fname 
)

Set performance expectations.

With conflicting expectations, the most narrow ones will be used

Parameters
string$event(writes,queries,conns,mConns)
int$valueMaximum count of the event
string$fnameCaller
Since
1.25

Definition at line 106 of file TransactionProfiler.php.

References $fname, and $value.

Referenced by Wikimedia\Rdbms\TransactionProfiler\setExpectations().

Wikimedia\Rdbms\TransactionProfiler::setExpectations ( array  $expects,
  $fname 
)

Set multiple performance expectations.

With conflicting expectations, the most narrow ones will be used

Parameters
array$expectsMap of (event => limit)
string$fname
Since
1.26

Definition at line 124 of file TransactionProfiler.php.

References $fname, $value, as, and Wikimedia\Rdbms\TransactionProfiler\setExpectation().

Wikimedia\Rdbms\TransactionProfiler::setLogger ( LoggerInterface  $logger)
Wikimedia\Rdbms\TransactionProfiler::setSilenced (   $value)
Parameters
bool$value
Returns
bool Old value
Since
1.28

Definition at line 89 of file TransactionProfiler.php.

References Wikimedia\Rdbms\TransactionProfiler\$silenced, and $value.

Wikimedia\Rdbms\TransactionProfiler::transactionWritingIn (   $server,
  $db,
  $id 
)

Mark a DB as in a transaction with one or more writes pending.

Note that there can be multiple connections to a single DB.

Parameters
string$serverDB server
string$dbDB name
string$idID string of transaction

Definition at line 177 of file TransactionProfiler.php.

References $name, and as.

Wikimedia\Rdbms\TransactionProfiler::transactionWritingOut (   $server,
  $db,
  $id,
  $writeTime = 0.0,
  $affected = 0 
)

Mark a DB as no longer in a transaction.

This will check if locks are possibly held for longer than needed and log any affected transactions to a special DB log. Note that there can be multiple connections to a single DB.

Parameters
string$serverDB server
string$dbDB name
string$idID string of transaction
float$writeTimeTime spent in write queries
int$affectedNumber of rows affected by writes

Definition at line 271 of file TransactionProfiler.php.

References $name, $query, as, list, and Wikimedia\Rdbms\TransactionProfiler\reportExpectationViolated().

Member Data Documentation

float Wikimedia\Rdbms\TransactionProfiler::$dbLockThreshold = 3.0
protected

Seconds.

Definition at line 40 of file TransactionProfiler.php.

array Wikimedia\Rdbms\TransactionProfiler::$dbTrxHoldingLocks = []
protected

transaction ID => (write start time, list of DBs involved)

Definition at line 47 of file TransactionProfiler.php.

array Wikimedia\Rdbms\TransactionProfiler::$dbTrxMethodTimes = []
protected

transaction ID => list of (query name, start time, end time)

Definition at line 49 of file TransactionProfiler.php.

float Wikimedia\Rdbms\TransactionProfiler::$eventThreshold = 0.25
protected

Seconds.

Definition at line 42 of file TransactionProfiler.php.

array array Wikimedia\Rdbms\TransactionProfiler::$expect
protected
Initial value:
= [
'writes' => INF

Definition at line 59 of file TransactionProfiler.php.

array array array Wikimedia\Rdbms\TransactionProfiler::$expectBy = []
protected

Definition at line 69 of file TransactionProfiler.php.

array Wikimedia\Rdbms\TransactionProfiler::$hits
protected
Initial value:
= [
'writes' => 0

Definition at line 52 of file TransactionProfiler.php.

LoggerInterface Wikimedia\Rdbms\TransactionProfiler::$logger
private
bool Wikimedia\Rdbms\TransactionProfiler::$silenced = false
protected

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