# winston-meta-wrapper

> Wraps Winston logger to always add a set of metadata

Latest version **1.2.0** (published 2016-09-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install winston-meta-wrapper
pnpm add winston-meta-wrapper
yarn add winston-meta-wrapper
bun add winston-meta-wrapper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2016-09-11 |
| First published | 2016-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+10 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Thomas Delaet |
| Maintainers | tdelaet |
| Keywords | winston, metadata, wrapper |

## Links

- npm: https://www.npmjs.com/package/winston-meta-wrapper
- Repository: https://github.com/MicroMinion/winston-meta-wrapper
- Homepage: https://github.com/MicroMinion/winston-meta-wrapper#readme
- Issues: https://github.com/MicroMinion/winston-meta-wrapper/issues
- npm.io page: https://npm.io/package/winston-meta-wrapper

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) 4.15.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2016-09-11
- 1.1.0 — 2016-08-10
- 1.0.0 — 2016-07-16
- 0.0.1 — 2016-07-16

## README

# winston-meta-wrapper
Wraps winston logger instance to always add a set of metadata

This wrapper around winston loggers allows you to log a static or dynamic set of metadata with each log statement being executed without explicitely adding it as meta argument.

It also fixes the [JSON string interpolation issue in winston](https://github.com/winstonjs/winston/issues/745)

## Installation

```js
npm install winston-meta-wrapper
```

## Usage

### Wrapping Winston Logger to add static metadata

```js
var winston = require('winston')
var winstonWrapper = require('winston-meta-wrapper')

var logger = new winston.Logger({
  transports: [
    new winston.transports.Console()
  ]
})

logger = winstonWrapper(logger)

logger.addMeta({
  test: 'Test Meta'
})

logger.info('test message')
```

### Wrapping Winston Logger to add dynamic metadata

```js
var winston = require('winston')
var winstonWrapper = require('winston-meta-wrapper')

var logger = new winston.Logger({
  transports: [
    new winston.transports.Console()
  ]
})

logger = winstonWrapper(logger)

logger.getMeta = function () {
  return {
    module: Math.random()
  }
}

logger.info('test message')
logger.info('test message')
```

### Chaining wrapped Winston Loggers

```js
var winston = require('winston')
var winstonWrapper = require('winston-meta-wrapper')

var logger = new winston.Logger({
  transports: [
    new winston.transports.Console()
  ]
})

logger = winstonWrapper(logger)

logger.addMeta({
  test: 'Test Meta'
})

logger = winstonWrapper(logger)

logger.addMeta({
  test2: 'Test 2 Meta'
})

logger.info('test message')
```

---
_Source: https://npm.io/package/winston-meta-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._