cartodb4/log4js-node
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #109 from Dignifiedquire/fix-1

Browse Source 
Misc code highlighting fixes in readme.md
This commit is contained in:
Gareth Jones 2013-01-20 14:16:04 -08:00
commit 6da6f3c90e
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -21,10 +21,10 @@ NOTE: from log4js 0.5 onwards you'll need to explicitly enable replacement of no
```javascript ```javascript
{ {
appenders: [ appenders: [
{ type: "console" } { type: "console" }
], ],
replaceConsole: true replaceConsole: true
} }
``` ```
@ -42,9 +42,9 @@ var logger = log4js.getLogger();
logger.debug("Some debug messages"); logger.debug("Some debug messages");
``` ```
By default, log4js outputs to stdout with the coloured layout (thanks to [masylum](http://github.com/masylum)), so for the above you would see: By default, log4js outputs to stdout with the coloured layout (thanks to [masylum](http://github.com/masylum)), so for the above you would see:
```bash
[2010-01-17 11:43:37.987] [DEBUG] [default] - Some debug messages [2010-01-17 11:43:37.987] [DEBUG] [default] - Some debug messages
```
See example.js for a full example, but here's a snippet (also in fromreadme.js): See example.js for a full example, but here's a snippet (also in fromreadme.js):
```javascript ```javascript
var log4js = require('log4js'); var log4js = require('log4js');
@ -53,7 +53,7 @@ var log4js = require('log4js');
log4js.loadAppender('file'); log4js.loadAppender('file');
//log4js.addAppender(log4js.appenders.console()); //log4js.addAppender(log4js.appenders.console());
log4js.addAppender(log4js.appenders.file('logs/cheese.log'), 'cheese'); log4js.addAppender(log4js.appenders.file('logs/cheese.log'), 'cheese');
```javascript
var logger = log4js.getLogger('cheese'); var logger = log4js.getLogger('cheese');
logger.setLevel('ERROR'); logger.setLevel('ERROR');
@ -65,18 +65,18 @@ logger.error('Cheese is too ripe!');
logger.fatal('Cheese was breeding ground for listeria.'); logger.fatal('Cheese was breeding ground for listeria.');
``` ```
Output: Output:
```bash
[2010-01-17 11:43:37.987] [ERROR] cheese - Cheese is too ripe! [2010-01-17 11:43:37.987] [ERROR] cheese - Cheese is too ripe!
[2010-01-17 11:43:37.990] [FATAL] cheese - Cheese was breeding ground for listeria. [2010-01-17 11:43:37.990] [FATAL] cheese - Cheese was breeding ground for listeria.
```
The first 5 lines of the code above could also be written as: The first 5 lines of the code above could also be written as:
```javascript ```javascript
var log4js = require('log4js'); var log4js = require('log4js');
log4js.configure({ log4js.configure({
appenders: [ appenders: [
{ type: 'console' }, { type: 'console' },
{ type: 'file', filename: 'logs/cheese.log', category: 'cheese' } { type: 'file', filename: 'logs/cheese.log', category: 'cheese' }
] ]
}); });
``` ```
@ -106,28 +106,28 @@ For FileAppender you can also pass the path to the log directory as an option wh
log4js.configure('my_log4js_configuration.json', { cwd: '/absolute/path/to/log/dir' }); log4js.configure('my_log4js_configuration.json', { cwd: '/absolute/path/to/log/dir' });
``` ```
If you have already defined an absolute path for one of the FileAppenders in the configuration file, you could add a "absolute": true to the particular FileAppender to override the cwd option passed. Here is an example configuration file: If you have already defined an absolute path for one of the FileAppenders in the configuration file, you could add a "absolute": true to the particular FileAppender to override the cwd option passed. Here is an example configuration file:
```json
#### my_log4js_configuration.json #### #### my_log4js_configuration.json ####
{
"appenders": [
{ {
"appenders": [ "type": "file",
{ "filename": "relative/path/to/log_file.log",
"type": "file", "maxLogSize": 20480,
"filename": "relative/path/to/log_file.log", "backups": 3,
"maxLogSize": 20480, "category": "relative-logger"
"backups": 3, },
"category": "relative-logger" {
}, "type": "file",
{ "absolute": true,
"type": "file", "filename": "/absolute/path/to/log_file.log",
"absolute": true, "maxLogSize": 20480,
"filename": "/absolute/path/to/log_file.log", "backups": 10,
"maxLogSize": 20480, "category": "absolute-logger"
"backups": 10,
"category": "absolute-logger"
}
]
} }
]
}
```
Documentation for most of the core appenders can be found on the [wiki](log4js-node/wiki/Appenders), otherwise take a look at the tests and the examples. Documentation for most of the core appenders can be found on the [wiki](log4js-node/wiki/Appenders), otherwise take a look at the tests and the examples.
## Documentation ## Documentation