\n\n---\n\n\n\nA modular utility library for Node.js projects, starting with a robust, extensible logger utility. This library is designed to be expanded with additional utilities over time, making it a central toolkit for your backend applications.\n\n---\n\n## Release Notes — v2.0.0\n\nReleased: 2025-11-09\n\n- Major bump to `@abimongo/logger` -> **2.0.0**.\n- Fix: GraphQL-related issues in the core package have been addressed so consumers using Abimongo Core will not encounter runtime logging errors related to transport shapes.\n- Fix: Improved robustness when consumers configure transports (defensive checks to avoid runtime TypeError when a transport entry is undefined).\n- Fix: Buffered -> file transport flush behavior improved so buffered logs reach the file transport promptly.\n- Misc: Docs, metrics card updates, and packaging improvements.\n\nUpgrade notes:\n- This is a major release. Please test in staging before upgrading production.\n- If you previously passed transport factory references, ensure you follow the transport API: pass either an instantiated transport object (has `.write` or `.log`) or a function-style transporter (`async (message, meta) => ...`) as appropriate.\n\n\n## Features\n\n- **Advanced Logger Utility** \n - Customizable log levels (`info`, `debug`, `error`, etc.)\n - Pluggable transporters (console, file, custom)\n - Hooks for log and error events\n - Metadata enrichment\n - Source-based log exclusion\n - TypeScript support\n\n---\n\n## Installation\n\n```sh\nnpm install @abimongo/logger\n```\n\n---\n\n## Logger Usage\n\n### Logger Utility\n\n#### Basic Setup\n\n```typescript\nimport { setupLogger } from '@abimongo/logger';\n\nconst logger = setupLogger({\n level: 'info',\n transporters: [\n {\n write: (msg: string) => {\n // Write to console, file, or any custom destination\n console.log(msg);\n }\n },\n // Add other properties here\n ],\n hooks: {\n onLog: (msg, meta) => {\n // Custom logic after logging\n },\n onError: (err, meta) => {\n // Custom error handling\n }\n },\n enrichMetadata: (meta) => ({\n ...meta,\n timestamp: new Date().toISOString(),\n }),\n excludedSources: ['test'],\n});\n```\n\n#### Logging\n\n```typescript\nlogger.info('Application started', { source: 'app' });\nlogger.error('Something went wrong', { source: 'service', error: new Error('fail') });\n```\n\n#### Using a Custom Logger\n\nIf you already have a logger instance, you can pass it to `setupLogger`:\n\n```typescript\nconst customLogger = {\n info: (msg: string) => { /* ... */ },\n error: (msg: string) => { /* ... */ },\n};\n\nconst logger = setupLogger({ logger: customLogger });\n```\n\n---\n\nIf you are implementing ( logger ) without using the above setup yourself then follow below steps.\n\n## Advanced Logger Usage (`@abimongo/logger`)\n\nThe logger is a pluggable, buffered, rolling log system that supports:\n\n- JSON or text formatting\n- Daily file rotation with compression\n- Multi-tenant routing\n- Redis real-time log streaming\n- Metrics tracking\n\n### Install Redis for full features\n\n```bash\nnpm install redis # windows\nbrew install redis # macOS\nsudo apt install redis # Linux\n```\n\n### Usage\n\n```ts\nimport { logger } from '@abimongo/logger';\n\nawait logger.log('User created', 'info', { tenantId: 'org-123' });\n```\n\n### Metrics\n\n```ts\nlogger.getMetrics(); // { totalLogs, flushedBuffers, logsPerMinute }\n\n```\n\n### Flush & CLose\n\n```ts\nawait logger.flushAll();\nawait logger.close();\n```\n\n### CLI Tools\n\n```bash\nnpm run logger:tail # Tail logs in terminal (from Redis)\nnpm run logger:flush # Flush buffered logs\nnpm run logger:metrics # View internal metrics\n```\n\n### Real-time Dashboard\n\n```bash\nnpm run start\n# Visit /log-dashboard\n```\n\nThis page connects to a WebSocket server that listens to logs:* Redis channels.\n\n---\n\n## Development\n\n### Running Locally with Docker\n\nA `docker-compose.yml` is provided for local development:\n\n```sh\ndocker-compose up\n```\n\nThis will mount your code, install dependencies, build the library, and keep the container running for development and testing.\n\n### Scripts\n\n- `npm run build` – Build the library\n- `npm test` – Run tests\n- `npm run lint` – Lint the codebase\n\n---\n\n## Publishing\n\nThis library is published to npm via GitHub Actions when a new version tag (`v*.*.*`) is pushed to the `main` or `master` branch.\n\n---\n\n## Extending the Library\n\nThe `abimongo_logger library is designed to be extended. Future utilities can be added under the`src/` directory and exported via the main entry point.\n\n---\n\n## License\n\nISC\n\n---\n\n## Maintainers\n\n- Emmanuel Nodolomwanyi ([padave805@gmail.com](mailto:padave805@gmail.com))\n\n---\n\n## Contributing\n\nContributions are welcome! Please open issues or submit pull requests for new utilities or improvements.\n","readmeFilename":"README.md","homepage":"https://github.com/NodEm9/abimongo#readme","bugs":{"url":"https://github.com/NodEm9/abimongo/issues"}}
![\"Abimongo](\"../../abimongo-brand/abimongo-logo_socials.png\"){kind=logo}
![\"npm](\"https://img.shields.io/npm/v/@abimongo/logger.svg?style=flat-square&color=00C4B4\")
\n ![\"GitHub](\"https://img.shields.io/github/stars/Nodem9/abimongo?style=flat-square&color=1E88E5\")
\n