https://github.com/jitesoft/yolog-json-plugin

Json plugin for @jitesoft/yolog package.
https://github.com/jitesoft/yolog-json-plugin

hacktoberfest json logger nodejs plugin web yolog

Last synced: 5 days ago
JSON representation

Json plugin for @jitesoft/yolog package.

• Host: GitHub
• URL: https://github.com/jitesoft/yolog-json-plugin
• Owner: jitesoft
• License: mit
• Created: 2020-06-05T09:33:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-24T16:12:52.000Z (8 months ago)
• Last Synced: 2024-05-03T04:47:45.518Z (7 months ago)
• Topics: hacktoberfest, json, logger, nodejs, plugin, web, yolog
• Language: JavaScript
• Homepage:
• Size: 1.61 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yolog JSON Plugin

[![npm (scoped)](https://img.shields.io/npm/v/@jitesoft/yolog-json-plugin)](https://www.npmjs.com/package/@jitesoft/yolog-json-plugin)

[![Known Vulnerabilities](https://dev.snyk.io/test/npm/@jitesoft/yolog-json-plugin/badge.svg)](https://dev.snyk.io/test/npm/@jitesoft/yolog-json-plugin)

[![pipeline status](https://gitlab.com/jitesoft/open-source/javascript/yolog-plugins/json/badges/master/pipeline.svg)](https://gitlab.com/jitesoft/open-source/javascript/yolog-plugins/json/commits/master)

[![coverage report](https://gitlab.com/jitesoft/open-source/javascript/yolog-plugins/json/badges/master/coverage.svg)](https://gitlab.com/jitesoft/open-source/javascript/yolog-plugins/json/commits/master)

[![npm](https://img.shields.io/npm/dt/@jitesoft/yolog-json-plugin)](https://www.npmjs.com/package/@jitesoft/yolog-json-plugin)

[![Back project](https://img.shields.io/badge/Open%20Collective-Tip%20the%20devs!-blue.svg)](https://opencollective.com/jitesoft-open-source)

Plugin for the [`@jitesoft/yolog`](https://www.npmjs.com/package/@jitesoft/yolog) logger create logs in json format.  

When running in the browser, all the data will be printed to the console, while, when using the nodejs version

the data can either be pushed to a file or to the stdout/stderr of the application.

## Usage:

Install with your favorite package manager!

```bash

npm i @jitesoft/yolog-json-plugin --save

yarn add @jitesoft/yolog-json-plugin

```

Import and use just as with any other yolog plugin!

```js

import logger from '@jitesoft/yolog';

import JsonPlugin from '@jitesoft/yolog-json-plugin';

logger.addPlugin(new JsonPlugin('file.txt'));

```

To import it in a browser environment, the `src/browser` (or `/dist/browser` for precompiled) suffix have to be added:

```js

import logger from '@jitesoft/yolog';

import JsonPlugin from '@jitesoft/yolog-json-plugin/src/browser';

logger.addPlugin(new JsonPlugin()); // No file!

```

## Data format

Each line in the output is a single JS Object notation, that is, the full file is not an array of json objects, but each

line should be parsed as its own.  

Example: 

```json

{"tag": "emergency", "timestamp": 123123123, "message": "abc123!!", "error":  { "message": "error message!", "stack": [ "callstack here." ] }}

{"tag": "warning", "timestamp": 123123124, "message": "abc123"}

```

That means that when parsing the file (or output), each line should be parsed as its own object.