About Perfmon Debug Toolbar

Collects and displays debug information in a handy toolbar.

Category Development Tools
Modules that have more to do with assisting development of a site rather than managing its content.
Release StateBeta
Close to stable, but users are advised to be cautious and test thoroughly.*
Authorben
Module Version1.0.3
Class NameDebugPerfmon
Compatibility2.5, 2.6, 2.7, 3.0
Date AddedApril 1, 2016
Last UpdatedApril 12, 2016
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module is intended to be run on a development machine. To prevent the module from from mistakenly running in production, the module looks to Processwire's configuration and will only execute when debug is set to true.

1. Drop the unzipped DebugPerfmon directory into site modules
2. Set debug to true in your development site's configuration — $config->debug = true;. Use care not to leak this value into production (a local configuration override is a good idea).
3. Login to the admin, go to modules, refresh and click install

You should immediately see the collapsed toolbar in the upper right of the screen.

README

Perfmon Debug Toolbar

Processwire module used in performance monitoring and optimization.

This module is intended to be run on a development machine. To prevent the module from from mistakenly running in production, the module looks to Processwire's configuration and will only execute when debug is set to true.

The toolbar interface was inspired by the great django-debug-toolbar.

Overview

Requirements

  • PHP >=5.6 (uses REQUEST_TIME_FLOAT)
  • Processwire >=3.0

Installation

  1. drop the unzipped DebugPerfmon directory into site modules
  2. set debug to true in your development site's configuration — $config->debug = true;. Use care not to leak this value into production (a local configuration override is a good idea).
  3. login to the admin, go to modules, refresh and click install

You should immediately see the collapsed toolbar in the upper right of the screen.

Limitations

MySQL timings start being captured with the module's initialization. This means MySQL activity occurring during bootstrap is not reported. If you have any ideas how to workaround the issue without modifying core, be sure to send an email.

Page historical data is stored in the browser's localStorage. Clearing the browser history will clear the DebugPerfmon history.

Screencaps

A collapsed toolbar in the upper right hand corner of the screen.

screencap

The expanded toolbar, viewing the timings panel.

screencap