Code

Updated stats dump
[gosa.git] / gosa-core / include / class_stats.inc
index 06cf3f85ae0f07707528ae173e728caa8270606a..c9b7dd80f08fa379c1cbe4ec947a1665e7d65d6e 100644 (file)
 class stats 
 {
     
-    static protected $last_cpu_load = "";
-    static protected $last_cpu_load_stamp = 0;
+    static protected $lastCpuLoad = "";
+    static protected $lastCpuLoadTimestamp = 0;
 
+    static protected $tableName = "stats";
+    static protected $tableFile = "/var/spool/gosa/stats";
 
-    static function checkDatabase()
+    static protected $lastHandle = NULL;
+    static protected $statsEnabled = FALSE;
+
+
+    static function prepareFloatForWriting($float){
+        return(floor($float * 1000));
+    }
+
+    static function prepareFloatForReading($int){
+        return($int / 1000);
+    }
+
+    static function getDatabaseHandle()
     {
-        $TABLE_NAME = 'stats';
+        // Try to return last valid handle.
+        if(stats::$lastHandle != NULL && is_resource(stats::$lastHandle)){
+            return(stats::$lastHandle);
+        }
+
+        // Check if Logging is enabled
+        global $config;
+        if(!is_object($config) || ! $config instanceOf config){
+            return(NULL);
+        }
     
-        // Check for modules
-        // php5-sqlite
+        // Get statsFile property 
+        stats::$tableFile    = $config->get_cfg_value('core', 'statsDatabaseFile');
+        stats::$statsEnabled = $config->boolValueIsTrue('core', 'statsDatabaseEnabled');
+        if(!stats::$statsEnabled){
+            return;
+        }
 
+        // Check for SQLite extension
+        if(!stats::checkSQLiteExtension()){
+            return(NULL);
+        }
+
+        // Check if we are able to read/write the given database file.
+        if(!is_writeable(stats::$tableFile) && !is_writeable(dirname(stats::$tableFile))){
+            return(NULL);
+        }
 
         // Try to create database, if it exists just open it.
-        $res = sqlite_open('/var/spool/gosa/stats', 0666, $error);
-        if(!$res){
-            return($res);
+        $handle = sqlite_popen(stats::$tableFile, 0666, $error);
+        if($handle){
+            stats::createDatabaseOnDemand($handle);
         }
+        stats::$lastHandle = $handle;
+        return($handle);
+    }
+
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
+    static function checkSQLiteExtension()
+    {
+        return(function_exists('sqlite_popen'));
+    }
 
-        // Delete Table 
+
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
+    static function dropTable($handle)
+    {
+        $TABLE_NAME = stats::$tableName;
         $query = "DROP TABLE '{$TABLE_NAME}'";
-#        $ret = sqlite_query($query, $res);
+        $ret = sqlite_query($query, $handle);
+        stats::$lastHandle = NULL;
+        stats::getDatabaseHandle();
+    }
 
-        // List Tables an check if there is already everything we need.
+
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
+    static function get_memory_usage()
+    {
+        return(memory_get_usage());
+    }
+
+
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
+    static function get_cpu_load()
+    {
+        $cur = time();
+        if(empty(stats::$lastCpuLoad) || (($cur - stats::$lastCpuLoadTimestamp) >=2 )){
+            list($one, $five, $ten) =preg_split("/ /",shell_exec('cat /proc/loadavg'));
+            stats::$lastCpuLoad = $one;
+            stats::$lastCpuLoadTimestamp = $cur;
+        }
+        return(stats::$lastCpuLoad);
+    }
+
+
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
+    static function createDatabaseOnDemand($handle)
+    {
+        $TABLE_NAME = stats::$tableName;
+
+        // List Tables an check if there is already everything we need,
+        //  if not create it.
         $query = "SELECT name FROM sqlite_master WHERE type='table' and name='{$TABLE_NAME}'";
-        $ret = sqlite_query($query, $res);
+        $ret = sqlite_query($query, $handle);
         if(!count(sqlite_fetch_all($ret))){
-
-            // Check for table existance    
             $query = "
                 CREATE TABLE {$TABLE_NAME} (
                         ID              INTEGER PRIMARY KEY,
@@ -43,73 +135,133 @@ class stats
                         TIMESTAMP       INTEGER,
                         MTIMESTAMP      REAL,
                         DURATION        REAL,
+                        RENDER_TIME     REAL,
                         AMOUNT          INTEGER,
                         MEMORY_USAGE    INTEGER,
                         CPU_LOAD        FLOAT,
                         INFO            BLOB
                         )";
-            $ret = sqlite_query($query, $res);
+            $ret = sqlite_query($query, $handle);
         }
-
-        return($res);
     }
 
 
-
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
     static function log($type, $plugin, $category, $action, $amount = 1, $duration = 0, $info ='')
     {
         global $config;
         global $clicks;
+        global $overallRenderTimer;
+
+        // Get database handle, if it is invalid (NULL) return without creating stats
+        $res = stats::getDatabaseHandle();
+#        stats::dropTable($res);
+        if(!$res) return;
+
+        // Ensure that 'clicks' and 'overallRenderTimer' are present and set correctly, 
+        //  if not simply create them with dummy values... 
+        //   -- 'clicks' is a counter wich is set in main.php -> Number of page reloads 
+        //   -- 'overallRenderTimer' is set in main.php -> timestamp of rendering start.
+        if(!isset($clicks) || empty($clicks)) $clicks = 0;
+        if(!isset($overallRenderTimer)){
+            $renderTime = 0;
+        }else{
+            $renderTime = microtime(TRUE) - $overallRenderTimer;
+
+            // Now set the overallRenderTimer to the current timestamp - else 
+            //  we will not be able to sum up the render time in a single SQL statement.
+            $overallRenderTimer = microtime(TRUE);
+        }
+
+        $duration   = stats::prepareFloatForWriting($duration);
+        $renderTime = stats::prepareFloatForWriting($renderTime);
+
+        // Prepare values to be useable within a database
+        $uuid = $config->getGOsaUUID();
         $type           = sqlite_escape_string($type);
         $plugin         = sqlite_escape_string($plugin);
         $action         = sqlite_escape_string($action);
         $timestamp      = time();
         $mtimestamp     = microtime(TRUE);
-        $uuid           = $config->getGOsaUUID();
         $amount         = sqlite_escape_string($amount);
         $duration       = sqlite_escape_string($duration);
+        $renderTime     = sqlite_escape_string($renderTime);
         $info           = sqlite_escape_string($info);
         $clicks         = sqlite_escape_string($clicks);
         $memory_usage   = sqlite_escape_string(stats::get_memory_usage());
-        $cpu_load       = sqlite_escape_string(stats::get_cpu_load());
+        $cpu_load       = sqlite_escape_string(sprintf("%0.6f",stats::get_cpu_load()));
 
+        // Clean up category, which usally comes from acl_category and may still contain 
+        //  some special chars like /
         $tmp = array();
         foreach($category as $cat){
             $tmp[] = trim($cat, '\/,; ');
         }
         $category = sqlite_escape_string(implode($tmp, ', '));
-
-        $res = stats::checkDatabase();
-        $TABLE_NAME = 'stats';
+   
+        // Create insert statement.
+        $TABLE_NAME = stats::$tableName;
         $query = "
             INSERT INTO {$TABLE_NAME}
-                (ACTID, TYPE, PLUGIN, CATEGORY, ACTION, UUID, MTIMESTAMP, TIMESTAMP, AMOUNT, DURATION, MEMORY_USAGE, CPU_LOAD, INFO) 
+                (ACTID, TYPE, PLUGIN, CATEGORY, ACTION, UUID, MTIMESTAMP, TIMESTAMP, 
+                 AMOUNT, DURATION, RENDER_TIME, MEMORY_USAGE, CPU_LOAD, INFO) 
             VALUES 
                 ('{$clicks}','{$type}','{$plugin}','{$category}','{$action}','{$uuid}',
-                    '{$mtimestamp}','{$timestamp}','{$amount}','{$duration}','{$memory_usage}','{$cpu_load}','{$info}')";
+                    '{$mtimestamp}','{$timestamp}','{$amount}','{$duration}','{$renderTime}',
+                    '{$memory_usage}','{$cpu_load}','{$info}')";
         sqlite_query($query, $res);
     }
-
-    static function get_memory_usage()
-    {
-        return(memory_get_usage());
-    }
-
-    static function get_cpu_load()
+  
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
+    static function dumpTables($from = NULL, $to = NULL)
     {
-        $cur = time();
-        if(empty(stats::$last_cpu_load) || (($cur - stats::$last_cpu_load_stamp) >=2 )){
-            list($one, $five, $ten) =preg_split("/ /",shell_exec('cat /proc/loadavg'));
-            stats::$last_cpu_load = $one;
-            stats::$last_cpu_load_stamp = $cur;
+        // Get database connection
+        $TABLE_NAME = stats::$tableName;
+        $handle = stats::getDatabaseHandle();
+        if(!$handle) return;        
+
+        // Build up filter to limit dumped entries to the given range.
+        $tim = "";
+        if($from != NULL){
+            $from = sqlite_escape_string($from);
+            $tim.= "AND TIMESTAMP >= '{$from}' ";
+        }
+        if($to != NULL){
+            $to = sqlite_escape_string($to);
+            $tim.= "AND TIMESTAMP <= '{$to}' ";
         }
-        return(stats::$last_cpu_load);
+        $tim = preg_replace("/^AND /"," WHERE ",$tim);
+
+        // Create Filter and start query
+        $filter = "SELECT * FROM {$TABLE_NAME}{$tim}";
+        $ret = sqlite_array_query($filter, $handle, SQLITE_ASSOC);
+        return($ret);
     }
-    
+
+    /*! \brief      |
+     *  @param      |
+     *  @return     |
+     */  
     static function show()
     {
-        $res = stats::checkDatabase();
-        $TABLE_NAME = 'stats';
+
+        stats::dumpTables();
+
+        return;
+
+        $res = stats::getDatabaseHandle();
+#       stats::dropTable($res);
+        if(!$res) return;        
+
+        $TABLE_NAME = stats::$tableName;
         $query = "SELECT * FROM {$TABLE_NAME} ORDER BY MTIMESTAMP";
         $query = "SELECT PLUGIN, ACTION, MAX(DURATION) as 'DURATION' FROM {$TABLE_NAME} WHERE ACTION='modify' GROUP BY PLUGIN,ACTION ";
         $query = "SELECT * FROM {$TABLE_NAME} ORDER BY ID DESC LIMIT 30";
@@ -329,8 +481,145 @@ class stats
             }
             echo "\n";
         }
-        echo "</pre>";
         echo sqlite_error_string($ret);
+
+        echo "\n------ \n";
+        echo "Time per session\n";
+        echo "------ \n";
+
+        $query = "
+            SELECT SUM(DURATION) as DUR, UUID
+            FROM {$TABLE_NAME}
+            GROUP BY UUID
+            ORDER BY DUR DESC LIMIT 10";
+        $ret = sqlite_query($query, $res);
+
+        $colSize = 16;
+        $title = FALSE;
+        foreach(sqlite_fetch_all($ret) as $entry){
+            foreach($entry as $key => $str){
+                if(is_numeric($key)) continue;
+                echo str_pad($str,$colSize,' ')."|"; 
+            }
+            echo "\n";
+        }
+        echo sqlite_error_string($ret);
+
+        echo "\n------ \n";
+        echo "Most used password hashes\n";
+        echo "------ \n";
+
+        $query = "
+            SELECT DISTINCT(INFO), COUNT(INFO) as CNT
+            FROM {$TABLE_NAME}
+            WHERE ACTION = 'change_password'
+            GROUP BY INFO
+            ORDER BY INFO DESC LIMIT 10";
+        $ret = sqlite_query($query, $res);
+
+        $colSize = 16;
+        $title = FALSE;
+        foreach(sqlite_fetch_all($ret) as $entry){
+            foreach($entry as $key => $str){
+                if(is_numeric($key)) continue;
+                echo str_pad($str,$colSize,' ')."|"; 
+            }
+            echo "\n";
+        }
+        echo sqlite_error_string($ret);
+
+        echo "\n------ \n";
+        echo "Actions at all\n";
+        echo "------ \n";
+
+        $query = "
+            SELECT DISTINCT(ACTION), COUNT(ACTION)  AS CNT
+            FROM {$TABLE_NAME}
+            GROUP BY ACTION
+            ORDER BY CNT DESC LIMIT 10";
+        $ret = sqlite_query($query, $res);
+
+        $colSize = 16;
+        $title = FALSE;
+        foreach(sqlite_fetch_all($ret) as $entry){
+            foreach($entry as $key => $str){
+                if(is_numeric($key)) continue;
+                echo str_pad($str,$colSize,' ')."|"; 
+            }
+            echo "\n";
+        }
+        echo sqlite_error_string($ret);
+
+        echo "\n------ \n";
+        echo "Time spent per action\n";
+        echo "------ \n";
+
+        $query = "
+            SELECT DISTINCT(ACTION), SUM(DURATION) AS DUR
+            FROM {$TABLE_NAME}
+            GROUP BY ACTION
+            ORDER BY DUR DESC LIMIT 10";
+        $ret = sqlite_query($query, $res);
+
+        $colSize = 16;
+        $title = FALSE;
+        foreach(sqlite_fetch_all($ret) as $entry){
+            foreach($entry as $key => $str){
+                if(is_numeric($key)) continue;
+                echo str_pad($str,$colSize,' ')."|"; 
+            }
+            echo "\n";
+        }
+        echo sqlite_error_string($ret);
+
+        echo "\n------ \n";
+        echo "Average time per action\n";
+        echo "------ \n";
+
+        $query = "
+            SELECT DISTINCT(ACTION), AVG(DURATION) AS DUR
+            FROM {$TABLE_NAME}
+            GROUP BY ACTION
+            ORDER BY DUR DESC LIMIT 10";
+        $ret = sqlite_query($query, $res);
+
+        $colSize = 16;
+        $title = FALSE;
+        foreach(sqlite_fetch_all($ret) as $entry){
+            foreach($entry as $key => $str){
+                if(is_numeric($key)) continue;
+                echo str_pad($str,$colSize,' ')."|"; 
+            }
+            echo "\n";
+        }
+        echo sqlite_error_string($ret);
+
+
+        echo "\n------ \n";
+        echo "Rendertime per plugin\n";
+        echo "------ \n";
+
+        $query = "
+            SELECT PLUGIN, RENDER_TIME AS RM
+            FROM {$TABLE_NAME}
+            GROUP BY PLUGIN
+            ORDER BY RM DESC
+            LIMIT 10
+            ";
+        $ret = sqlite_query($query, $res);
+
+        $colSize = 16;
+        $title = FALSE;
+        foreach(sqlite_fetch_all($ret) as $entry){
+            foreach($entry as $key => $str){
+                if(is_numeric($key)) continue;
+                echo str_pad($str,$colSize,' ')."|"; 
+            }
+            echo "\n";
+        }
+        echo sqlite_error_string($ret);
+
+        echo "</pre>";
     }
 }