Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/firegento/firegento-logger

Framework for different logging adapters for Magento 1.
https://github.com/firegento/firegento-logger

Last synced: about 17 hours ago
JSON representation

Framework for different logging adapters for Magento 1.

Awesome Lists containing this project

README

        

# Magento Module for advanced logging

[![All Contributors](https://img.shields.io/badge/all_contributors-26-orange.svg?style=flat-square)](#contributors-)

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**](#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](https://github.com/ProxiBlue/NewRelic#compatibility-with-firegento-logger).

Installation Instructions
-------------------------

### Via modman

- Install [modman](https://github.com/colinmollenhour/modman)
- Use the command from your Magento installation folder: `modman clone https://github.com/firegento/firegento-logger`

### Via composer
- Install [composer](http://getcomposer.org/download/)
- Install [Magento Composer](https://github.com/magento-hackathon/magento-composer-installer)
- Create a composer.json into your project like the following sample:

```json
{
...
"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](https://allcontributors.org/docs/en/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](https://github.com/all-contributors/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)](http://opensource.org/licenses/gpl-3.0)