Please Note: This should NOT be left enabled on a live site. It will slow down the front end of the site considerably and fill up your database and, depending on configuration, file system very quickly.
We are pleased to announce the addition of an in-admin logging facility for our Magento extensions. We have decided to add this to enable our customers to:
We very much see the logger as an integral part of our extensions going forwards, so watch this space as we enhance it.
The logger gives you the following capabilities:
Additionally we have added the following functionality:
The Logger is configured under System->Webshopapps Logger.
If you get an Access Denied erorr when accessing this page please log out of Magento admin then back in. This is a known Magento'ism!
By default logging is disabled.
When you put your extension in production please clear out all logs (in admin and file system) and disable WebShopApps Logging.
Before you configure logging please consider how you wish to use it. Answer the following:
The sections below will help you answer each of these questions.
Once you have changed your configuration then you will need to re-exercise the WebShopApps extension code on the frontend in order to get logs to appear. For shipping extensions this means by getting a shipping quote in cart or checkout.
In most cases you will know what extension you wish to enable logging for. If you have multiple WebShopApps extensions you may only want to enable for 1 of them, so that the logs dont get too 'busy'.
You configure the extensions under System->Configuration->WebShopApps Logger.
In the configuration you can select where to output logs to, and at
For most customers logging to the admin panel will suffice. Logs will by shown under System->WebShopApps View Log.
An example output will be a grid of logs. Depending on the log level set you will see more/less logs. If you do not see logs please firstly refresh the page, then check you have exercised the relevant extension and have configuration setup correctly for the Logger.
You have the ability to filter, sort, and display extra information on each row in the log.
We highly recommend if you are testing that before you run a test you select all logs and then click 'Destroy all logs' to remove them. This will ensure the logs make most sense, as they will then only relate to last test.
We also support output direct to the file system under /var/log/system.log. You will need to have developer logging enabled to use this facility. This is recommended only for advanced users.
We recommend you only send critical logs via the email system to avoid performance issues. One example use is being informed when shipping rates cannot be found. This will allow you to analyse where you have gaps in your shipping logic, and/or abandoned carts.
When setting up logging via email you must fill in the Logger email address, sender email, email name and email subject.
There are 4 levels of logging you can choose, choosing one will include all levels above it, i.e. if you choose debug then info, warning, critical will also be captured.
When running in production we recommend that all logging is switched off for performance reasons.