class.ilBenchmark.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilBenchmark
{

    protected $db_bench;
    protected $start;
    protected $sql;
    protected $db_bench_stop_rec;
    protected $db_enabled_user;


    public function __construct()
    {
    }

    public $bench = array();

    public function microtimeDiff($t1, $t2)
    {
        $t1 = explode(" ", $t1);
        $t2 = explode(" ", $t2);
        $diff = $t2[0] - $t1[0] + $t2[1] - $t1[1];

        return $diff;
    }



    public function clearData()
    {
        global $DIC;
        $ilDB = $DIC->database();

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


    public function start($a_module, $a_bench)
    {
    }


    public function stop($a_module, $a_bench)
    {
    }


    public function save()
    {
        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));
            }
        }
    }


    /*
    SELECT module, benchmark, COUNT(*) AS cnt, AVG(duration) AS avg_dur FROM benchmark
    GROUP BY module, benchmark ORDER BY module, benchmark
    */

    public function getEvaluation($a_module)
    {
        $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;
    }


    public function getCurrentRecordNumber()
    {
        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"];
    }


    public function getMaximumRecords()
    {
        global $DIC;
        $ilSetting = $DIC->settings();

        return $ilSetting->get("bench_max_records");
    }


    public function setMaximumRecords($a_max)
    {
        global $DIC;
        $ilSetting = $DIC->settings();

        return $ilSetting->get("bench_max_records", (int) $a_max);
    }


    public function isEnabled()
    {
        global $DIC;
        $ilSetting = $DIC->settings();


        if (!is_object($ilSetting)) {
            return true;
        }

        return (boolean) $ilSetting->get("enable_bench");
    }


    public function enable($a_enable)
    {
        global $DIC;
        $ilSetting = $DIC->settings();


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


    public function getMeasuredModules()
    {
        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;
    }

    // BEGIN WebDAV: Get measured time.
    public function getMeasuredTime($a_module, $a_bench)
    {
        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;
    }
    // END WebDAV: Get measured time.

    //
    //
    // NEW DB BENCHMARK IMPLEMENTATION
    //
    //

    public function isDbBenchEnabled()
    {
        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;
    }

    public function enableDbBench($a_enable, $a_user = 0)
    {
        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);
            }
        }
    }


    public function startDbBench($a_sql)
    {
        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;
        }
    }


    public function stopDbBench()
    {
        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;
    }

    public function getDbBenchRecords()
    {
        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;
    }
}