performance measurement class More...

Collaboration diagram for ilBenchmark:

Public Member Functions
	__construct ()
	Constructor. More...

	microtimeDiff ($t1, $t2)

	clearData ()
	delete all measurement data More...

	start ($a_module, $a_bench)
	start measurement More...

	stop ($a_module, $a_bench)
	stop measurement More...

	save ()
	save all measurements More...

	getEvaluation ($a_module)
	get performance evaluation data More...

	getCurrentRecordNumber ()
	get current number of benchmark records More...

	getMaximumRecords ()
	get maximum number of benchmark records More...

	setMaximumRecords ($a_max)
	set maximum number of benchmark records More...

	isEnabled ()
	check wether benchmarking is enabled or not More...

	enable ($a_enable)
	enable benchmarking More...

	getMeasuredModules ()
	get all current measured modules More...

	getMeasuredTime ($a_module, $a_bench)
	Get measurement. More...

	isDbBenchEnabled ()
	Check wether benchmarking is enabled or not. More...

	enableDbBench ($a_enable, $a_user=0)
	Enable DB benchmarking. More...

	startDbBench ($a_sql)
	start measurement More...

	stopDbBench ()

	getDbBenchRecords ()
	Get db benchmark records. More...

Data Fields
	$bench = array()

Protected Attributes
	$db_bench

	$start

	$sql

	$db_bench_stop_rec

	$db_enabled_user

Detailed Description

performance measurement class

Author: Alex Killing Alex..nosp@m.Kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilBenchmark.php.

Constructor & Destructor Documentation

◆ __construct()

ilBenchmark::__construct ( )

Constructor.

Definition at line 40 of file class.ilBenchmark.php.

41 {

42 }

Member Function Documentation

◆ clearData()

ilBenchmark::clearData ( )

delete all measurement data

Definition at line 63 of file class.ilBenchmark.php.

References $DIC, and $ilDB.

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $q = "DELETE FROM benchmark";
         $ilDB->manipulate($q);
     }

◆ enable()

ilBenchmark::enable ( $a_enable )

enable benchmarking

Definition at line 237 of file class.ilBenchmark.php.

References $DIC, and $ilSetting.

     {
         global $DIC;
         $ilSetting = $DIC->settings();
 
 
         if ($a_enable) {
             $ilSetting->get("enable_bench", 1);
         } else {
             $ilSetting->get("enable_bench", 0);
         }
     }

◆ enableDbBench()

ilBenchmark::enableDbBench	(	$a_enable,
		$a_user = `0`
	)

Enable DB benchmarking.

Parameters

boolean	enable db benchmarking
string	user account name that should be benchmarked

Definition at line 320 of file class.ilBenchmark.php.

References $DIC, and $ilSetting.

Referenced by save().

     {
         global $DIC;
         $ilSetting = $DIC->settings();
 
 
         if ($a_enable) {
             $ilSetting->set("enable_db_bench", 1);
             if ($a_user !== 0) {
                 $ilSetting->set("db_bench_user", $a_user);
             }
         } else {
             $ilSetting->set("enable_db_bench", 0);
             if ($a_user !== 0) {
                 $ilSetting->set("db_bench_user", $a_user);
             }
         }
     }

Here is the caller graph for this function:

◆ getCurrentRecordNumber()

ilBenchmark::getCurrentRecordNumber ( )

get current number of benchmark records

Definition at line 180 of file class.ilBenchmark.php.

References $DIC, and $ilDB.

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $q = "SELECT COUNT(*) AS cnt FROM benchmark";
         $cnt_set = $ilDB->query($q);
         $cnt_rec = $ilDB->fetchAssoc($cnt_set);
 
         return $cnt_rec["cnt"];
     }

◆ getDbBenchRecords()

ilBenchmark::getDbBenchRecords ( )

Get db benchmark records.

Parameters

Definition at line 400 of file class.ilBenchmark.php.

References $DIC, $ilDB, and array.

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $set = $ilDB->query("SELECT * FROM benchmark");
         $b = array();
         while ($rec = $ilDB->fetchAssoc($set)) {
             $b[] = array("sql" => $rec["sql_stmt"],
                 "time" => $rec["duration"]);
         }
         return $b;
     }

◆ getEvaluation()

ilBenchmark::getEvaluation ( $a_module )

get performance evaluation data

Definition at line 156 of file class.ilBenchmark.php.

References $ilDB, and array.

     {
         $ilDB = $this->db;
 
         $q = "SELECT COUNT(*) AS cnt, AVG(duration) AS avg_dur, benchmark," .
             " MIN(duration) AS min_dur, MAX(duration) AS max_dur" .
             " FROM benchmark" .
             " WHERE module = " . $ilDB->quote($a_module, "text") . " " .
             " GROUP BY benchmark" .
             " ORDER BY benchmark";
         $bench_set = $ilDB->query($q);
         $eva = array();
         while ($bench_rec = $ilDB->fetchAssoc($bench_set)) {
             $eva[] = array("benchmark" => $bench_rec["benchmark"],
                 "cnt" => $bench_rec["cnt"], "duration" => $bench_rec["avg_dur"],
                 "min" => $bench_rec["min_dur"], "max" => $bench_rec["max_dur"]);
         }
         return $eva;
     }

◆ getMaximumRecords()

ilBenchmark::getMaximumRecords ( )

get maximum number of benchmark records

Definition at line 196 of file class.ilBenchmark.php.

References $DIC, and $ilSetting.

     {
         global $DIC;
         $ilSetting = $DIC->settings();
 
         return $ilSetting->get("bench_max_records");
     }

◆ getMeasuredModules()

ilBenchmark::getMeasuredModules ( )

get all current measured modules

Definition at line 254 of file class.ilBenchmark.php.

References $DIC, $ilDB, and array.

     {
         global $DIC;
         $ilDB = $DIC->database();
 
 
         $q = "SELECT DISTINCT module FROM benchmark";
         $mod_set = $ilDB->query($q);
 
         $modules = array();
         while ($mod_rec = $ilDB->fetchAssoc($mod_set)) {
             $modules[$mod_rec["module"]] = $mod_rec["module"];
         }
 
         return $modules;
     }

◆ getMeasuredTime()

ilBenchmark::getMeasuredTime	(	$a_module,
		$a_bench
	)

Get measurement.

Returns: Measurement in milliseconds.

Definition at line 277 of file class.ilBenchmark.php.

     {
         if (isset($this->bench[$a_module . ":" . $a_bench])) {
             return $this->bench[$a_module . ":" . $a_bench][count($this->bench[$a_module . ":" . $a_bench]) - 1];
         }
         return false;
     }

◆ isDbBenchEnabled()

ilBenchmark::isDbBenchEnabled ( )

Check wether benchmarking is enabled or not.

Definition at line 295 of file class.ilBenchmark.php.

References $DIC, and $ilSetting.

Referenced by save(), startDbBench(), and stopDbBench().

     {
         global $DIC;
         $ilSetting = $DIC->settings();
 
 
         if (isset($this->db_enabled)) {
             return $this->db_enabled;
         }
 
         if (!is_object($ilSetting)) {
             return false;
         }
 
         $this->db_enabled = $ilSetting->get("enable_db_bench");
         $this->db_enabled_user = $ilSetting->get("db_bench_user");
         return $this->db_enabled;
     }

Here is the caller graph for this function:

◆ isEnabled()

ilBenchmark::isEnabled ( )

check wether benchmarking is enabled or not

Definition at line 220 of file class.ilBenchmark.php.

References $DIC, and $ilSetting.

     {
         global $DIC;
         $ilSetting = $DIC->settings();
 
 
         if (!is_object($ilSetting)) {
             return true;
         }
 
         return (boolean) $ilSetting->get("enable_bench");
     }

◆ microtimeDiff()

ilBenchmark::microtimeDiff	(	$t1,
		$t2
	)

Definition at line 49 of file class.ilBenchmark.php.

Referenced by save().

     {
         $t1 = explode(" ", $t1);
         $t2 = explode(" ", $t2);
         $diff = $t2[0] - $t1[0] + $t2[1] - $t1[1];
 
         return $diff;
     }

Here is the caller graph for this function:

◆ save()

ilBenchmark::save ( )

save all measurements

Definition at line 100 of file class.ilBenchmark.php.

References $_GET, $_POST, $DIC, $GLOBALS, $id, $ilDB, $ilIliasIniFile, $ilUser, array, defined, enableDbBench(), isDbBenchEnabled(), microtimeDiff(), ilUtil\shortenText(), and ilLog\write().

     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         if ($this->isDbBenchEnabled() && is_object($ilUser) &&
             $this->db_enabled_user == $ilUser->getLogin()) {
             if (is_array($this->db_bench) && is_object($ilDB)) {
                 $this->db_bench_stop_rec = true;
 
                 $ilDB->manipulate("DELETE FROM benchmark");
                 foreach ($this->db_bench as $b) {
                     $id = $ilDB->nextId('benchmark');
                     $ilDB->insert("benchmark", array(
                         "id" => array("integer", $id),
                         "duration" => array("float", $this->microtimeDiff($b["start"], $b["stop"])),
                         "sql_stmt" => array("clob", $b["sql"])
                     ));
                 }
             }
             $this->enableDbBench(false);
         }
 
         // log slow requests
         //define("LOG_SLOW_REQUESTS", (float) "0.1");
         if (defined("SLOW_REQUEST_TIME") && SLOW_REQUEST_TIME > 0) {
             $t1 = explode(" ", $GLOBALS['ilGlobalStartTime']);
             $t2 = explode(" ", microtime());
             $diff = $t2[0] - $t1[0] + $t2[1] - $t1[1];
             if ($diff > SLOW_REQUEST_TIME) {
                 $ilIliasIniFile = $DIC["ilIliasIniFile"];
                 
                 $diff = round($diff, 4);
                 
                 include_once("./Services/Logging/classes/class.ilLog.php");
                 $slow_request_log = new ilLog(
                     $ilIliasIniFile->readVariable("log", "slow_request_log_path"),
                     $ilIliasIniFile->readVariable("log", "slow_request_log_file"),
                     CLIENT_ID
                 );
                 $slow_request_log->write("SLOW REQUEST (" . $diff . "), Client:" . CLIENT_ID . ", GET: " .
                     str_replace("\n", " ", print_r($_GET, true)) . ", POST: " .
                     ilUtil::shortenText(str_replace("\n", " ", print_r($_POST, true)), 800, true));
             }
         }
     }

Here is the call graph for this function:

◆ setMaximumRecords()

ilBenchmark::setMaximumRecords ( $a_max )

set maximum number of benchmark records

Definition at line 208 of file class.ilBenchmark.php.

References $DIC, and $ilSetting.

     {
         global $DIC;
         $ilSetting = $DIC->settings();
 
         return $ilSetting->get("bench_max_records", (int) $a_max);
     }

◆ start()

ilBenchmark::start	(	$a_module,
		$a_bench
	)

start measurement

Parameters

string $type measurement type

Returns: int measurement id

Deprecated:

Definition at line 81 of file class.ilBenchmark.php.

Referenced by startDbBench(), and stopDbBench().

82 {

83 }

Here is the caller graph for this function:

◆ startDbBench()

ilBenchmark::startDbBench ( $a_sql )

start measurement

Parameters

string $a_sql

Returns: bool|int

Definition at line 347 of file class.ilBenchmark.php.

References $db_bench_stop_rec, $DIC, $ilUser, isDbBenchEnabled(), and start().

     {
         global $DIC;
 
         try {
             $ilUser = $DIC->user();
         } catch (InvalidArgumentException $e) {
             return false;
         }
 
         if ($this->isDbBenchEnabled() && is_object($ilUser)
             && $this->db_enabled_user == $ilUser->getLogin()
             && !$this->db_bench_stop_rec) {
             $this->start = microtime();
             $this->sql = $a_sql;
         }
     }

Here is the call graph for this function:

◆ stop()

ilBenchmark::stop	(	$a_module,
		$a_bench
	)

stop measurement

Parameters

int $mid measurement id

Deprecated:

Definition at line 92 of file class.ilBenchmark.php.

93 {

94 }

◆ stopDbBench()

ilBenchmark::stopDbBench ( )

Returns: bool

Definition at line 369 of file class.ilBenchmark.php.

References $db_bench_stop_rec, $DIC, $ilUser, array, isDbBenchEnabled(), and start().

     {
         global $DIC;
 
         try {
             $ilUser = $DIC->user();
         } catch (InvalidArgumentException $e) {
             return false;
         }
 
         if ($this->isDbBenchEnabled() && is_object($ilUser)
             && $this->db_enabled_user == $ilUser->getLogin()
             && !$this->db_bench_stop_rec) {
             $this->db_bench[] = array(
                 "start" => $this->start,
                 "stop"  => microtime(),
                 "sql"   => $this->sql,
             );
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $bench

ilBenchmark::$bench = array()

Definition at line 44 of file class.ilBenchmark.php.

◆ $db_bench

ilBenchmark::$db_bench

protected

Definition at line 18 of file class.ilBenchmark.php.

◆ $db_bench_stop_rec

ilBenchmark::$db_bench_stop_rec

protected

Definition at line 30 of file class.ilBenchmark.php.

Referenced by startDbBench(), and stopDbBench().

◆ $db_enabled_user

ilBenchmark::$db_enabled_user

protected

Definition at line 34 of file class.ilBenchmark.php.

◆ $sql

ilBenchmark::$sql

protected

Definition at line 26 of file class.ilBenchmark.php.

◆ $start

ilBenchmark::$start

protected

Definition at line 22 of file class.ilBenchmark.php.

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

Services/Utilities/classes/class.ilBenchmark.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clearData()

◆ enable()

◆ enableDbBench()

◆ getCurrentRecordNumber()

◆ getDbBenchRecords()

◆ getEvaluation()

◆ getMaximumRecords()

◆ getMeasuredModules()

◆ getMeasuredTime()

◆ isDbBenchEnabled()

◆ isEnabled()

◆ microtimeDiff()

◆ save()

◆ setMaximumRecords()

◆ start()

◆ startDbBench()

◆ stop()

◆ stopDbBench()

Field Documentation

◆ $bench

◆ $db_bench

◆ $db_bench_stop_rec

◆ $db_enabled_user

◆ $sql

◆ $start