Quick Log View block placement

If you are interested in log events from the rendering of a page, place the Quick Log View block last in the page. You can only see events before the Quick Log View block is rendered.

Place the block on just the page you are interested in, or in a global area to make it available across the front end of a site.

If you also have Blocks by AJAX, an included Blocks by AJAX template can be used to refresh the log view without having to refresh the page.

Select who can use it

In any Quick Log View block the user(s) eligible to view the log report can be selected from:

• Anyone
• The owner of the page
• A single user
• A group of users
• Any registered user

Users that don’t have access simply don’t get to see the block and no log data will be included in the page.

Users with admin access to a page will always be eligible to view the information (unless access is set to nobody).

Take care not to leave this block publicly available on a live site.

Options

Hide while rendering

Log information is hidden while the page is rendering. When un-checked, will allow the log report to show while the page is being rendered. If php or script errors break the page this may still enable some log information to be seen.

Use toggle control

Show a toggle control for the log report. When un-checked, will always show the log report to eligible users.

AJAX update

The included Blocks by AJAX template can be used to refresh the log view without having to refresh the page (requires Blocks by AJAX to be installed).

Developer logging

The Concrete5 'Log' class is global and the addEntry method can be used by developers in any php code to add information to the log (a table in the database).

Log::addEntry($message, $namespace = false);

$message is any text, such as the contents of a variable or a note about a significant event.

$namespace is a short piece of text that can be used to categorise a log entry. If $namespace is not set, a log entry will be made to the 'debug' namespace.

If you make log entries during development purely for debugging, be sure to remove any such code before your code goes live!