Add custom log payload support to logFormatter

[dthyresson]

Fixes #4154

As part of making dev logging less verbose, only certain objects were being logged: queries, timing, etc.

But, sometimes one wants to log ad-hoc custom payloads when debugging, but currently one has to use:

logger.debug({ query: { my_custom: value } }), 'Custom debug logging')

This PR adds the custom option:

logger.debug({ custom: { my_custom: value } }), 'Custom debug logging')

which will format the message text or object in a readable way with a label and emoji.

describe('Custom log data', () => {
    test('Should include the custom log attribute text', () => {
      expect(
        logFormatter({
          level: 10,
          custom: 'I should see this custom message text',
        })
      ).toMatch('I should see this')
    })

    test('Should include the custom log attribute info a custom emoji and label', () => {
      expect(
        logFormatter({
          level: 10,
          custom: 'I should see this custom emoji and label',
        })
      ).toMatch('🗒 Custom')
    })

    test('Should include the custom log attribute info with nested text message', () => {
      expect(
        logFormatter({
          level: 10,
          custom: {
            msg: 'I should see this custom message in the log',
          },
        })
      ).toMatch('I should see this custom message in the log')
    })
  })

  test('Should include the custom log attribute info with a number attribute', () => {
    expect(
      logFormatter({
        level: 10,
        custom: {
          msg: 'I should see this custom message and number in the log',
          number: 100,
        },
      })
    ).toMatch('100')
  })

  test('Should include the custom log attribute info with a nested object attribute', () => {
    expect(
      logFormatter({
        level: 10,
        custom: {
          msg: 'I should see this custom object in the log',
          obj: { foo: 'bar' },
        },
      })
    ).toMatch('"foo": "bar"')
  })

  test('Should include the custom log attribute info with a nested object attribute', () => {
    expect(
      logFormatter({
        level: 10,
        custom: {
          msg: 'I should see this custom object in the log',
          obj: { foo: 'bar' },
        },
      })
    ).toMatch('"foo": "bar"')
  })
})

[simoncrypta]

Everything works well, and I like the format and idea! 🗒

But just a little detail, I think you put one round brackets too many in your example.
logger.debug({ custom: { my_custom: value } } ), 'Custom debug logging')
logger.debug({ custom: { my_custom: value } }, 'Custom debug logging')
But when I removed it, it works as expect 👍

[dthyresson]

Everything works well, and I like the format and idea! 🗒

But just a little detail, I think you put one round brackets too many in your example. logger.debug({ custom: { my_custom: value } } ), 'Custom debug logging') logger.debug({ custom: { my_custom: value } }, 'Custom debug logging') But when I removed it, it works as expect 👍

Yup, I did. Bad copy and paste.

Thanks!