[EPIC]: Improve Corelink Server Logging and Error Reporting
Improve Corelink Server Logging and Error Reporting
Overview
Currently corelink server written in node js uses console.log
to emit log messages. This although is fine for normal debugging, can slow down the whole process by a lot, as console.log
is a synchronous method. it forces the current thread to write to stdout
. This is easily fixable though - using a logging library like Winston.
Requirements
- Improve error reporting and messages. Corelink server defines a list of error response message. Make sure that they are indeed transmitted back to the client.
- Improve logging and metrics collection on the server.
Subtasks
-
Investigate and compare viable logging libraries [March 6-12] (1 week) - Winston
- Bunyan
- Log4js
- Pino
-
Prepare a document describing how logging is done in corelink and how it can be configured [March 13-March 19] (1 Week) -
Introduce a logging framework in corelink [March 19-April 2] (3 weeks) -
Improve upon existing logs we have in place. [April 3-16] (2 weeks) -
Test the stability and performance of corelink-server after incorporating the changes [April 17-30] (2 weeks)
Edited by Utsav Oza