popphp/pop-debug

Pop Debug Component for Pop PHP Framework

Maintainers

Details

github.com/popphp/pop-debug

Homepage

Source

Issues

Installs: 5 247

Dependents: 2

Suggesters: 0

Security: 0

Stars: 3

Watchers: 3

Forks: 0

Open Issues: 0

2.2.0 2024-11-11 18:21 UTC

Requires

Requires (Dev)

BSD-3-Clause c03433a755ea9e6e41e72217c64f2a93ec88140f

phpdebuggerpoppop phpphp debugger

This package is auto-updated.

Last update: 2024-11-19 03:40:26 UTC

README

Build Status Coverage Status

Join the chat at https://popphp.slack.com Join the chat at https://discord.gg/TZjgT74U7E

Overview

pop-debug is a debugging component that can be used to hooked into an application to track certain aspects of the application's lifecycle. It can help provide insight to an application's performance or any issues that may arise within an application.

pop-debug is a component of the Pop PHP Framework.

Install

Install pop-debug using Composer.

composer require popphp/pop-debug

Or, require it in your composer.json file

"require": {
    "popphp/pop-debug" : "^2.2.0"
}

Top

Quickstart

The basic concept of the debugger is that it works with a handler object or multiple handler objects and one storage object. The handlers are wired to listen to and track various aspects of the application and push their results to the storage object to be retrieved at a later time.

In this simple example, we can set up a generic message handler to store its triggered messages in a file.

use Pop\Debug\Debugger;
use Pop\Debug\Handler\MessageHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new MessageHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));

$debugger['message']->addMessage('Hey! Something happened!');

$debugger->save();

The above code will save the following output to the log folder in a plain text file:

1504213206.00000    Hey! Something happened!

Top

Handlers

There are a total of 6 available handlers. More handlers can be added, provided they implement the Pop\Debug\Handler\HandlerInterface interface.

Exception

The exception handler captures and tracks any exceptions thrown by an application.

use Pop\Debug\Debugger;
use Pop\Debug\Handler\ExceptionHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new ExceptionHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));

try {
    throw new \Exception('Error: This is a test exception');
} catch (\Exception $e) {
    $debugger['exception']->addException($e);
    $debugger->save();
}

The above code will save the following output to the log folder in a plain text file:

1698699170.22920	Error: This is a test exception

Top

Memory

The memory handler captures memory usages and peak memory usage. At any point in the application, you can call the updateMemoryUsage() and updatePeakMemoryUsage() methods to take a snapshot of memory usage in the app at that time.

use Pop\Debug\Debugger;
use Pop\Debug\Handler\MemoryHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new MemoryHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));


$debugger['memory']->updateMemoryUsage();
$debugger['memory']->updatePeakMemoryUsage();
sleep(2);
$debugger['memory']->updateMemoryUsage();
$debugger['memory']->updatePeakMemoryUsage();

$debugger->save();

The above code will save the following output to the log folder in a plain text file:

Limit:			128MB

Usages:
-------
1698699589.59750	1.19MB
1698699591.59760	1.19MB

Peaks:
------
1698699589.59750	1.5MB
1698699591.59770	1.5MB

Top

Message

The message handler provides simple and generic messaging to record debug events from within the application:

use Pop\Debug\Debugger;
use Pop\Debug\Handler\MessageHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new MessageHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));

$debugger['message']->addMessage('Hey! Something happened!');

$debugger->save();

The above code will save the following output to the log folder in a plain text file:

1504213206.00000    Hey! Something happened!

Top

PHP

The PHP handler provides a way to take a snapshot of common PHP info and INI values:

use Pop\Debug\Debugger;
use Pop\Debug\Handler\PhpHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new PhpHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));

$debugger->save();

The above code will save the PHP info snapshot to the debug storage resource. When used in conjunction with the logging feature, it can be useful for monitoring system requirements.

Top

Query

The query handler is a special handler that ties into the pop-db component and the profiler available with that component. It allows you to capture any database queries and any information associated with them.

You can set up the query handler like this:

use Pop\Debug\Debugger;
use Pop\Debug\Storage\File;
use Pop\Db\Db;
use Pop\Db\Record;

$db = Db::mysqlConnect([
    'database' => 'DATABASE',
    'username' => 'DB_USER',
    'password' => 'DB_PASS'
]);

class Users extends Record {}

Record::setDb($db);

// Register the query handler with the DB adapter 
$queryHandler = $db->listen('Pop\Debug\Handler\QueryHandler');

$debugger = new Debugger();
$debugger->addHandler($queryHandler);
$debugger->setStorage(new File('log'));

// Interact with the database
$user = new Users([
    'username' => 'admin',
    'password' => 'password'
]);

$user->save();

$debugger->save();

The above code will save the following output to the log folder in a plain text file:

Start:			1698720970.03826
Finish:			1698720970.05190
Elapsed:		0.01364 seconds

Queries:
--------
INSERT INTO `users` (`username`, `password`) VALUES (?, ?) [0.00743]
Start:			1698720970.04443
Finish:			1698720970.05187
Params:
	username => admin
	password => password

Top

Request

The request handler works with a Pop\Http\Server\Request object from the pop-http component and tracks all of the inbound request data. The following example would be a block of code that would run in a script that receives an inbound HTTP request:

use Pop\Debug\Debugger;
use Pop\Debug\Handler\RequestHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new RequestHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));
$debugger->save();

The above code will save the following output to the log folder in a plain text file:

GET /http.php?foo=bar [1698703989.32316]

HEADERS:
--------
Host: Host: localhost:8000
User-Agent: User-Agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/119.0
Accept: Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8
Accept-Language: Accept-Language: en-US,en;q=0.5
Accept-Encoding: Accept-Encoding: gzip, deflate, br
Connection: Connection: keep-alive
Cookie: Cookie: PHPSESSID=gm6schd82drhemu71isp26355b

SERVER:
-------
DOCUMENT_ROOT: /path/to/repo/public
REMOTE_ADDR: 127.0.0.1
REMOTE_PORT: 43394
SERVER_SOFTWARE: PHP 8.2.11 Development Server
SERVER_PROTOCOL: HTTP/1.1
SERVER_NAME: localhost
SERVER_PORT: 8000
REQUEST_URI: /http.php?foo=bar
REQUEST_METHOD: GET
SCRIPT_NAME: /http.php
SCRIPT_FILENAME: /path/to/repo/public/http.php
PHP_SELF: /http.php
QUERY_STRING: foo=bar
HTTP_HOST: localhost:8000
HTTP_USER_AGENT: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/119.0
HTTP_ACCEPT: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8
HTTP_ACCEPT_LANGUAGE: en-US,en;q=0.5
HTTP_ACCEPT_ENCODING: gzip, deflate, br
HTTP_CONNECTION: keep-alive
HTTP_COOKIE: PHPSESSID=gm6schd82drhemu71isp26355b
REQUEST_TIME_FLOAT: 1698703590.0842
REQUEST_TIME: 1698703590

GET:
----
foo: bar

COOKIE:
-------
PHPSESSID: gm6schd82drhemu71isp26355b

SESSION:
--------
_POP_SESSION_: 

PARSED:
-------
foo: bar

RAW:
----
foo=bar

Top

Time

The time handler provides a simple way to track how long a application request takes, which is useful for performance metrics.

use Pop\Debug\Debugger;
use Pop\Debug\Handler\TimeHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new TimeHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));

sleep(2);

$debugger->save();

The above code will save the following output to the log folder in a plain text file:

Start:			1698704121.29484
Stop:			1698704123.29532
Elapsed:		2.00048 seconds

Top

Storage

There are a few different storage options are available to store the output of the debugger.

File

Store the debugger output into a file in a folder location:

use Pop\Debug\Debugger;
use Pop\Debug\Handler\TimeHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger();
$debugger->addHandler(new TimeHandler());
$debugger->setStorage(new File(__DIR__ . '/log'));

Top

Database

Store the debugger output into a table in a database. The default table name is pop_debug but that can be changed with the database storage object.

use Pop\Debug\Debugger;
use Pop\Debug\Handler\TimeHandler;
use Pop\Debug\Storage\Database;
use Pop\Db\Db;

$db = Db::mysqlConnect([
    'database' => 'DATABASE',
    'username' => 'DB_USER',
    'password' => 'DB_PASS'
]);

$debugger = new Debugger();
$debugger->addHandler(new TimeHandler());
$debugger->setStorage(new Database($db, 'text', 'my_debug_table'));

Top

Formats

Three different formats are available for the storing of the debugger output:

  • Text (Default)
  • JSON
  • Serialized PHP

You can set it via the constructor:

use Pop\Debug\Storage\File;

$fileStorage = new File(__DIR__ . '/log', 'TEXT');
// OR
$fileStorage = new File(__DIR__ . '/log', 'JSON');
// OR
$fileStorage = new File(__DIR__ . '/log', 'PHP');

Also, the format can be set via the setFormat() method:

use Pop\Debug\Storage\File;

$fileStorage = new File(__DIR__ . '/log');

$fileStorage->setFormat('TEXT');
// OR
$fileStorage->setFormat('JSON');
// OR
$fileStorage->setFormat('PHP');

Top

Retrieving

You can retrieve the stored debug content from the debugger's storage adapter. Calling the save() method returns the request ID generated from that method call.

use Pop\Debug\Debugger;
use Pop\Debug\Handler\MessageHandler;
use Pop\Debug\Storage\File;

$debugger = new Debugger(
    new MessageHandler(), new MemoryHandler(), new File(__DIR__ . '/logs')
);
$debugger['message']->addMessage('Hey! Something happened!');
$requestId = $debugger->save();

The auto-generated request ID will look like:

857f0869d00b64db7c9dbdee4194781a

From there, you can call getById to retrieve stored debug content:

// A wildcard search
print_r($debugger->getById($requestId . '*'));
Array
(
    [0] => 857f0869d00b64db7c9dbdee4194781a-message.log
)

// An exact search by ID
print_r($debugger->getById('857f0869d00b64db7c9dbdee4194781a-message'));
1698773755.86070	Hey! Something happened!

The method getByType is also available to get groups of debug content by type:

print_r($debugger->getByType('message'));
Array
(
    [0] => 857f0869d00b64db7c9dbdee4194781a-message.log
    [1] => 966dc22f1c34489d7d61de295aa008a9-message.log
    [2] => f5c21a372ba375bce9b2382f67e3b70d-message.log
)

Top

Logging

The debug component can also work with the pop-log component to deliver syslog-compatible logging messages to a logging resource using the standard BSD syslog protocol RFC-3164. Logging can be used in additional to the storage adapters, or by itself, sending the debug data and information to the logging resource only and without storing anything to a storage adapter.

To work with a logger, a logger object must be passed to the debugger, along with logging parameters, which is an array of options. The minimum parameter required is a level value. The context option can also be used to log the body of the debug messaging results:

use Pop\Debug\Debugger;
use Pop\Debug\Handler\ExceptionHandler;
use Pop\Debug\Storage\File;
use Pop\Log;

$debugger = new Debugger();
$debugger->addHandler(new ExceptionHandler(true));
$debugger->addLogger(
    new Log\Logger(new Log\Writer\File(__DIR__ . '/log/debug.log')),
    [
        'level'   => Log\Logger::ERROR,
        'context' => 'json'
    ]
);

try {
    throw new Pop\Debug\Exception('This is a test debug exception');
} catch (\Exception $e) {
    $debugger['exception']->addException($e);
    $debugger->save();
}

Other logging parameters options include:

Memory

The usage_limit and peak_limit are memory-specific limits to monitor is an operation goes above the specified limits.

$loggingParams = [
    'level'       => Log\Logger::WARNING,
    'usage_limit' => '500000',  // Limit in bytes.
                                // If the usage goes above the limit,
                                // the log message is sent
    'peak_limit'  => '1000000', // Limit in bytes.
                                // If the peak usage goes above the limit,
                                // the log message is sent
];

Query, Request & Time

The limit parameter is supported for the query, request and time handlers. It is a time limit. If any of those operations take longer than the time limit, a log message is sent.

$loggingParams = [
    'level' => Log\Logger::WARNING,
    'limit' => 1, // Time limit in seconds.
                  // If the operation takes longer than the time limit,
                  // the log message is sent
];
Query Example:
use Pop\Debug\Debugger;
use Pop\Db\Db;
use Pop\Db\Record;
use Pop\Db\Adapter\Profiler\Profiler;
use Pop\Log;

$db = Db::mysqlConnect([
    'database' => 'DATABASE',
    'username' => 'DB_USER',
    'password' => 'DB_PASS'
]);

class Users extends Record {}

Record::setDb($db);

// Register the debugger and query handler with the DB adapter
$debugger = new Debugger();
$db->listen('Pop\Debug\Handler\QueryHandler', null, new Profiler($debugger));

// Add logger to the debugger
$debugger->addLogger(
    new Log\Logger(new Log\Writer\File(__DIR__ . '/log/debug.log')),
    [
        'level' => Log\Logger::INFO,
        'limit' => 1
    ]
);

// Save a user to the database - debugging and logging will automatically happen
$user = new Users([
    'username' => 'testuser',
    'password' => 'password',
    'email'    => 'testuser@test.com'
]);

$user->save();

Top