Seamlessly integrates the debug module with the high performance pino
logger so you can turn on debug logs in production scenarios
with minimum overhead.
Up to 10x faster than using debug (20x in extreme mode!)
JSON output with more detail (pino/bunyan/bole format)
For fine grained control over output stream, and mappings
between debug namespaces and pino logger levels,
supply a pino instance and an optional options object with
a map property containing mappings.
NOTE: pino-debugmust be required at the entry point of your node process,
before any other modules have been loaded
The auto option turns on any namespaces listed in the map object
(so we don't have to use the DEBUG environment variable to turn them on).
API
NOTE: pino-debug can only be called once.
pinoDebug(pinoInstance) => undefined
Call pino-debug with a pino logger instance only and any debug namespaces
enabled via DEBUG or debug.enable will be logged with the level 20 ('debug').
Remember, if you want to see the messages you need to set the pino logger instance
logging level to 'debug'.
pinoDebug() => undefined
Call pino-debug without arguments and a default pino instance will be created with
the logging level set to 20 ('debug' level).
Any debug namespaces enabled via DEBUG or debug.enable will be logged
with the level 20 ('debug').
pinoDebug(pinoInstance, opts) => undefined
This is the recommended usage. Call pino-debug with a pino logger instance,
and an opts object containining map property.
opts.map{'debug-namespace: 'pino-loglevel-label'}
The keys of the map property correspond to the same namespaces that can be
set on the DEBUG environment variable:
If true (default) any debug namespaces found in the keys of opts.map will be
enabled.
Additionally, any debug namespaces enabled via DEBUG or debug.enable
will be logged with the level 20 ('debug').
If false, any namespaces that appear in opts.mapand are enabled via
DEBUG or debug.enable will be logged to with the corresponding log level,
(as specified in the opts.map). Any not specified in opts.map, but which
are enabled via DEBUG or debug.enable will be logged with the level 20 ('debug').
opts.skipArray
Equivalent of prefixing a namespace with dash (-) when specifying
DEBUG namespaces. Any namespaces specified will not be logged.
The start-preload script demonstrates preload usage. It set's
the DEBUG environment variable to log everything,
and then uses the -r flag to load pino-debug (relatively referenced).
The three scripts beginning start-programmatic all use a different
entry point where pino-debug has been required and instantiated with
a pino instance and the mappings (as shown in usage examples).