winston-csv-format

writes winston logs in csv format.

Table of Contents

• Requirements
• Installation
• Usage
• Contribute

Motivation

If you're struggling to format your logs/reports as .csv files (or prepare import to Excel or Google Spreadsheet), this package can be a cure. Now you can use all power of winston logger, formating your data as comma-separated values.

Requirements

To use library you need to have node and npm installed in your machine:

• node 6.0+
• npm 3.0+

Installation

To install the library run the following command

  npm i --save winston-csv-format

Usage

The package can be used as the formatter alongside any winston transport. Default export is a constructor function. It has 2 arguments: an array of fields and an options object. Note that fields must match keys of logged objects:

import CSV from 'winston-csv-format';
import { createLogger, transports } from 'winston';

const csvHeaders = {
    created    : 'Creation Date',
    size       : 'Size',
    status     : 'Status',
};

const logger = createLogger({
    level      : 'info',
    format     : CSV(['created', 'status' ], { delimiter: ',' }),
    transports : [ new transports.Console() ]
});

logger.log('info', csvHeaders); // write headers

Configuration

Next values can be configured as options:

• delimiter - delimiter between fields (';' by default)
• missed - value, used when original value is missed in the logged object (empty string by default)

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions.

Commit message summaries must follow this basic format:

  Tag: Message (fixes #1234)

The Tag is one of the following:

• Fix - for a bug fix.
• Update - for a backwards-compatible enhancement.
• Breaking - for a backwards-incompatible enhancement.
• Docs - changes to documentation only.
• Build - changes to build process only.
• New - implemented a new feature.
• Upgrade - for a dependency upgrade.
• Chore - for tests, refactor, style, etc.

The message summary should be a one-sentence description of the change. The issue number should be mentioned at the end.