dbc-node-logger/README.md

DBC logger module made for use in projects based on nodejs and JavaScript at DBC

# dbc-node-logger

[![Build Status](https://travis-ci.org/DBCDK/dbc-node-logger.svg?branch=master)](https://travis-ci.org/DBCDK/dbc-node-logger)

__Please beware that this is version 2+ which is completely incompatible with version 1.x which has been branched to the [version-1.x branch](https://github.com/DBCDK/dbc-node-logger/tree/version-1.x)__   

Logger module intendted to be used within the DBC A/S organisation but is free for anyone to use.

## Example
Implementatin exmaple:
See implementation in https://github.com/DBCDK/dbc-ufo for an example of usage.

```javascript
import {log} from 'dbc-node-logger';

log.log('info', 'hello world', {additional: 'data'});

// OR

log.info('hello world', {additional: 'data'});
log.error('hello world', {additional: 'data'});
// ETC...
```

## Environment Varibles
The following environment variables are defined in this module.

- __LOG_LEVEL__ - defaults to 'INFO'   
Defines the severity level spanning from `OFF` (0) to `TRACE` (5). The following levels are available:
`OFF`, `ERROR`, `WARN` (or `WARNING`), `INFO`, `DEBUG` and `TRACE` 

- __PRETTY_LOG__ - defaults to `0`  
If set to `1` (`PRETTY_LOG=1`) the log statements will be formatted with indentation and linebreaks for easier reading. Otherwise each statement will kept as on a single line.  

## Usage
### Methods & Parameters

The main log method is `log()`. The `info()`, `debug()`, `notice()`, `warning()` and `error()` methods are just convenience methods that abstracts the `level` parameter away.
The `getExpressLoggers()` delivers an object with express-specific loggers. 

#### Parameters 
In general if the `level` or `message` parameter is undefined an `Error` will be thrown.
The `data` parameter is optional and will only be logged if not undefined.

#### Methods  
`import {log} from 'dbc-node-logger';`  
`log.log(level, message, data = {})`  
__level: string__ - The severity of the log message  
__message: string__ - The log message  
__data: *__ - An object containing additional data that might be convenient to log with the message

`log.error(message, data = {})`  
See `log()` method

`log.warn(message, data = {})`  
See `log()` method

`log.warn(message, data = {})`  
Same as above `warn` method

`log.info(message, data = {})`  
See `log()` method

`log.debug(message, data = {})`  
See `log()` method

`log.notice(message, data = {})`  
See `log()` method