callabra/debug

wrapper for debugging tools

v0.1.7 2023-05-18 23:49 UTC

Requires

• php: >=8.0
• monolog/monolog: ^3.0
• rollbar/rollbar: ^4

MIT

README

Wrapper for interacting for various debug and logging tools.

First add environmental variables defining which debug channels you would like to use.

SetEnv DEBUG_ERROR_CHANNELS FirePHP,File,Pushover
SetEnv DEBUG_WARNING_CHANNELS FirePHP
SetEnv DEBUG_INFO_CHANNELS FirePHP,File

Then call like so

\Debug\Log::error("message",$value);
\Debug\Log::warn("message",$value);
\Debug\Log::info("message",$value);

Each channel you defined in the environment variables will then output your data.

If you are using log files you will need to set the default path like this.

SetEnv DEBUG_FILE_PATH /var/www/logs/

Currently channels are as follows:

• File - logs to files. default directory /var/www/logs
• Console - prints to browser console - f12 key
• ChromePHP - browser plug-in - https://craig.is/writing/chrome-logger
• FirePHP - browser plug-in - http://www.firephp.org/
• Pushover - app for phones - https://pushover.net/
• Rollbar - error logging service - https://www.rollbar.com

You can call each channel directly as well by calling the class directly instead of the Log class.

For example...

\Debug\File::error("message",$value);

\Debug\FirePHP::error("message",$value);

Calling the channel directly still requires the channel to be present in the environmental channels variable (DEBUG_ERROR_CHANNELS, etc). This allows you to use one channel for development without the need to remove the calls when pushing to production. (e.g. Call FirePHP directly and know it will do nothing in production because that isn't an allowed channel in that environment)