Debugging and Logging

DEBUG Mode

Windawlker contains a development mode, you can enable it by setting config system.debug to 1, or use dev.php to access your site.

You will see a debug console at the bottom of page.

Remote Access

By default, dev.php only support localhost, you can add allow IPs to secret.yml so that you can open dev mode from remote.

dev:
    allow_ips:
        - 127.0.0.1
        - 'fe80::1'
        - '::1'
        - 123.456.654.321 ## Add your ip

Dump Data

show() is a useful helper function to replace PHP native print_r(), it will wrap all dumped string into a <pre></pre> element to format text, and can set max level limit in last argument, this code is an example to show 3 data and limit 7 levels:

show($data1, $data2, $data3, 7);

Close Debug Console

Debug console will auto push to page when system close, but sometimes we won't want it to show if in ajax or api call. Add this line to close it.

use Windwalker\Debugger\Helper\DebuggerHelper;

class AjaxController extends Controller
{
    protected function doExecute()
    {
        // Close debug console
        DebuggerHelper::disableConsole();

        $this->app->response->setMimeType('application/json');

        return json_encode(['foo' => 'bar']);
    }
}

Debugger Package

Click buttons on debug console, you will enter the Debugger page.

Windwlker will log last 100 page requests information to help us track system process.

Log your Custom Content

If you need to log some important information to debug, you can use DebugHelper to add custom data.

DebuggerHelper::addCustomData('My data', "It's not who I am underneath, but it's what I do that defines me.");

Go to system page.

You can add multiple data with same key, it will be wrapped with array.

foreach ($list as $item) {
    DebuggerHelper::addCustomData('test-data', $item);
}

Debug Flash Messages

If you queued flash messages to session, you can see them in debug console before they showed in page:

// In controller

$this->addMessage(['Hello', 'World'], 'warning');
$this->addMessage('Foo Bar', 'danger');

// Do not show them in page, we stop application.
exit();

Now you can see queued messages in debug console.

Custom Debug Messages

Sometimes you must log some debug information to help you developing, you can use debug messages:

// In controller

DebuggerHelper::addMessage('Test message1');
DebuggerHelper::addMessage('Test message2', 'warning');
DebuggerHelper::addMessage('Test message3', 'danger');

These messages will also show in debug console:

Mail Tester

Go to dev.php/_debugger/mail and you will see a mail tester.

To test a mail layout, you must pre-define a mail message class and put mail template in global /templates folder.

Then add ?class=Flower\Mail\CheckoutMessage to URL and you can test your mail layout:

Logging

Windwalker includes Monolog to help us log debugging information.

use Windwalker\Core\Logger\Logger;

Logger::log('flower', Logger::INFO, 'log text');

The first argument is channel & log file name, this will create a file at logs/flower-xxxx-xx-xx.log with one line:

By default, Windwalker use monolog RotatingStreamHandler so all file will only save logs for one day. And the max files number is 7, older log files will de deleted.

## logs/flower.log

[2016-04-01 10:17:07] flower.INFO: log text [] []

Add some data at line last.

Logger::log('flower', Logger::INFO, 'log text', array('foo' => 'bar'));

## logs/flower.log

[2016-04-01 10:18:42] flower.INFO: log text {"foo":"bar"} []

We can use proxy methods to log data:

Logger::debug('channel', 'log text');
Logger::info('channel', 'log text');
Logger::notice('channel', 'log text');
Logger::warning('channel', 'log text');
Logger::error('channel', 'log text');
Logger::critical('channel', 'log text');
Logger::alert('channel', 'log text');
Logger::emergency('channel', 'log text');

Log multiple channels:

Logger::info(['error', 'message'], 'Something wrong');

Log multiple strings:

Logger::info('error', [
    'error 1',
    'error 2',
    'error 3'
]);

Log Levels

The log levels are described by RFC5424

You can create a channel with level code, all levels below this level will not logged.

Logger::createChannel('sakura', Logger::ERROR);

Logger::debug('sakura', 'log text'); // This won't log

Logger::alert('sakura', 'log text'); // This will log

If you found a typo or error, please help us improve this document.