About ProcessDiagnostics

A simple diagnostic gathering suite of modules for ProcessWire CMS/CMF.

Category 1Admin Helpers
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
Category 2Logs/Monitoring
Modules that maintain activity logs or monitor and report activity in some form or another.
Category 3Process Modules
Process modules are apps that run in the ProcessWire admin.
Release StateAlpha
Non-stable. Not yet intended for use in production environments. *
Authorsnetcarver, horst, nico
Module Version0.2.2
Class NameProcessDiagnostics
Compatibility2.4, 2.5, 2.6, 2.7, 3.0
Date AddedJune 11, 2014
Last UpdatedSeptember 15, 2017
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/ProcessDiagnostics/
How to install or uninstall modules

README

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 demonstrationmodule 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.

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.