README.md

Magento Module for advanced logging

The purpose of this project is to have a simple framework for different logging adapters.

Originally developed as Hackathon_Logger but moved forewards and will now actively supported by firegento community.

See the Usage Chapter below to see how to use it.

Please be aware of the following restrictions:

• The ProxiBlue NewRelic extension uses the same logic to log to NewRelic and will block FireGento Logger extension unless you revise its config.xml file.

Installation Instructions

Via modman

• Install modman
• Use the command from your Magento installation folder: modman clone https://github.com/firegento/firegento-logger

Via composer

• Install composer
• Install Magento Composer
• Create a composer.json into your project like the following sample:

{
    ...
    "require": {
        "firegento/logger":"*"
    },
    "repositories": [
	    {
            "type": "composer",
            "url": "http://packages.firegento.com"
        }
    ],
    "extra":{
        "magento-root-dir": "./"
    }
}

• Then from your composer.json folder: php composer.phar install or composer install

Manually

• You can copy the files from the folders of this repository to the same folders of your installation

Installation in ALL CASES

• Clear the cache, logout from the admin panel and then login again.

Uninstallation

• Remove all extension files from your Magento installation

Usage

Configure the different loggers in System > Configuration > Advanced > Firegento Logger

Further Information

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Colin Mollenhour 💻	Damian Luszczymak 💻	Rouven Alexander Rieker 💻	Paul Hachmang 💻	Diego 💻	Achim Rosenhagen 💻	Fabian Blechschmidt 💻
Freek Gruntjes 💻	Wilfried Wolf 💻	tkdb 💻	Sylvain Rayé 💻	Matthias Büsing 💻	Dane Lowe 💻	Lee Saferite 💻
Jeroen 💻	Steve Robbins 💻	Sergey Kalenyuk 💻	Nils Preuß 💻	Matthias Zeis 💻	Jeroen Vermeulen 💻	Ingo Fabbri 💻
Colin O'Dell 💻	Andreas 💻	Aad Mathijssen 💻	Lucas van Staden 💻	Kevin Krieger 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Current Status of Project

Complete, working logger interfaces:

• File (Magento default)
• File (Advanced Format)
• File (JSON)
• E-Mail
• Database
• XMPP (Jabber, Google Talk)
• Graylog2
• Loggly (UDP/HTTPS)
• Syslog
• RSyslog (UDP)
• Papertrail (UDP)
• Chromelogger
• Logstash
• Redis
• Sentry
• Airbrake

It is possible to use Multiple-Targets!

Other Features

• Log Live View (Like a tail in terminal)
• Report View (Shows content of a report in backend)
• Manage modules log output (enable/disable log messages of extensions)

Further work

External libraries

For XMPP we use https://github.com/cweiske/xmpphp. For ChromeLogger we use https://github.com/ccampbell/chromephp

How to contribute

Make a fork, commit to develop branch and make a pull request

Some Hints

• There are combinations that don't work together
  • You can't use Chromelogger with the embeded queueing model, because the queueing takes place after the response is send to the client ** You can't use Papertrail with the embeded queueing model

Licence

GNU General Public License, version 3 (GPLv3)