# log


[![pipeline status](https://it-devops-01.br-edv.brnet.int/general/log/badges/master/pipeline.svg)](https://it-devops-01.br-edv.brnet.int/general/log/commits/master)
[![coverage report](https://it-devops-01.br-edv.brnet.int/general/log/badges/master/coverage.svg)](https://it-devops-01.br-edv.brnet.int/general/log/commits/master)
[![Quality Gate Status](https://it-devops-01.br-edv.brnet.int:8999/api/project_badges/measure?project=argos-log&metric=alert_status)](https://it-devops-01.br-edv.brnet.int:8999/dashboard?id=argos-log)

A real simple logger application.
May Optional Log to A File and a graylog-server.

## Installation

- `npm config set @br:registry https://it-devops-01:4873`
- `npm install --save @br/config`

## Usage

`const Log = require('@br/log')`  
`let log = new Log(options)`

Note: The options Part may be omitted, as all parts are optional, but using the name is recommended, as without it, the package-name will be used

### Methods

* `log.info('This is an Information' )`
* `log.notice('This is a Notice' )`
* `log.warn('This is a Warning' )`
* `log.error('This is an Error' )`
* `log.fatal('This is a Fatal Message' )`
* `log.debug('This is a Debug Message' )`

### Options

```json
{
  name: 'Name of App. Default: Name of BaseFolder',
  hostname: 'Server Hostname, Default: os.hostname()',
  file: 'File to Append Log to',
  graylog: {
    active: 'true or false',
    servers: [  
      {
        server: 'graylog-server',
        port: 'graylog-port'
      }
    ]
  },
  path: 'Path Logfile located',
  loglevel: 'Minimal LogLevel. Default: WARN'
}
```