Challenge Objectives

• Build a custom logging module based on Winston that will allow posting errors to our BUS API.

Project Background

We’re in the process of revamping our platform and adding support to store more information about our users as traits in order to improve the overall user experience on our platform.

Technology Stack

• Node.js

• Apache Kafka

Code Access

This is a new project so there is no existing code.

Detailed requirement

As part of this challenge, we need your help to build a custom logging module that will be used from various applications within our infrastructure (eg backend services, APIs, processors etc).

 

This logging module will be based on Winston.

 

Here are some sample use cases in our existing applications:

• https://github.com/topcoder-platform/resources-api/blob/develop/src/common/logger.js

• https://github.com/topcoder-platform/legacy-processor-module/blob/develop/common/logger.js

• https://github.com/topcoder-platform/legacy-challenge-processor/blob/develop/src/common/logger.js

 

You need to support all features from the above examples.

A new custom feature that must be implemented (major requirement) is a custom error method (logger.error) that will, based on the configs passed to the module, either log the error in the console as it would normally do or post the error on a configured Apache Kafka event topic using our BUS API.

 

You can use the https://github.com/topcoder-platform/tc-bus-api-wrapper module to post the errors on our BUS API.

 

All options must be configurable by the application that will use this logging module.

 

You need to cover this module with strong unit/e2e testing.

 

You need to include a detailed README.md file with instructions on how to import the module into another application, how to configure it and how to use it.

 

Should you have any questions, feel free to ask on the challenge forum!

What to Submit

Submit a zip file containing your whole project folder.

Final Submission Guidelines

Please read above