nerds-and-company / loghelper
Log Helper Plugin for Craft CMS
Installs: 12 329
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 4
Forks: 2
Open Issues: 1
Type:craft-plugin
Requires
- composer/installers: ~1.0
This package is not auto-updated.
Last update: 2024-10-26 19:00:02 UTC
README
Introduction
When logging events and errors,
Craft CMS writes to the craft/storage/runtime/logs/craft.log.
and
craft/storage/runtime/logs/phperrors.log
files.
This can cause problems on hosting environments that have an ephemeral filesystem (like Heroku, Amazon EC2 and some Docker configurations) as the log files will not be persisted and logging data will get lost.
This plugin adds the ability to Craft CMS to redirect logging output to other sources than the default log files.
Installation
This plugin can be installed manually or using Composer.
Composer
The preferred means of installation is through Composer:
composer require nerds-and-company/loghelper
This will add nerds-and-company/loghelper
as a requirement to your
projects composer.json
file and install the plugin into the
craft/plugins/loghelper
directory.
Manual
If installation through Composer is not an option, the package can also
be installed manually. Download the latest release
or clone the contents of this repository into the craft/plugins/loghelper
directory.
Important:
The plugin's folder must be named "loghelper"
Usage
This plugin offers different types of behaviour that can be configured
by editing/adding the craft/config/logHelper.php
config file.
Configuration
The following settings are available:
useFileLog
Determines whether logs should be written to file or not. This allows for disabling Craft's default behaviour.
'useFileLog' => true,
useProfileLog
Determines whether or not to displays profiling results in the browser's console window. This allows for disabling Craft's default behaviour.
'useProfileLog' => true,
useStdErrLog
Determines whether logs should be written to STDERR (shell error output stream) or not. Enabling this allows for viewing Craft logs on Heroku (or in tools that persist Heroku logs, like Papertrail).
'useStdErrLog' => false,
useSysLog
Determines whether logs should be written to the system logs or not. Enabling this allows tools that read from the system logs (like Papertrail when not on Heroku) to persist Craft logs.
'useSysLog' => false,
useWebLog
Determines whether or not to displays log content in the browser's console window. This allows for disabling Craft's default behaviour.
'useWebLog' => true,
Screenshots
Docker
Heroku
Papertrail
License
This plugin has been licensed under the MIT License (MIT). Please see License File for more information.
Changelog
2.0.3
- Better log processing
2.0.2
- Fixed bug with reading default config values
2.0.1
- Adds more documentation
2.0.0
- Adds support for syslog logging, which is the default for Papertrail (non-Heroku)
- Adds the ability to remove web, file and profile logging
- Improves readability of the logs by appending newlines
1.0.0
- Initial release