lambda-monitor-logger/README.md

Logging designed to be used with lambda-monitor

# lambda-monitor-logger

[![Build Status](https://circleci.com/gh/blackflux/lambda-monitor-logger.png?style=shield)](https://circleci.com/gh/blackflux/lambda-monitor-logger)
[![Test Coverage](https://img.shields.io/coveralls/blackflux/lambda-monitor-logger/master.svg)](https://coveralls.io/github/blackflux/lambda-monitor-logger?branch=master)
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=blackflux/lambda-monitor-logger)](https://dependabot.com)
[![Dependencies](https://david-dm.org/blackflux/lambda-monitor-logger/status.svg)](https://david-dm.org/blackflux/lambda-monitor-logger)
[![NPM](https://img.shields.io/npm/v/lambda-monitor-logger.svg)](https://www.npmjs.com/package/lambda-monitor-logger)
[![Downloads](https://img.shields.io/npm/dt/lambda-monitor-logger.svg)](https://www.npmjs.com/package/lambda-monitor-logger)
[![Semantic-Release](https://github.com/blackflux/js-gardener/blob/master/assets/icons/semver.svg)](https://github.com/semantic-release/semantic-release)
[![Gardener](https://github.com/blackflux/js-gardener/blob/master/assets/badge.svg)](https://github.com/blackflux/js-gardener)

Logging designed to be used with lambda-monitor

## Install

Install with [npm](https://www.npmjs.com/):

    $ npm install --save lambda-monitor-logger

## Usage

<!-- eslint-disable-next-line import/no-unresolved, import/no-extraneous-dependencies -->
```js
import { logger, abbrev } from 'lambda-monitor-logger';

logger.error('Keyboard not found. Press F1 to Resume');
// => ERROR: Keyboard not found. Press F1 to Resume

logger.error(abbrev('some really long text'));
// => ERROR: some ... test
```

This logger will simply log to console and prefix with the debug level.

The available levels are: `debug`, `info`, `warning`, `error`, `critical`.

Synonyms like `warn` are available and the mapping can be found in the source code.

## Log Level

The log level can be set through the environment variable `LOG_LEVEL` (defaults to `DEBUG`).

Log messages below the currently set log level are completely ignored.


## Abbrev Options

### stripLineBreaks

Type: `boolean`<br>
Default: `true`

When set to true, line breaks are stripped.

### maxLength

Type: `integer`<br>
Default: `512`

The maximum output length.

### replace

Type: `Array`<br>
Default: `[]`

Input needs to be of format `[[<STRING|REGEX>, <STRING|FUNCTION>], ...]`

Allow custom replacement rules