lrlna/pino-colada
{ "createdAt": "2017-02-19T22:58:58Z", "defaultBranch": "master", "description": "cute ndjson formatter for pino π²πΉ", "fullName": "lrlna/pino-colada", "homepage": "", "language": "JavaScript", "name": "pino-colada", "pushedAt": "2022-05-22T14:32:40Z", "stargazersCount": 248, "topics": [ "emoji", "logger", "ndjson", "node" ], "updatedAt": "2025-10-10T08:38:07Z", "url": "https://github.com/lrlna/pino-colada"}pino-colada πΉ
Section titled βpino-colada πΉβ[![npm version][1]][2] [![build status][3]][4] [![downloads][5]][6] [![js-standard-style][7]][8]
A cute ndjson formatter for pino.
Pipe a server that uses pino into pino-colada for logging.
node server.js | pino-coladapino-colada
Section titled βpino-coladaβAfter parsing input from server.js, pino-colada returns a stream and pipes it
over to process.stdout. It will output a timestamp, a log level in a form of
an emoji, and a message.
const pino = require('pino')const logger = pino({ prettyPrint: {}, prettifier: require('pino-colada')})
logger.info('hi')Log Output Format
Section titled βLog Output Formatβpino-colada has a few special-case formatting modes that are enabled by passing certain keys into pino when the data is logged. Errors, for instance, should print out the error message and the stack trace. But not all errors will contain the appropriate keys (such as an error return from a promise).
Below is an example log message to demonstrate how pino-colada processes the data:
10:01:31 π¨ MyNamespace MyFunction Encountered an internal server error GET 500 /test 230B 45msError: Mock Error message triggered. at testHandler (/home/user/index.js:175:20) at /home/user/index.js:398:11 at processTicksAndRejections (node:internal/process/task_queues:96:5){ "err": { "msg": "Mock Error message triggered." }}Given the following pino log,
{"level":30,"time":1639403408545,"pid":37661,"hostname":"Irinas-MacBook-Pro.local","name":"http","message":"response","method":"GET","url":"/error","statusCode":500,"elapsed":3,"contentLength":0,"v":1}pino-colada produces the following output:
14:46:04 β¨ http --> GET 500 /error 0B 3msThe output corresponds to pinoβs ndjson. Here are is an annotated explanation of how pino-colada formats the logs:
14:46:04 β¨ http --> GET 500 /error 0B 3ms β¬ ββ¬β ββ¬β ββ¬β ββ¬β ββββ¬ββ β¬ ββ¬β | | | | | | | |βββββ¬βββ | | | | | | | | β°ββ "time" | | | | | | | | | | | | | | β°ββ "level" | | | | | | | | | | | | β°ββ "name" | | | | | | | | | | β°ββ "message" | | | | | | | | β°ββ "method" | | | | | | β°ββ "statusCode" | | | β°ββ "url" | | β°ββ "contentLength" β°ββ "elapsed"/"responseTime"A few notes on the formatting:
- We use these emojis to represent the
"level":- level 10, trace: βπβ
- level 20, debug: βπβ,
- level 30, info: ββ¨β,
- level 40, warn: ββ οΈβ,
- level 50, error: βπ¨β,
- level 60, fatal: βπβ.
- If the
"message"value isrequestorresponse, we convert it to<--and-->respectively. - If
"stack"property is present,pino-coladawill print the stack trace following the formatted error log.
Install
Section titled βInstallβnpm install pino-coladaRelated content
Section titled βRelated contentβLicense
Section titled βLicenseβ[1] !: https://img.shields.io/npm/v/pino-colada.svg?style=flat-square [2] !: https://npmjs.org/package/pino-colada [3] !: https://img.shields.io/travis/lrlna/pino-colada/master.svg?style=flat-square [4] !: https://travis-ci.org/lrlna/pino-colada [5] !: http://img.shields.io/npm/dm/pino-colada.svg?style=flat-square [6] !: https://npmjs.org/package/pino-colada [7] !: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square [8] !: https://github.com/feross/standard