ilBenchmark Class Reference

performance measurement class More...

Collaboration diagram for ilBenchmark:

Public Member Functions
	ilBenchmark ()
	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 ()
	stop measurement More...
	getDbBenchRecords ()
	Get db benchmark records. More...

Data Fields
	$bench = array()

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.

Member Function Documentation

clearData()

ilBenchmark::clearData

(

)

delete all measurement data

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

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

References $ilDB.

enable()

ilBenchmark::enable

(

$a_enable

)

enable benchmarking

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

        {
                global $ilias;
 
                if ($a_enable)
                {
                        $ilias->setSetting("enable_bench", 1);
                }
                else
                {
                        $ilias->setSetting("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 306 of file class.ilBenchmark.php.

        {
                global $ilias;
 
                if ($a_enable)
                {
                        $ilias->setSetting("enable_db_bench", 1);
                        if ($a_user !== 0)
                        {
                                $ilias->setSetting("db_bench_user", $a_user);
                        }
                }
                else
                {
                        $ilias->setSetting("enable_db_bench", 0);
                        if ($a_user !== 0)
                        {
                                $ilias->setSetting("db_bench_user", $a_user);
                        }
                }
        }

Referenced by save().

Here is the caller graph for this function:

getCurrentRecordNumber()

ilBenchmark::getCurrentRecordNumber

(

)

get current number of benchmark records

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

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

References $ilDB.

getDbBenchRecords()

ilBenchmark::getDbBenchRecords

(

)

Get db benchmark records.

Parameters

return

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

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

References $ilDB.

getEvaluation()

ilBenchmark::getEvaluation

(

$a_module

)

get performance evaluation data

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

        {
                global $ilDB;
 
                $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;
        }

References $ilDB.

getMaximumRecords()

ilBenchmark::getMaximumRecords

(

)

get maximum number of benchmark records

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

        {
                global $ilias;
 
                return $ilias->getSetting("bench_max_records");
        }

getMeasuredModules()

ilBenchmark::getMeasuredModules

(

)

get all current measured modules

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

        {
                global $ilDB;
 
                $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;
        }

References $ilDB.

getMeasuredTime()

ilBenchmark::getMeasuredTime	(		$a_module,
			$a_bench
	)

Get measurement.

Returns

Measurement in milliseconds.

Definition at line 262 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;
        }

ilBenchmark()

ilBenchmark::ilBenchmark

(

)

constructor

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

        {
        }

isDbBenchEnabled()

ilBenchmark::isDbBenchEnabled

(

)

Check wether benchmarking is enabled or not.

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

        {
                global $ilSetting;
 
                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;
        }

References $ilSetting.

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

Here is the caller graph for this function:

isEnabled()

ilBenchmark::isEnabled

(

)

check wether benchmarking is enabled or not

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

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

References $ilSetting.

Referenced by start(), and stop().

Here is the caller graph for this function:

microtimeDiff()

ilBenchmark::microtimeDiff	(		$t1,
			$t2
	)

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

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

Referenced by save(), and stop().

Here is the caller graph for this function:

save()

ilBenchmark::save

(

)

save all measurements

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

        {
                global $ilDB, $ilUser;
 
                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)
                                {
                                        $ilDB->insert("benchmark", array(
                                                "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)
                        {
                                global $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));
                        }
                }
 
        }

References $_GET, $_POST, $GLOBALS, $ilDB, $ilIliasIniFile, $ilUser, enableDbBench(), isDbBenchEnabled(), microtimeDiff(), and ilUtil\shortenText().

Here is the call graph for this function:

setMaximumRecords()

ilBenchmark::setMaximumRecords

(

$a_max

)

set maximum number of benchmark records

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

        {
                global $ilias;
 
                $ilias->setSetting("bench_max_records", (int) $a_max);
        }

start()

ilBenchmark::start	(		$a_module,
			$a_bench
	)

start measurement

Parameters

string

$type

measurement type

Returns

int measurement id

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

        {
return;
                if ($this->isEnabled())
                {
                        $this->bench[$a_module.":".$a_bench][] = microtime();
                }
        }

References isEnabled().

Referenced by startDbBench(), and stopDbBench().

Here is the call graph for this function:

Here is the caller graph for this function:

startDbBench()

ilBenchmark::startDbBench

(

$a_sql

)

start measurement

Parameters

string

$type

measurement type

Returns

int measurement id

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

        {
                global $ilUser;
 
                if ($this->isDbBenchEnabled() && is_object($ilUser) &&
                        $this->db_enabled_user == $ilUser->getLogin() &&
                        !$this->db_bench_stop_rec)
                {
                        $this->start = microtime();
                        $this->sql = $a_sql;
                }
        }

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

Here is the call graph for this function:

stop()

ilBenchmark::stop	(		$a_module,
			$a_bench
	)

stop measurement

Parameters

int

$mid

measurement id

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

        {
return;
                if ($this->isEnabled())
                {
                        $this->bench[$a_module.":".$a_bench][count($this->bench[$a_module.":".$a_bench]) - 1]
                                = $this->microtimeDiff($this->bench[$a_module.":".$a_bench][count($this->bench[$a_module.":".$a_bench]) - 1], microtime());
                }
        }

References isEnabled(), and microtimeDiff().

Here is the call graph for this function:

stopDbBench()

ilBenchmark::stopDbBench

(

)

stop measurement

Parameters

int

$mid

measurement id

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

        {
                global $ilUser;
 
                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);
                }
        }

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

Here is the call graph for this function:

Field Documentation

$bench

ilBenchmark::$bench = array()

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

---

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

• Services/Utilities/classes/class.ilBenchmark.php