How can I put context in request completed log (when autoLogging is true) ?

[manjilkhambe]

12-10-2023, 4:00:04 PM] INFO (on ILD-PUN-LAP-521): request completed {"req":{"method":"GET","corelationId":"83506cac-b2b4-44d1-a41a-aksd-d03eba8e5a2f"},"res":{"statusCode":200},"responseTime":4432}

[mahmoodhamdi]

You can add custom context to auto-logged request completion messages using the customProps option:

const httpLogger = pinoHTTP({
  autoLogging: true,
  customProps: (req, res) => ({
    correlationId: req.headers['x-correlation-id'] || 'unknown',
    userId: req.user?.id,
    // any additional context you want in the 'request completed' log
  })
})

The customProps function runs for every request and its return value is merged into the log object. So your output would look like:

{"req":{"method":"GET"},"res":{"statusCode":200},"responseTime":4432,"correlationId":"83506cac-...","userId":"123"}

If you need even more control, you can combine it with customSuccessMessage or customErrorMessage:

const httpLogger = pinoHTTP({
  autoLogging: true,
  customProps: (req, res) => ({
    correlationId: req.headers['x-correlation-id']
  }),
  customSuccessMessage: (req, res, responseTime) => {
    return `${req.method} ${req.url} completed in ${responseTime}ms`
  }
})