pino icon indicating copy to clipboard operation
pino copied to clipboard

Improve documentation on global logging level with multiple targets

Open mjarosie opened this issue 1 year ago • 4 comments

The "global" level setting isn't taken into account when transport.targets parameter is provided - each target has its own level that defaults to info (as mentioned here). That might be a bit confusing and should probably be mentioned in the documentation.

For example originally having this config:

const logger = pino({
  level: 'debug',
  transport: {
    target: 'pino-pretty',
  },
})

logger.trace('trace') # Doesn't appear
logger.debug('debug')
logger.info('info')
logger.warn('warn')
logger.error('error')
logger.fatal('fatal')

If I switch to the following, I'd lose debug logs:

const logger = pino({
  level: 'debug',
  transport: {
    targets: [{ target: 'pino-pretty' }],
  },
})

logger.trace('trace') # Doesn't appear
logger.debug('debug') # Doesn't appear
logger.info('info')
logger.warn('warn')
logger.error('error')
logger.fatal('fatal')

I appreciate that this might be an expected behaviour, but I'd expect this to be documented explicitly - I couldn't find the mention of it, unless I didn't look in the right place or I somehow missed it? It took me some time to figure out what's happening - it only started making sense when I've found the comment in the GitHub issue linked above.

mjarosie avatar Feb 05 '24 15:02 mjarosie

https://github.com/pinojs/pino/blob/9259e13309a77f246ad1a766c27cda794e2915d0/docs/api.md?plain=1#L1267

jsumners avatar Feb 05 '24 20:02 jsumners

https://github.com/pinojs/pino/blob/9259e13309a77f246ad1a766c27cda794e2915d0/docs/api.md?plain=1#L1267

I don't see how the linked option documentation would clear up the confusion. I think that it should be clearly stated here or here to make it clear that if you provide a list of targets to pino(), the top-level level option is ignored.

mjarosie avatar Feb 06 '24 12:02 mjarosie

Would you like to send a Pull Request to address this issue?

jsumners avatar Feb 06 '24 13:02 jsumners

Sure, will create one soon.

mjarosie avatar Feb 08 '24 10:02 mjarosie