nodeshift / nodejs-reference-architecture

The Red Hat and IBM Node.js Reference architecture. The teams 'opinion' on what components our customers and internal teams should use when building Node.js applications and guidance for how to be successful in production with those components.
https://nodeshift.dev/nodejs-reference-architecture/
Apache License 2.0
1.72k stars 123 forks source link

Recommend Roarr over Pino #69

Closed gajus closed 3 years ago

gajus commented 3 years ago

The current recommended component for logging is Pino

https://github.com/nodeshift/nodejs-reference-architecture/blob/main/docs/operations/logging.md

Roarr is an actively maintained Node.js JSON logger that has several benefits over Pino and other frameworks:

I have provided an in depth write up about my motivation for creating and maintaining Roarr.

Perhaps the most useful (unique) feature of Roarr is adopt, which allows to inherit log context and describes relationships between logs in async contexts using sequence.

mhdawson commented 3 years ago

@gajus thanks for the heads up on another option for logging.

One of the key elements of the recommendations is that they are based on the existing experience in our internal deployments and work with our customers. From https://github.com/nodeshift/nodejs-reference-architecture/blob/main/README.md, the key aspect we've documented is Where possible the opinion is based on what we've used internally and in our customer engagements.

We acknowledge that there will be other options which are as good but the net is that we'll end up pointing to ones that we have experience with.

At this point we have a number of internal teams/implementations using pino and have experience with it across the different groups which is one of the reasons it is in the architecture.

I've leave this issue open for another week for visibility across the team, but to set expectations, we'd have to see our internal usage to shift from pino to Roarr before we are likely to update our suggestions.

mhdawson commented 3 years ago

Closing this out now as it has been open for awareness for over a week.