JLV

language NPM Github Docs Build Status Coverage Status dependencies Status

wrapper around json-log-viewer for easy usage

Adds following features to json-log-viewer:

  • copies .json-log-viewer from the current folder or argument to your HOME path
  • merge multiple files to see all at once in json-log-viewer
  • use a custom log transformer (for supporting log libraries with another output then winston like :evergreen_tree:pino)
  • use an existing log transformer from npm
  • opens json-log-viewer in a new terminal (I have not found another way to start a process and pass the input to json-log-viewer)

:books: Table of Contents

:package: Installation

install JLV as dev dependency

npm i jlv -g

if you use another log format then winston, you need to install a transformer.

json-log-viewer is not up to date on npm. You need to install the new version from the git with:

npm i gistia/json-log-viewer#master

:rocket: Usage

argument short description
--param <param> -p <param> json-log-viewer parameter
--files <glob> -f <glob> log files to view as glob
--config <path> -c <path> path to .json-log-viewer config file
--reset -r reset .json-log-viewer in HOME folder
--transformer <name> -t <name> load transformer from a npm module
--transformer-js <path> -tjs <path> load transformer from a javascript file
--open -o open json-log-viewer in a new shell
--save <path> -s <path> save merged log file to path
--backup <path> -b <path> backup .json-log-viewer to given path

Example

jlv -f ./example/**.log -o

:wrench: Transformers

List of supported transformers. Default is winston.

log library JLV transformer install with
:evergreen_tree:pino jlv-pino npm i jlv-pino -D

See Contributing if you would like to add your own transformers to the list. You can use jlv-pino as example.

:hammer_and_wrench: Support

Please open an issue for support.

:memo: Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

:scroll: License

MIT © Oliver Grüttner