{"_id":"@amberjs/log","_rev":"2-c19cd841a4e832727e88fe6eb9491776","name":"@amberjs/log","dist-tags":{"latest":"1.3.0"},"versions":{"1.3.0":{"name":"@amberjs/log","version":"1.3.0","description":"A Simplified Multi-transport and Structured Logging Library for Amber.js","main":"src/AmberLog.js","scripts":{"test":"NODE_PATH=. nyc --reporter=html --reporter=text --reporter=lcov ava -s test/*.js --verbose","test:watch":"ava -s test/*.js --verbose --watch","ava":"nyc ava -s --verbose","lint":"eslint src -f json -o ./reports/eslint-issues.json; exit 0"},"keywords":["log","brewery","amberjs"],"author":{"name":"Levin Calado","email":"jcalado@stratpoint.com"},"repository":{"type":"git","url":"git@gitlab.stratpoint.dev:thebrewery/amberjs/log.git"},"license":"MIT","devDependencies":{"ava":"^2.4.0","eslint-config-airbnb-base":"12.1.0","eslint-plugin-import":"2.12.0","husky":"^3.0.5","lint-staged":"^9.3.0","nyc":"^14.1.1","sinon":"^6.1.0"},"dependencies":{},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"{src}/**/*.js":["eslint --fix","git add"]},"gitHead":"d6bb53ce8e10a04f19347fc58d86834f5b4ac811","_id":"@amberjs/log@1.3.0","_npmVersion":"6.4.1","_nodeVersion":"8.16.1","_npmUser":{"name":"jcalado","email":"jcalado@stratpoint.com"},"dist":{"integrity":"sha512-MM1tGPD8EpxPy7oeP+37cH8hY2UW/HLy/iIuirz6Wr6kqRpYzLlGAozz1wcZlyLlij3A2+q0D8QkGponFPaF0g==","shasum":"ae413d98a3a8aba27504bfcc36e074ae6fdcc749","tarball":"https://registry.npmjs.org/@amberjs/log/-/log-1.3.0.tgz","fileCount":16,"unpackedSize":24931,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdixDGCRA9TVsSAnZWagAApWQQAJzxUo+t/cSFSKMIR30i\n8+jcUgJoXkvUPzKCe17IbpJ06i/5RX+nsP6SfyWrctwp+3EKyIkEw+gVBns5\nWljpKKSc0Tcc7HeVT2QSs5ggx0ndk7ry/ge1IfgJ1Fr/QyAETgrMuBrs7MTF\n8fikC9X5oQOepPbiZTuUYTzVwNXiC53HbVFSnIMKM2vQ0EtGaoOs5sOJAglH\nF8MjRwZs+I2tKU1XyOkwRMx0xl/Zyvq/SO4eRfogLVX0+vxcRfhE01U3wCgl\nmES7+GvrKUOMAxc49ZcWG6fL+cIXM59tPLp2MB1fYAiuZkQyu4N/OeRJw5pO\nSUR8WdyzzxsieEzABWVkGq3C3NJjY2AQPaAnGyHwImTb8RZbv0V6+RuKbW9p\n0w3MC68PwSGt3Gp/tfrNsvHnhUSB0X2Gexe8mbkHXzoxOhBU6E6CTMNOzl2h\nknnC6jH5zC7ZSJnmdRk+0IXLYNF829tGTEhFTy/WDIUL4OHcniPkcFX5SWOP\n4mcqMGVTArH8uM3tSo4unPCRkttflZClZbotHyXYDMBSkdvY/CnsKqV+ls4r\nWBLBrZGYHlRKJPMFKDMMGo0kiY5K4RTK2xaCsr6Yi4Sv64Wdrh2pcj1mDOk6\n3wRk4abYfcnQGZaxdXPeWzrijdmcNC75rXX0uRDX99hkwh4WwgR26/vpCVL9\nq+ht\r\n=BF2m\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAyq4o4cSS9QeQ74u1UCjD3yLvwqMrdXLCkbu5zb3i0MAiEAxMZOcbv0T8oFojZRTHrMpmaGa5TmXrhpoWrQV9FN5Ck="}]},"maintainers":[{"name":"jcalado","email":"jcalado@stratpoint.com"},{"name":"brewery-apps","email":"apps@stratpoint.dev"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/log_1.3.0_1569394885452_0.17117335382205057"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-25T07:01:25.214Z","1.3.0":"2019-09-25T07:01:25.583Z","modified":"2022-04-04T13:45:47.966Z"},"maintainers":[{"email":"excelsior.mante@gmail.com","name":"excelsior.mante"},{"email":"jcalado@stratpoint.com","name":"jcalado"},{"email":"apps@stratpoint.dev","name":"brewery-apps"}],"description":"A Simplified Multi-transport and Structured Logging Library for Amber.js","keywords":["log","brewery","amberjs"],"repository":{"type":"git","url":"git@gitlab.stratpoint.dev:thebrewery/amberjs/log.git"},"author":{"name":"Levin Calado","email":"jcalado@stratpoint.com"},"license":"MIT","readme":"# @amberjs/log\n\nA Simplified Multi-transport and Structured Logging Library for Amber.js\n\n\n## Table of Contents\n\n* [Install](#install)\n* [Usage](#usage)\n* [API](#api)\n* [Logging Levels](#logging-levels)\n* [Transports](#transports)\n* [Contributors](#contributors)\n* [License](#license)\n\n\n## Install\n\n```sh\nnpm install @amberjs/log\n```\n\n\n## Usage\n\n**RECOMMENDED:** create your own logger definition\n\n```js\nconst AmberLog = require('@amberjs/log');\n\nconst logger = AmberLog.initLogger({\n  level: 'info', // Default log level for transports with no specified level\n  transports: [\n    { transport: 'Console' }, // Prints log to console\n    { transport: 'File', filename: 'debug.log', level: 'debug' }, // Writes log with level `debug` and below to `debug.log`\n    { transport: 'File', filename: 'error.log', level: 'error' } // Writes error logs to `error.log`\n  ]\n});\n\nlogger.log('info', { message: 'Welcome to the Brewery' });\n```\n\n**DEFAULT:** you may also log it directly using the default `require('@amberjs/log')`, but this only \nlogs to default `stdout` and `stderr` with logging level set to `info`\n\n```js\nconst logger = require('@amberjs/log');\nlogger.log('info', { message: 'Welcome to the Brewery' });\n```\n\n\n## API\n\n## `AmberLog`\n\n`.initLogger([config])` - Initialize the Brewery Logger\n- `config` ( Type: `Object`, Properties: `level`, `transports` )\n\n`.add([logger])` - Adds a new logger instance to our loggers\n- `logger` ( Type: `Object`, Properties: `transport`, `level`, `filename`)\n- **Note**: `filename` should be set if `transport` is `File`, see [Transports](#transports).\n\n`.setLevel([level], [details])` - Set Logging Level for all logger instances\n- `level` ( Type: `String` )\n\n`.log([level], [details])` - Sends the log message to all Logger Instances for logging\n- `level` ( Type: `String` )\n- `details` ( Type: `Object|String` )\n\n`.error([details])` - Logs a message with `error` level\n- `details` ( Type: `Object|String` )\n\n`.warn([details])` - Logs a message with `warn` level\n- `details` ( Type: `Object|String` )\n\n`.info([details])` - Logs a message with `info` level\n- `details` ( Type: `Object|String` )\n\n`.verbose([details])` - Logs a message with `verbose` level\n- `details` ( Type: `Object|String` )\n\n`.debug([details])` - Logs a message with `debug` level\n- `details` ( Type: `Object|String` )\n\n\n## Logging Levels\n\nLogging levels conform to the severity ordering specified by [RFC5424]: _severity of all levels \nis assumed to be numerically **ascending** from most important to least important._\n\n**NOTE:** Usage of unknown log level will not be logged and will log an `Error`\n\n``` js\nconst levels = { \n  error: 0, \n  warn: 1, \n  info: 2, \n  verbose: 3, \n  debug: 4\n};\n```\n\n\n## Transports\n\nThe core transports that are currently available to AmberLog are:\n* `Console` - writes the log to the default stdout and stderr\n\n**USAGE**\n```js\nconst logger = AmberLog.initLogger({\n  transports: [{ transport: 'Console', level: 'info' }]\n});\n\nlogger.log('info', { message: 'Welcome to the Brewery' });\n```\n\n**OUTPUT**\n```sh\n{ datetime: 2018-06-21T08:05:55.266Z,\n  level: 'info',\n  details: { message: 'Welcome to the Brewery' } }\n```\n\n* `File` - writes the log to the specified file with appended datetime(YYYY-MM-DD) on the filename\n\n**USAGE**\n```js\nconst logger = AmberLog.initLogger({\n  transports: [\n    transport: 'File', filename: 'debug.log', level: 'debug'\n  ],\n});\n\nlogger.log('info', { message: 'Welcome to the Brewery' });\n```\n\n**OUTPUT**\n```sh\n{\"datetime\":\"2018-06-21T08:05:55.266Z\",\"level\":'info',\"details\":{\"message\":\"Welcome to the Brewery\"}}\n```\n\n## Contributors\n\n* Ronald dela Cruz\n* James Levin Calado\n\n## License\n\n[MIT](LICENSE) © Stratpoint Technologies Inc.","readmeFilename":"README.md"}