\n\n[](https://codecov.io/gh/ODGodinho/ODG-JSONLog)\n[](https://github.com/ODGodinho/ODG-JSONLog/stargazers)\n[](https://www.linkedin.com/in/victor-alves-odgodinho/)\n[](https://github.com/ODGodinho/ODG-JSONLog/network/members)\n\n[](https://github.com/ODGodinho/ODG-JSONLog/commits/master)\n[](https://opensource.org/licenses/MIT)\n[](https://github.styleci.io/repos/562306382?branch=main)\n\n
\n\n# Table of Contents\n\n- [๐ Benefits](#-benefits)\n- [๐ Libraries](#-libraries)\n- [๐ Dependencies](#-dependencies)\n- [โฉ Get Started](#-get-started)\n - [๐ Use Plugin](#-use-plugin)\n - [๐ฒ Implementation](#-implementation)\n - [๐ SendLog](#-send-log)\n - [๐ป Prepare to develop](#-prepare-to-develop)\n - [๐ Start Project](#-start-project)\n - [๐จ Build and Run](#-build-and-run)\n - [๐งช Teste Code](#-teste-code)\n\n---\n\n## ๐ Benefits\n\n- ๐ Speed start new project or package using typescript\n- ๐จ Over 800 rules for pattern, possible errors and errors in Linter\n- ๐ Log Pattern default format\n\n## ๐ Libraries\n\n- [Node.js 16](https://nodejs.org/?n=dragonsgamers)\n- [Typescript](https://www.typescriptlang.org/?n=dragonsgamers)\n- [Eslint](https://eslint.org/?n=dragonsgamers)\n- [ODG-Linter-JS](https://github.com/ODGodinho/ODG-Linter-Js?n=dragonsgamers)\n- [EditorConfig](https://editorconfig.org/?n=dragonsgamers)\n- [ReviewDog](https://github.com/reviewdog/action-eslint)\n\n## ๐ Dependencies\n\n- [Node.js](https://nodejs.org) 16 or later\n- [Yarn](https://yarnpkg.com/) Optional/Recommended\n- [ODG TsConfig](https://github.com/ODGodinho/tsconfig) Last Version\n- [error-stack-parser](https://www.npmjs.com/package/error-stack-parser) Last Version\n\n## โฉ Get Started\n\n---\n\n### ๐ Use Plugin\n\ninstall this plugin with\n\n```powershell\nyarn add @odg/json-log\n```\n\n### ๐ฒ Implementation\n\n```typescript\nconst logger = new Logger(); // Or Other Class Logger\nconst consoleLogger = new ConsoleLogger(); // Or Other Class Logger\nconst processor = new JSONLoggerPlugin(\n \"appName\",\n);\nlogger.pushHandler(consoleLogger);\nlogger.pushProcessor(processor);\n\n// If you need convert Request and response request headers body, params in string before log\nlogger.pushProcessor(RequestStringPlugin);\n\nplugin.setIdentifier(randomUUID());\n\n// Or a function, asked again for every line: one plugin follows whichever request is logging\nplugin.setIdentifier(() => requestContext.getStore()?.requestId);\n```\n\n#### ๐ Send Log\n\n```typescript\ntry {\n throw new Exception(\"Example\");\n} catch (error) {\n await logger.error(error);\n}\n```\n\nLOG JSON Return\n\n```jsonc\n{\n \"type\": \"error\",\n \"index\": \"appName\",\n \"instance\": \"ContainerID\",\n \"identifier\": \"00000000-0000-0000-0000-00000\", // use setIdentifier in plugin to change log group\n \"gitRelease\": \"v1.0.0\",\n \"gitBranch\": \"main\",\n \"exception\": {\n \"type\": \"string\", // ExceptionClassName\n \"message\": \"string\", // Example\n \"fileException\": \"string\", // index.js\n \"functionName\": null, // OPTIONAL:\n \"fileLine\": \"number\", // 1\n \"fileColumn\": \"number\", // 1\n \"stack\": \"stack\",\n },\n \"exceptionPrevious\": null, // OPTIONAL: This is previous second property on new Exceptions(\"Example\", error);\n \"request\": {\n \"url\": \"string\",\n \"baseURL\": \"string\",\n \"method\": \"Methods | string\",\n \"headers\": {\n \"header-key\": \"header-value\"\n },\n \"params\": \"ParametersInterface\",\n \"data\": \"RequestData\",\n \"timeout\": \"number\",\n \"responseType\": \"ResponseType\",\n \"maxContentLength\": \"number\",\n \"validateStatus\": \"((status: number) => boolean) | null\",\n \"maxBodyLength\": \"number\",\n \"maxRedirects\": \"number\",\n \"socketPath\": \"string | null\",\n \"proxy\": \"ProxyConfigInterface | false\",\n \"response\": { // OPTIONAL: This is response from axios\n \"data\": \"any\",\n \"status\": \"number\",\n \"headers\": {\n \"string\": \"string\"\n },\n }\n },\n \"createdAt\": \"Date\",\n}\n```\n\n### ๐ป Prepare To Develop\n\nCopy `.env.example` to `.env` and add the values according to your needs.\n\n### ๐ Start Project\n\nFirst install dependencies with the following command\n\n```bash\nbun install\n# or\nnpm install\n```\n\n## ๐จ Build and Run\n\nTo build the project, you can use the following command\n\n> if you change files, you need to run `bun run build` and `bun run start` again\n\n```bash\nbun run build && bun run start\n# or\nbun run dev\n```\n\n## ๐งช Teste Code\n\nTo Test execute this command\n\n```bash\nbun run test\n# or\nbun run test:watch\n```\n","readmeFilename":"README.md"}