# swn-logger

> Logging utility built over winston

Latest version **4.0.3** (published 2026-07-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install swn-logger
pnpm add swn-logger
yarn add swn-logger
bun add swn-logger
```

## Health

**Score 45/100 (D)** — status: active.

Positive: no vulnerabilities.

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

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2026-07-01 |
| First published | 2017-03-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Swaven |
| Maintainers | swaven |
| Keywords | winston, logging |

## Links

- npm: https://www.npmjs.com/package/swn-logger
- Repository: https://github.com/Swaven/swn-node-logger
- Homepage: https://github.com/Swaven/swn-node-logger#readme
- Issues: https://github.com/Swaven/swn-node-logger/issues
- npm.io page: https://npm.io/package/swn-logger

## Dependencies (6)

- [redis](https://npm.io/package/redis.md) ^5.10.0
- [verror](https://npm.io/package/verror.md) ^1.10.1
- [winston](https://npm.io/package/winston.md) ^3.19.0
- [winston-redis](https://npm.io/package/winston-redis.md) ^3.1.0
- [datadog-winston](https://npm.io/package/datadog-winston.md) ^1.6.0
- [@aws-sdk/client-secrets-manager](https://npm.io/package/@aws-sdk/client-secrets-manager.md) ^3.990.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

- 4.0.3 (latest) — 2026-07-01
- 4.0.2 — 2026-02-16
- 4.0.0 — 2023-05-31
- 3.1.0 — 2022-02-07
- 3.0.4 — 2022-02-07
- 3.0.3 — 2022-02-07
- 3.0.2 — 2022-02-04
- 3.0.1 — 2022-02-04
- 3.0.0 — 2022-02-04
- 2.0.1 — 2017-10-03
- 2.0.0 — 2017-09-28
- 1.0.0 — 2017-03-21

## README

# swaven-logger
Logging utility built over Winston

Provides a simple interface to log to stdout, file or redis.

## Usage

````
var mainLogger = require('swn-logger').create('my-project', config),
    logger2 = require('swn-logger').create('subsystem')

mainLogger.info('Error')
````

## API

### `create(system, [config])`

Instanciates a logger for the given system.

##### Parameters:

**system** `string`, mandatory. The name of the logger.

**config** `object`. Logger configuration. Only needed for the first logger created for the application.  
Properties:  
- `level`:
Possible values:`debug`, `info`, `warn`, `error`. Required level for events to be written. Events below this level are ignored. Defaults to `debug`.

- `targets`: Array of object. Defines log targets. Supported properties:  

  name | type | mandatory* | transport | description
  -|-|-|-|-
  type | string | ✓ | * | output destination: `stdout`, `file`, `redis`, `datadog`
  path | string| ✓ | file | path to file. folder must exist.
  host | string | ✓ | redis | redis host.
  port | string\|number | | redis | redis host port number. Can be ignored if `host` contains both, separated by colon `:`. 
  key | string | ✓ | redis | key used to store events.
  service | string | |  datadog | service name
  hostname | string || datadog | logger host name
  secret | string | ✓ | datadog | AWS secret id for datadog API key.

- `colors`: object. Define alternate colors for stdout output. Each key is a log level, value is the associated color.
- `quiet`: boolean. Set to false to output system registration message. Default: true.

(*) mandatory if using the relevant output target.

### `debug(msg, [data])`
### `warn(msg, [data])`
### `info(msg, [data])`

Logs an event with the appropriate level.

#### Parameters:

**msg** `string`. Event message

**data** `object`. Optional data, serialized and added to the event.

### `error(err, [data])`

Logs an error.

##### Parameters:

**err** `string`, `Error` or `VError`. Error to log. If is an instance of Error or VError, the stack trace is logged. See [VError](https://github.com/joyent/node-verror) for more details.

**data** `object`. Optional data, added to event if `msg` is a string.

### `ready`

Returns a promise that resolves when all transports are initialized. Logging before that means losing logging for transports that are not ready.


## Configuration example

````javascript
var config = {
  level: 'debug',
  targets: [
    {
      type: 'stdout'
    },
    {
      type: 'file',
      path: 'trace.log'
      },
    {
      type: 'redis',
      host: '127.0.0.1:6379',
      key: 'test'
    },
    {
      type: 'datadog',
      hostname: 'test-instance', 
      service: 'foo',
      secret: 'aws-secret-id'
    }
  ]
}

var logger = require('swn-logger').create('test1', config)

await logger.ready
````

# Notes

- Datadog apikey is retrieved asynchronously, and the transport is added async'ly too. Log messages before that will not be sent to datadog.
- the old redis dev dependency is necessary for winston-redis.

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