Differences

This shows you the differences between two versions of the page.

--- v5:reference:logging [2019/12/31 02:08] – mnewnham
+++ v5:reference:logging [2024/01/09 11:14] (current) – Remove duplicated information described under Debug Mode dregad
@@ Line 1: / Line 1: @@
 ====== Logging ======
-ADOdb provides an internal debugging system that exposes the SQL commands used to execute a command, as well as other messages that can provide guidance when, for example, trying to establish a connection to the database. The earliest that debugging can be started is after instantiating the driver but before connection. In its simplest usage, debugging is enabled as follows:
-<code php>
+ADOdb provides an internal debugging system that exposes the executed SQL commands, as well as other messages that can help when troubleshooting errors when, for example, trying to establish a connection to the database or an SQL statement fails.
-include '/adodb-dir/adodb.inc.php';
-$db = newAdoConnection('mysqli');
+The earliest that debugging can be started is after instantiating the driver but before connection.
-/*
+===== Usage =====
-* Initialize debugging
-*/
-$db->debug = true;
-$db->connect('host','user','pass','database');
+Please refer to [[v5:userguide:debug]] for details on usage.
-</code>
-===== Debugging =====
-^ Debug Level  ^ Description  ^
-| true         | Default      |
-| -1           |              |
-| -99          |              |
-| 99           |              |
-| 2            | Use the datalogging object|
-==== Overriding The Default Logging Function ====
+===== Overriding The Default Logging Function =====
 The default logging behavior is to send all messages to STDOUT, but the behavior may be modified by either:
   - Defining a constant **ADODB_OUTP** which holds the name of the function that overrides the standard value
   - A variable **$ADODB_OUTP** which is globalized and achieves the same as above. This function can be dynamically changed.
-=== Function Definition ===
+=== Function Definition ====
 The overriding function must accept 2 arguments:
   - A String which contains the message
-  - A boolean which indicates whether to throw a newling. This may be discarded based on how the function works
+  - A boolean which indicates whether to throw a newline. This may be discarded based on how the function works
-=== Example ===
+==== Example Function ====
 <code php>
 DEFINE ('ADODB_OUTP','myLogger');
@@ Line 43: / Line 29: @@
     print "\nThis is my messsage: $msg";
 }
-</code>
-==== The ADOdataLoggingObject ====
-When the debug level is true, any output is placed in an ADOdataLoggingObject, which must be extracted via an overriding ``ADODB_OUTP`` function. There are no internal methods for extracting and displaying the information. The messages are unformatted.
-<code php>
-**
-* An object in which to log/store activity data
-*/
-class ADODataLoggingObject
-{
-	/*
-	* The SQL statement(s) processed, if any
-	*/
-	public $sql;
-	/*
-	* The bind data, if any
-	*/
-	public $inputArray;
-	/*
-	* The database driver error
-	*/
-	public $errorNo = 0;
-	/*
-	* The database driver error message
-	*/
-	public $errorMessage;
-	/*
-	* The ADOdb Meta error number
-	*/
-	public $metaErrorNo = 0;
-	/*
-	* The ADOdb Meta error message
-	*/
-	public $metaErrorMessage;
-	/*
-	* The backtrace
-	*/
-	public $backTrace;
-	/*
-	* An error level that can be set if required
-	* default INFO
-	*/
-	public $errorLevel = LOG_INFO;
-}
 </code>
-==== Using Monolog For Logging Data ====
-The PHP standard logging class [[https://github.com/Seldaek/monolog|Monolog]] can be used directly with the ADOdataLoggingObject. in this example, we use it to create a classic text log from the ADOdb output.
-<code php>
-use Monolog\Logger;
-use Monolog\Handler\StreamHandler;
-require '/dev/github/vendor/autoload.php';
-/*
-* Tags log messages with ADOdb
-*/
-$loggingObject = new \Monolog\Logger('ADOdb');
-$loggingObject->pushHandler(new StreamHandler('/var/logs/adodb.log', Logger::WARNING));
-function logMessage($message,$newline=false)
-{
-	print_r($message);
-	$message = json_encode($message);
-	global $loggingObject;
-	$level = -1;
-	switch ($level)
-	{
-		default:
-		$loggingObject->log(Logger::WARNING,$message);
-		break;
-	}
-}
-DEFINE('ADODB_OUTP','logMessage').
-DEFINE('ADODB_OUTP_OBJECT',1).
-</code>