A simple diagnostic module for ProcessWire.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
DiagnoseDatabase.module
DiagnoseExample.module
DiagnoseFiles.module
DiagnoseImagehandling.module
DiagnoseModules.js
DiagnoseModules.module
DiagnosePhp.module
DiagnoseWebserver.module
ProcessDiagnostics.css
ProcessDiagnostics.module
readme.md

readme.md

Process Diagnostics

Introducing ProcessDiagnostics and it's helper module suite. (Is this ProcessWire's first community-created module suite?)

Example Screenshot in English Example Screenshot in German

Description

This suite adds a page under the setup menu that displays information about your installation. Each section's data is provided by a specialist diagnostic helper module but it is all collected and displayed by ProcessDiagnostics.

The ProcessDiagnostics module itself does not encode any knowledge about what makes up a good or bad setting in PW - (that's done by the helper modules) - but it does the following...

  • Gather the diagnosics (thanks to PW's hook system)
  • Display the collected diagnostics
  • Provide helper functions for describing some common things
  • Dispatch actions to diagnostic provider modules (again thanks to PW's hook system)

And eventually it will:

  • Allow control of the verbosity of the output
  • Allow the output to be emailed to a sysop
  • Store the results between visits to the page
  • Detect differences between results at set times
  • Send a notification on detection of changes

Although I am curating the collection, anyone is welcome to fork the repo, make changes in a topic branch, and submit pull requests. I've already had submissions from horst and Nico.

Diagnostic Providers

The current diagnostic providers include...

  • DiagnosePhp - Simple diagnostics about the PHP envirnoment on the server
  • DiagnoseModules - An ajax based module version checker by @Nico
  • DiagnoseImagehandler - Lets you know about GD + Imagick capabilities by @horst
  • DiagnoseDatabase - Checks each DB table and lets you know what engine and charset are in use
  • DiagnoseWebserver - Checks the webserver setup
  • DiagnoseFilesystem - Looks at how your directory and files are configured and warns of permission issues (currently incomplete)

Some of them need extending and are currently little more than skeletons. If you really want a bare bones demonstration module then take a look at DiagnoseExample

Translations

Here's a list of all the known translations

  • English (the default)
  • German (by Manfred62 - thank you!)

Help translating this suite to other languages is always welcome.