https://github.com/pustovitdmytro/winston-csv-format
writes winston logs in csv format
https://github.com/pustovitdmytro/winston-csv-format
csv logger npm winston
Last synced: 5 months ago
JSON representation
writes winston logs in csv format
- Host: GitHub
- URL: https://github.com/pustovitdmytro/winston-csv-format
- Owner: pustovitDmytro
- License: mit
- Created: 2019-08-06T13:29:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-10-22T01:48:54.000Z (5 months ago)
- Last Synced: 2025-10-22T03:32:29.838Z (5 months ago)
- Topics: csv, logger, npm, winston
- Language: JavaScript
- Homepage:
- Size: 3.22 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# winston-csv-format
writes [winston][w-main] logs in [csv][csv] format.
[![Version][badge-vers]][npm]
[![Bundle size][npm-size-badge]][npm-size-url]
[![Downloads][npm-downloads-badge]][npm]
[![CodeFactor][codefactor-badge]][codefactor-url]
[![SonarCloud][sonarcloud-badge]][sonarcloud-url]
[![Codacy][codacy-badge]][codacy-url]
[![Total alerts][lgtm-alerts-badge]][lgtm-alerts-url]
[![Language grade][lgtm-lg-badge]][lgtm-lg-url]
[![Scrutinizer][scrutinizer-badge]][scrutinizer-url]
[![Dependencies][badge-deps]][npm]
[![Security][snyk-badge]][snyk-url]
[![Build Status][tests-badge]][tests-url]
[![Coverage Status][badge-coverage]][url-coverage]
[![Commit activity][commit-activity-badge]][github]
[![FOSSA][fossa-badge]][fossa-url]
[![License][badge-lic]][github]
# 🇺🇦 Help Ukraine
I woke up on my 26th birthday at 5 am from the blows of russian missiles. They attacked the city of Kyiv, where I live, as well as the cities in which my family and friends live. Now my country is a war zone.
We fight for democratic values, for freedom, for our future!
I am stopping any support of my packages by the time until all russians leave my country on trucks or in boxes.
💛💙 Help Ukraine! We need your support! There are dozen ways to help us, just do it!
## Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Contribute](#contribute)
## Motivation
If you're struggling to format your logs/reports as [.csv][csv] files (or prepare import to Excel or Google Spreadsheet), this package can be a cure. Now you can use all power of [winston][w-main] logger, formating your data as comma-separated values.
## Requirements
[![Platform Status][node-ver-test-badge]][node-ver-test-url]
To use library you need to have [node](https://nodejs.org) and [npm](https://www.npmjs.com) installed in your machine:
* node `>=10`
* npm `>=6`
Package is [continuously tested][node-ver-test-url] on darwin, linux and win32 platforms. All active and maintenance [LTS](https://nodejs.org/en/about/releases/) node releases are supported.
## Installation
To install the library run the following command
```bash
npm i --save winston-csv-format
```
## Usage
The package can be used as the formatter alongside any [winston transport][w-transports]. 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:
```javascript
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)
[w-main]: https://github.com/winstonjs/winston
[w-transports]: https://github.com/winstonjs/winston/blob/master/docs/transports.md
[csv]: https://en.wikipedia.org/wiki/Comma-separated_values
## Migration Guide
Check [Migration Guide](./MIGRATION.md) to upgrade the next major version. Upgrade to minor/patch versions should happen without additional interventions. See detailed [Changelog](./CHANGELOG.md) for a list of changes.
## Contribute
Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read [Contributing Guidelines](.github/CONTRIBUTING.md) for details.
[npm]: https://www.npmjs.com/package/winston-csv-format
[github]: https://github.com/pustovitDmytro/winston-csv-format
[coveralls]: https://coveralls.io/github/pustovitDmytro/winston-csv-format?branch=master
[badge-deps]: https://img.shields.io/librariesio/release/npm/winston-csv-format.svg
[badge-vuln]: https://img.shields.io/snyk/vulnerabilities/npm/winston-csv-format.svg?style=popout
[badge-vers]: https://img.shields.io/npm/v/winston-csv-format.svg
[badge-lic]: https://img.shields.io/github/license/pustovitDmytro/winston-csv-format.svg
[badge-coverage]: https://coveralls.io/repos/github/pustovitDmytro/winston-csv-format/badge.svg?branch=master
[url-coverage]: https://coveralls.io/github/pustovitDmytro/winston-csv-format?branch=master
[snyk-badge]: https://snyk-widget.herokuapp.com/badge/npm/winston-csv-format/badge.svg
[snyk-url]: https://snyk.io/advisor/npm-package/winston-csv-format
[tests-badge]: https://img.shields.io/circleci/build/github/pustovitDmytro/winston-csv-format
[tests-url]: https://app.circleci.com/pipelines/github/pustovitDmytro/winston-csv-format
[codefactor-badge]: https://www.codefactor.io/repository/github/pustovitdmytro/winston-csv-format/badge
[codefactor-url]: https://www.codefactor.io/repository/github/pustovitdmytro/winston-csv-format
[commit-activity-badge]: https://img.shields.io/github/commit-activity/m/pustovitDmytro/winston-csv-format
[scrutinizer-badge]: https://scrutinizer-ci.com/g/pustovitDmytro/winston-csv-format/badges/quality-score.png?b=master
[scrutinizer-url]: https://scrutinizer-ci.com/g/pustovitDmytro/winston-csv-format/?branch=master
[lgtm-lg-badge]: https://img.shields.io/lgtm/grade/javascript/g/pustovitDmytro/winston-csv-format.svg?logo=lgtm&logoWidth=18
[lgtm-lg-url]: https://lgtm.com/projects/g/pustovitDmytro/winston-csv-format/context:javascript
[lgtm-alerts-badge]: https://img.shields.io/lgtm/alerts/g/pustovitDmytro/winston-csv-format.svg?logo=lgtm&logoWidth=18
[lgtm-alerts-url]: https://lgtm.com/projects/g/pustovitDmytro/winston-csv-format/alerts/
[codacy-badge]: https://app.codacy.com/project/badge/Grade/52f29d5fc1a447349a4ee5ce75857322
[codacy-url]: https://www.codacy.com/gh/pustovitDmytro/winston-csv-format/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pustovitDmytro/winston-csv-format&utm_campaign=Badge_Grade
[sonarcloud-badge]: https://sonarcloud.io/api/project_badges/measure?project=pustovitDmytro_winston-csv-format&metric=alert_status
[sonarcloud-url]: https://sonarcloud.io/dashboard?id=pustovitDmytro_winston-csv-format
[npm-downloads-badge]: https://img.shields.io/npm/dw/winston-csv-format
[npm-size-badge]: https://img.shields.io/bundlephobia/min/winston-csv-format
[npm-size-url]: https://bundlephobia.com/result?p=winston-csv-format
[node-ver-test-badge]: https://github.com/pustovitDmytro/winston-csv-format/actions/workflows/npt.yml/badge.svg?branch=master
[node-ver-test-url]: https://github.com/pustovitDmytro/winston-csv-format/actions?query=workflow%3A%22Node.js+versions%22
[fossa-badge]: https://app.fossa.com/api/projects/custom%2B24828%2Fwinston-csv-format.svg?type=shield
[fossa-url]: https://app.fossa.com/projects/custom%2B24828%2Fwinston-csv-format?ref=badge_shield