log4js-server-chan/README.md

log4js server chan appender

# log4js-server-chan

This is the 3-party appender module to work with [log4js](https://github.com/nomiddlename/log4js-node) framework. It is based on [server chan](http://sc.ftqq.com/3.version) web service, push configurable log message to wechat.

## installation

npm install log4js-server-chan

## usage

See examples/ for full example, here's a snippet.
```javascript
const log4js = require('log4js');
const serverChanAppender = require('../');

log4js.loadAppender('console');
log4js.loadAppender('serverChan', serverChanAppender);

// log4js.addAppender(log4js.appenders.console());
log4js.addAppender(log4js.appenders.serverChan({sckey: process.env.SCKEY, text: 'TEST'}), 'sc');

let logger = log4js.getLogger('sc');
logger.setLevel('ERROR');

logger.trace('Entering serverchan testing');
logger.info('log info');
logger.warn('log warn');
logger.error('log error');
logger.fatal('log fatal');
```
To run the example:
```bash
export SCKEY=YOUR SCKEY STRING
node ./examples/load-appender
```
Two error messages will be sent to your wechat.(Also output in console):
```bash
[2016-11-01 11:13:36.495] [ERROR] sc - log error
[2016-11-01 11:13:36.509] [FATAL] sc - log fatal
```
The example code above could also be written as configure mode:
```javascript
log4js.configure({
  appenders: [
    {type: 'console', category: 'console'},
    {
      type: 'log4js-server-chan',
      sckey: '#sckey',
      text: '#title',
      category: 'serverchan'
    }
  ]
});
```