Debugging

DEV 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

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.

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 category & log file name, this will create a file at logs/flower.log with one line:

## 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('category', 'log text');
Logger::info('category', 'log text');
Logger::notice('category', 'log text');
Logger::warning('category', 'log text');
Logger::error('category', 'log text');
Logger::critical('category', 'log text');
Logger::alert('category', 'log text');
Logger::emergency('category', 'log text');

Log Levels

The log levels are described by RFC5424

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

Logger::createCategory('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.