Interface PrettyOptions

Hide objects from output (but not error object).

Default

false
Copy

Translate the epoch time value into a human readable date and time string. This flag also can set the format string to apply when translating the date to human readable format. For a list of available pattern letters see the documentation.

• The default format is yyyy-mm-dd HH:MM:ss.l o in UTC.
• Requires a SYS: prefix to translate time to the local system's timezone. Use the shortcut SYS:standard to translate time to yyyy-mm-dd HH:MM:ss.l o in system timezone.

Default

false
Copy

If set to true, it will print the name of the log level as the first field in the log line.

Default

false
Copy

Define the key that contains the level of the log.

Default

"level"
Copy

Output the log level using the specified label.

Default

"levelLabel"
Copy

The key in the JSON object to use as the highlighted message.

Default

"msg"

Not required when used with pino >= 8.21.0
Copy

Print each log message on a single line (errors will still be multi-line).

Default

false
Copy

The key in the JSON object to use for timestamp display.

Default

"time"
Copy

The minimum log level to include in the output.

Default

"trace"
Copy

Format output of message, e.g. {level} - {pid} will output message: INFO - 1123

Default

false
Copy

Example

{
  messageFormat: (log, messageKey) => {
    const message = log[messageKey];
    if (log.requestId) return `[${log.requestId}] ${message}`;
    return message;
  }
}
Copy

If set to true, will add color information to the formatted output message.

Default

false
Copy

If set to false while colorize is true, will output JSON objects without color.

Default

true
Copy

Appends carriage return and line feed, instead of just a line feed, to the formatted log line.

Default

false
Copy

Define the log keys that are associated with error like objects.

Default

["err", "error"]

Not required to handle custom errorKey when used with pino >= 8.21.0
Copy

When formatting an error object, display this list of properties. The list should be a comma separated list of properties.

Default

""
Copy

Ignore one or several keys. Will be overridden by the option include if include is presented.

Example

"time,hostname"
Copy

Include one or several keys.

Example

"time,level"
Copy

Makes messaging synchronous.

Default

false
Copy

The file, file descriptor, or stream to write to. Defaults to 1 (stdout).

Default

1
Copy

Opens the file with the 'a' flag.

Default

true
Copy

Ensure directory for destination file exists.

Default

false
Copy

Provides the ability to add a custom prettify function for specific log properties. customPrettifiers is an object, where keys are log properties that will be prettified and value is the prettify function itself. For example, if a log line contains a query property, you can specify a prettifier for it:

Default

{}
Copy

Example

{
  customPrettifiers: {
    query: prettifyQuery
  }
}
//...
const prettifyQuery = value => {
 // do some prettify magic
}
Copy

Change the level names and values to an user custom preset.

Can be a CSV string in 'level_name:level_value' format or an object.

Example

( CSV ) customLevels: 'info:10,some_level:40'
Copy

Example

( Object ) customLevels: { info: 10, some_level: 40 }

Not required when used with pino >= 8.21.0
Copy

Change the level colors to an user custom preset.

Can be a CSV string in 'level_name:color_value' format or an object. Also supports 'default' as level_name for fallback color.

Example

( CSV ) customColors: 'info:white,some_level:red'
Copy

Example

( Object ) customColors: { info: 'white', some_level: 'red' }
Copy

Only use custom levels and colors (if provided); else fallback to default levels and colors.

Default

true
Copy