Parse your log in JSON formatter
[](https://codecov.io/gh/ODGodinho/ODG-JSONLog) [](https://github.com/ODGodinho/ODG-JSONLog/stargazers) [](https://www.linkedin.com/in/victor-alves-odgodinho/) [](https://github.com/ODGodinho/ODG-JSONLog/network/members)  [](https://github.com/ODGodinho/ODG-JSONLog/commits/master) [](https://opensource.org/licenses/MIT) [](https://github.styleci.io/repos/562306382?branch=main)
# Table of Contents - [🎇 Benefits](#-benefits) - [📗 Libraries](#-libraries) - [📁 Dependencies](#-dependencies) - [⏩ Get Started](#-get-started) - [🔘 Use Plugin](#-use-plugin) - [🎲 Implementation](#-implementation) - [💌 SendLog](#-send-log) - [💻 Prepare to develop](#-prepare-to-develop) - [📍 Start Project](#-start-project) - [📨 Build and Run](#-build-and-run) - [🧪 Teste Code](#-teste-code) --- ## 🎇 Benefits - 🚀 Speed start new project or package using typescript - 🚨 Over 800 rules for pattern, possible errors and errors in Linter - 🎇 Log Pattern default format ## 📗 Libraries - [Node.js 16](https://nodejs.org/?n=dragonsgamers) - [Typescript](https://www.typescriptlang.org/?n=dragonsgamers) - [Eslint](https://eslint.org/?n=dragonsgamers) - [ODG-Linter-JS](https://github.com/ODGodinho/ODG-Linter-Js?n=dragonsgamers) - [EditorConfig](https://editorconfig.org/?n=dragonsgamers) - [ReviewDog](https://github.com/reviewdog/action-eslint) ## 📁 Dependencies - [Node.js](https://nodejs.org) 16 or later - [Yarn](https://yarnpkg.com/) Optional/Recommended - [ODG TsConfig](https://github.com/ODGodinho/tsconfig) Last Version - [error-stack-parser](https://www.npmjs.com/package/error-stack-parser) Last Version ## ⏩ Get Started --- ### 🔘 Use Plugin install this plugin with ```powershell yarn add @odg/json-log ``` ### 🎲 Implementation ```typescript const logger = new Logger(); // Or Other Class Logger const consoleLogger = new ConsoleLogger(); // Or Other Class Logger const processor = new JSONLoggerPlugin( "appName", ); logger.pushHandler(consoleLogger); logger.pushProcessor(processor); // If you need convert Request and response request headers body, params in string before log logger.pushProcessor(RequestStringPlugin); plugin.setIdentifier(randomUUID()); ``` #### 💌 Send Log ```typescript try { throw new Exception("Example"); } catch (error) { await logger.error(error); } ``` LOG JSON Return ```jsonc { "type": "error", "index": "appName", "instance": "ContainerID", "identifier": "00000000-0000-0000-0000-00000", // use setIdentifier in plugin to change log group "gitRelease": "v1.0.0", "gitBranch": "main", "exception": { "type": "string", // ExceptionClassName "message": "string", // Example "fileException": "string", // index.js "functionName": null, // OPTIONAL: "fileLine": "number", // 1 "fileColumn": "number", // 1 "stack": "stack", }, "exceptionPrevious": null, // OPTIONAL: This is previous second property on new Exceptions("Example", error); "request": { "url": "string", "baseURL": "string", "method": "Methods | string", "headers": { "header-key": "header-value" }, "params": "ParametersInterface", "data": "RequestData", "timeout": "number", "responseType": "ResponseType", "maxContentLength": "number", "validateStatus": "((status: number) => boolean) | null", "maxBodyLength": "number", "maxRedirects": "number", "socketPath": "string | null", "proxy": "ProxyConfigInterface | false", "response": { // OPTIONAL: This is response from axios "data": "any", "status": "number", "headers": { "string": "string" }, } }, "createdAt": "Date", } ``` ### 💻 Prepare To Develop Copy `.env.example` to `.env` and add the values according to your needs. ### 📍 Start Project First install dependencies with the following command ```bash bun install # or npm install ``` ## 📨 Build and Run To build the project, you can use the following command > if you change files, you need to run `bun run build` and `bun run start` again ```bash bun run build && bun run start # or bun run dev ``` ## 🧪 Teste Code To Test execute this command ```bash bun run test # or bun run test:watch ``` --- _Source: https://npm.io/package/@odg/json-log · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._