Skip to content

strg-at/logging-winston

Repository files navigation

Version npm Renovate Status License

@strg/logging-winston

This library provides a preconfigured winston logger that can be used in any typescript or node project it is based on winston3.

Getting Started

Prerequisites



Installing the library

npm install winston @strg/logging-winston

Using the client library

import {logger} from '@strg/logging-winston'

logger.info(`${'hello world'}`)

Error "cause"

For all errors with a parent "cause", messages and stacktrace will be displayed hierarchically.

const error = new Error('Child Error', { cause: new Error('Parent Error')})
logger.error(error) // will display stacktrace and original message for child and parent errors

ENV

Description Default
NODE_LOG_FORMAT SIMPLE, JSON JSON
NODE_LOG_LEVEL fatal, error, warn, info, trace, debug info
NODE_LOG_STACK_KEY the key of the stacktrace (require NODE_LOG_FORMAT=JSON) stack_trace


Specification

This library aims to standarize the logging output in all node or typescript based applications.

Development

Testing

#TBD

Coverage Report

#TBD

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

About

Preconfigured winston3 based logger for node and typescript by STRG.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 8