Advanced Search

debug PHP for the newbies in error logs with execution time

/ Published in: PHP
Save to your folder(s)
I'm originally a sys admin and i love "tail - f /var/log/*" ... so i created a similar function in PHP that will allow me to view in real time what classes/functions/files/lines of my code is being run...

The usage is really simple, just set a global variable "debug" to true/false...
Note: The usage of this function will slow down your script... use it only to debug. Turn it off on production.

to view the logs, go to your default php error log file. Enjoy!

Expand | Embed | Plain Text

Copy this code and paste it in your HTML 
  1. // Do you want to debug?
  2. define('debug',true);
  3. error_reporting(E_ALL);
  4. $start_time = microtime(true);
  5. register_shutdown_function('shutdown');
  6.  
  7. // Include this function to your functions.inc.php or whatever shared libraries you are using.
  8. function debug($trace,$query = null){
  9.     if(debug){
  10.         $caller=array_shift($trace);
  11.         if(isset($caller['class']))
  12.                 error_log("Initiating class: " . $caller['class']);
  13.         if(isset($caller['function']))
  14.                 error_log("Calling function: " . $caller['function']);
  15.         error_log("In file: " . $caller['file']);
  16.         error_log("@ line: " .$caller['line']);
  17.         if(isset($query)){
  18.             error_log("Performing Query: " .$query);
  19.         }
  20.         error_log("---");
  21.     }
  22. }
  23.  
  24. function shutdown() {
  25.     global $start_time;
  26.     error_log("Execution took: ".round((microtime(true) - $start_time),4)." seconds.");
  27. }
  28.  
  29. // Add the following lines in every function:
  30. if(debug){
  31.     debug(debug_backtrace());
  32. }
  33.  
  34. // Examples:
  35. function clean($string,$type){
  36.     if(debug){
  37.         debug(debug_backtrace());
  38.     }
  39.     doTask();
  40. }
  41.  
  42. // You can also log all the queries you are using by using debug($query) like this:
  43. function selectQuery($query){
  44.     if(debug){
  45.         debug(debug_backtrace(),$query);
  46.     }
  47.     $q = mysql_query($query,$this->dblink) // Make sure $this->dblink goes to your MySQL Connection
  48.         or die("MySQL Error: " . mysql_error());
  49.     $result = mysql_fetch_assoc($q);
  50.     return $result;
  51. }
  52.  
  53.  
  54. // Result looks like this:
  55. [12-Nov-2010 11:43:36] Initiating class: Db
  56. [12-Nov-2010 11:43:36] Calling function: dblink
  57. [12-Nov-2010 11:43:36] In file: /Users/sadus/Dropbox/Code/classes/db.class.php
  58. [12-Nov-2010 11:43:36] @ line: 8
  59. [12-Nov-2010 11:43:36] ---
  60. [12-Nov-2010 11:43:36] Initiating class: Db
  61. [12-Nov-2010 11:43:36] Calling function: selectQuery
  62. [12-Nov-2010 11:43:36] In file: /Users/sadus/Dropbox/Code/classes/usermanagement.class.php
  63. [12-Nov-2010 11:43:36] @ line: 76
  64. [12-Nov-2010 11:43:36] Performing Query: SELECT * 
  65.                     FROM user
  66.                     WHERE email = '' AND verified = '1' LIMIT 1
  67. [12-Nov-2010 11:43:36] ---
  68. [12-Nov-2010 11:43:36] Execution took: 0.0076 seconds.

Report this snippet


Comments

RSS Icon Subscribe to comments

You need to login to post a comment.