InfinityQuest - Programming Code Tutorials and Examples with Python, C++, Java, PHP, C#, JavaScript, Swift and more

Menu
  • Home
  • Sitemap

Python Programming Language Best Tutorials and Code Examples

Learn Python Right Now!
Home
PHP
Logging Debugging Information in PHP
PHP

Logging Debugging Information in PHP

InfinityCoder December 23, 2016

You want to make debugging easier by adding statements to print out variables. But you want to be able to switch back and forth easily between production and debug modes.

Put a function that conditionally prints out messages based on a defined constant in a page included using the auto_prepend_file configuration setting.

Save the following code to debug.php:

1
2
3
4
5
6
7
8
9
// turn debugging on
define('DEBUG',true);
 
// generic debugging function
function pc_debug($message) {
  if (defined('DEBUG') && DEBUG) {
     error_log($message);
  }
}

Set the auto_prepend_file directive in php.ini or your site .htaccess file:

1
auto_prepend_file=debug.php

Now call pc_debug() from your code to print out debugging information:

1
2
3
$sql = 'SELECT color, shape, smell FROM vegetables';
pc_debug("[sql: $sql]"); // only printed if DEBUG is true
$r = mysql_query($sql);

Debugging code is a necessary side effect of writing code. There are a variety of techniques to help you quickly locate and squash your bugs.

Many of these involve including scaffolding that helps ensure the correctness of your code. The more complicated the
program, the more scaffolding needed.

Fred Brooks, in The Mythical Man-Month (Addison-Wesley), guesses that there’s “half as much code in scaffolding as there is in product.”

Proper planning ahead of time allows you to integrate the scaffolding into your programming logic in a clean and efficient fashion.

This requires you to think out beforehand what you want to measure and record and how you plan on sorting through the data gathered by your scaffolding.
One technique for sifting through the information is to assign different priority levels to different types of debugging comments.

Then the debug function prints information only if it’s higher than the current priority level:

1
2
3
4
5
6
7
8
9
10
11
define('DEBUG',2);
 
function pc_debug($message, $level = 0) {
  if (defined('DEBUG') && ($level > DEBUG)) {
    error_log($message);
  }
}
 
$sql = 'SELECT color, shape, smell FROM vegetables';
pc_debug("[sql: $sql]", 1); // not printed, since 1 < 2
pc_debug("[sql: $sql]", 3); // printed, since 3 > 2

Another technique is to write wrapper functions to include additional information to help with performance tuning, such as the time it takes to execute a database query:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
function db_query($sql) {
  if (defined('DEBUG') && DEBUG) {
     // start timing the query if DEBUG is on
    $DEBUG_STRING = "[sql: $sql]<br>\n";
    $starttime = microtime(true);
  }
 
  $r = mysql_query($sql);
 
  if (! $r) {
     $error = mysql_error();
     error_log('[DB: query @'.$_SERVER['REQUEST_URI']."][$sql]: $error");
  } elseif (defined(DEBUG) && DEBUG) {
     // the query didn't fail and DEBUG is turned on, so finish timing it
     $endtime = microtime(true);
     $elapsedtime = $endtime - $starttime;
     $DEBUG_STRING .= "[time: $elapsedtime]<br>\n";
     error_log($DEBUG_STRING);
  }
 
  return $r;
}

Here, instead of just printing out the SQL to the error log, you also record the number of seconds it takes MySQL to perform the request.

This lets you see if certain queries are taking too long.
Finally, you may also want to integrate PEAR’s Log package, which provides an efficient framework for an abstracted logging system. PEAR Log predefines eight log levels: PEAR_LOG_EMERG, PEAR_LOG_ALERT, PEAR_LOG_CRIT, PEAR_LOG_ERR, PEAR_LOG_WARN ING, PEAR_LOG_NOTICE, PEAR_LOG_INFO, and PEAR_LOG_DEBUG.

The Log package provides a robust assortment of options for customizing error logging, including logging errors to SQLite and/or to a pop-up browser window.

Share
Tweet
Email
Prev Article
Next Article

Related Articles

Splitting a Filename into Its Component Parts in PHP
You want to find a file’s path and filename; for …

Splitting a Filename into Its Component Parts in PHP

Extracting Links from an HTML File in PHP
You need to extract the URLs that are specified inside …

Extracting Links from an HTML File in PHP

About The Author

InfinityCoder
InfinityCoder

Leave a Reply

Cancel reply

Recent Tutorials InfinityQuest

  • Adding New Features to bash Using Loadable Built-ins in bash
    Adding New Features to bash Using Loadable …
    June 27, 2017 0
  • Getting to the Bottom of Things in bash
    Getting to the Bottom of Things in …
    June 27, 2017 0

Recent Comments

  • fer on Turning a Dictionary into XML in Python
  • mahesh on Turning a Dictionary into XML in Python

Categories

  • Bash
  • PHP
  • Python
  • Uncategorized

InfinityQuest - Programming Code Tutorials and Examples with Python, C++, Java, PHP, C#, JavaScript, Swift and more

About Us

Start learning your desired programming language with InfinityQuest.com.

On our website you can access any tutorial that you want with video and code examples.

We are very happy and honored that InfinityQuest.com has been listed as a recommended learning website for students.

Popular Tags

binary data python CIDR convert string into datetime python create xml from dict python dictionary into xml python how to create xml with dict in Python how to write binary data in Python IP Address read binary data python tutorial string as date object python string to datetime python

Archives

  • June 2017
  • April 2017
  • February 2017
  • January 2017
  • December 2016
  • November 2016
Copyright © 2021 InfinityQuest - Programming Code Tutorials and Examples with Python, C++, Java, PHP, C#, JavaScript, Swift and more
Programming Tutorials | Sitemap