Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@strg/logging-winston

strg-at981MIT3.0.1TypeScript support: included

pre defined and formated error log configuration for Winston 3

logging, winston, winston transport, winston format, strg logging, json logging, winston json, strg, kubernetes logging

readme

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