hicommonwealth / commonwealth

A platform for decentralized communities
https://commonwealth.im
GNU General Public License v3.0
67 stars 44 forks source link

Modernize logger and implement logging standards #6156

Open timolegros opened 9 months ago

timolegros commented 9 months ago

Description

Our logging library (typescript-logging v0.6.4) is now 4 years old and inadequate for our needs. Specifically, issue https://github.com/hicommonwealth/commonwealth/issues/5230 describes current problems/bugs we face with our existing logger. In addition to these issues, we need to update our logging strategy so that we adhere to best practices such as properly using log levels (trace vs info vs warn vs error vs critical), logging only in certain environments (don't need to log in CI tests), and abstracting away from error reporting and aggregation in Rollbar (e.g. combine log.error and rollbar.error).

Required logger features/standards:

Project Owner

@timolegros

Engineering Requirements

Specifically, complete these tickets in order:

Additional context

timolegros commented 9 months ago

Blocked by #6150

gdjohnson commented 9 months ago

@timolegros We don't have any logger documentation AFAICT, but now's a great time to start.

How are you thinking to handle? I'm always happy to hop on a call as we've done with Heroku & DataDog. (I shouldn't be as slow on the turnaround this time as I've been with DataDog—was very sick the second half of December, had to take some time.)

timolegros commented 9 months ago

Unblocked since #6150 won't be merged directly.

@gdjohnson Let's hop on a call once the 3rd ticket (#6158) is in progress since I will know more details about logging by then.