\n Robust logger! 💪\n
\n\n## :package: Content\n\n- [Technologies](#Technologies)\n- [Getting Started](#Getting Started)\n- [How to install](#How to install)\n- [Config](#Config)\n\n## :hammer_and_wrench: Technologies\n\nWe are using the following technologies:\n\n- [cls-hooked](https://www.npmjs.com/package/cls-hooked) - used to create and manage context;\n- [tslog](https://tslog.js.org/#/) - used as base for the implementation of the lib-logger;\n- [typescript](https://www.typescriptlang.org/)\n\n## :climbing: Getting Started\n\nThis lib aims to centralize all the necessary tools for the Ballin Team logs.\n\n## How to install\n\n```bash\nnpm install @ballin-team/lib-apm\n```\n\n## Config\n\n```typeScript\nimport { Logger } from \"@ballin-team/lib-apm\";\n\nconst logger = Logger.createLogger({\n \"name\": \"lib-logger\", // service/ms name\n \"minLevel\": \"debug\", // the minimum level to log into the terminal\n \"suppressStdOutput\": false, // suspend log in terminal\n \"transports\": [ // custom services to execute methods with logObject as parameter\n {\n \"provider\": \"coralogix\", // transport type\n \"minLevel\": \"debug\", // the minimum level to execute the transport\n \"enabled\": true, // activate or not the transport\n \"options\": { // transport options\n \"applicationName\": \"\",\n \"privateKey\": \"\",\n \"subsystemName\": \"\",\n \"category\": \"\"\n }\n },\n {\n \"provider\": \"sentry\",\n \"minLevel\": \"info\",\n \"enabled\": true\n },\n ]\n});\n```\n\n### Habilitar source map para TypeScript:\n\nThis feature enables lib-apm to reference a correct line number in your TypeScript source code.\n\n```json\n// tsconfig.json\n{\n // ...\n \"compilerOptions\": {\n // ...\n \"sourceMap\": true,\n // we recommend using a current ES version\n \"target\": \"es2019\"\n }\n}\n```\n\n### Use Cases\n\n#### Basic Implementation\n\n```TypeScript\nimport { Logger } from \"@ballin-team/lib-apm\";\n\nconst logger = new Logger({\n instanceName: 'service name',\n minLevel: 'info',\n transports: [],\n});\n\nlogger.setRequestId(123)\nlogger.silly(\"I am a silly log.\");\nlogger.trace(\"I am a trace log with a stack trace.\");\nlogger.debug(\"I am a debug log.\");\nlogger.info(\"I am an info log.\");\nlogger.warn(\"I am a warn log with a json object:\", {foo: \"bar\"});\nlogger.error(\"I am an error log.\");\nlogger.fatal(new Error(\"I am a pretty Error with a stacktrace.\"));\n```\n\n#### Implementation with express\n\n```TypeScript\n// logger/index.ts\nimport { Logger } from '@ballin-team/lib-apm'\nimport * as dotenv from 'dotenv'\ndotenv.config({ path: `./environments/.env.${process.env.NODE_ENV}` });\n\nconst configLogger = () => {\n const enableTransport = process.env.NODE_ENV === 'production'\n return new Logger({\n name: \"ms_test\",\n minLevel: \"info\",\n suppressStdOutput: false,\n transports: [\n {\n provider: 'coralogix',\n minLevel: 'error',\n enabled: enableTransport,\n options: {\n applicationName: \"\",\n privateKey: \"\",\n subsystemName: \"\",\n category: \"\",\n }\n },\n {\n provider: 'sentry',\n minLevel: 'info',\n enabled: true\n },\n ]\n })\n}\n\nexport const logger = configLogger()\n\n// app.ts\nimport { logger } from './logger';\nimport express from \"express\";\n\nexport const initApp = async () => {\n const app = express()\n\n // ...setting other configs and middlewares\n\n app.use(express.json()); // the \"express.json\" needs to be instantiated before the \"logger.setContext\"\n app.use(logger.setContext) // will create context for each request\n\n // ... routes and middlewares\n\n return app\n};\n\n// middleware/setRequestId.ts\nimport { NextFunction, Response } from 'express'\nimport { IRequest } from '../interfaces/request'\nimport { v4 as uuid } from 'uuid'\nimport { Logger } from '../logger'\n\n\nexport const setRequestId = (req: IRequest, res: Response, next: NextFunction): void => {\n const requestId = (req.headers['x-request-id'] as string) || uuid()\n\n req.requestId = requestId\n\n Logger.setRequestId(requestId)\n Logger.info(req.method,req.path,req.body)\n\n return next()\n};\n\n// Now just call the logger anywhere in your code =)\n```\n\n## Transports\n\n### Coralogix\n\nTransport Coralogix aims to capture all logs from the level defined in the setup and insert them as an occurrence in case of error;\n\n## :incoming_envelope: Made by\n\n- :feelsgood: Time Ballin\n","readmeFilename":"README.md"}