Interface LoggerOptions

interface LoggerOptions {
    base?: null | {
        [key: string]: any;
    };
    browser?: {
        asObject?: boolean;
        disabled?: boolean;
        formatters?: {
            level?: ((label: string, number: number) => object);
            log?: ((object: Record<string, unknown>) => Record<string, unknown>);
        };
        serialize?: boolean | string[];
        transmit?: {
            level?: LevelOrString;
            send: ((level: Level, logEvent: LogEvent) => void);
        };
        write?: WriteFn | {
            debug?: WriteFn;
            error?: WriteFn;
            fatal?: WriteFn;
            info?: WriteFn;
            trace?: WriteFn;
            warn?: WriteFn;
        } & {
            [logLevel: string]: WriteFn;
        };
    };
    crlf?: boolean;
    customLevels?: {};
    depthLimit?: number;
    destination?: DestinationStream;
    edgeLimit?: number;
    enabled?: boolean;
    errorKey?: string;
    formatters?: {
        bindings?: ((bindings: Bindings) => object);
        level?: ((label: string, number: number) => object);
        log?: ((object: Record<string, unknown>) => Record<string, unknown>);
    };
    hooks?: {
        logMethod?: ((this: Logger<never>, args: [msg: string, ...args: any[]], method: LogFn, level: number) => void);
    };
    level?: LevelWithSilentOrString;
    levelComparison?: "ASC" | "DESC" | ((current: number, expected: number) => boolean);
    levelVal?: number;
    logger?: Logger;
    messageKey?: string;
    mixin?: MixinFn<never>;
    mixinMergeStrategy?: MixinMergeStrategyFn;
    msgPrefix?: string;
    name?: string;
    nestedKey?: string;
    onChild?: OnChildCallback<never>;
    redact?: string[] | redactOptions;
    safe?: boolean;
    serializers?: {
        [key: string]: SerializerFn;
    };
    timestamp?: boolean | TimeFn;
    transport?: TransportSingleOptions<Record<string, any>> | TransportMultiOptions<Record<string, any>> | TransportPipelineOptions<Record<string, any>>;
    useOnlyCustomLevels?: boolean;
}

Hierarchy

  • LoggerOptions
    • LoggerOptions

Properties

base? browser? crlf? customLevels? depthLimit? destination? edgeLimit? enabled? errorKey? formatters? hooks? level? levelComparison? levelVal? logger? messageKey? mixin? mixinMergeStrategy? msgPrefix? name? nestedKey? onChild? redact? safe? serializers? timestamp? transport? useOnlyCustomLevels?

Properties

Optionalbase

base?: null | {
    [key: string]: any;
}

key-value object added as child logger to each log line. If set to null the base child logger is not added

Optionalbrowser

browser?: {
    asObject?: boolean;
    disabled?: boolean;
    formatters?: {
        level?: ((label: string, number: number) => object);
        log?: ((object: Record<string, unknown>) => Record<string, unknown>);
    };
    serialize?: boolean | string[];
    transmit?: {
        level?: LevelOrString;
        send: ((level: Level, logEvent: LogEvent) => void);
    };
    write?: WriteFn | {
        debug?: WriteFn;
        error?: WriteFn;
        fatal?: WriteFn;
        info?: WriteFn;
        trace?: WriteFn;
        warn?: WriteFn;
    } & {
        [logLevel: string]: WriteFn;
    };
}

Browser only, see http://getpino.io/#/docs/browser.

Type declaration

  • OptionalasObject?: boolean

    The asObject option will create a pino-like log object instead of passing all arguments to a console method. When write is set, asObject will always be true.

    Example 

    pino.info('hi') // creates and logs {msg: 'hi', level: 30, time: <ts>}
  • Optionaldisabled?: boolean

    The disabled option will disable logging in browser if set to true, by default it is set to false.

    Example 

    const pino = require('pino')({browser: {disabled: true}})
  • Optionalformatters?: {
        level?: ((label: string, number: number) => object);
        log?: ((object: Record<string, unknown>) => Record<string, unknown>);
    }
    • Optionallevel?: ((label: string, number: number) => object)

      Changes the shape of the log level. The default shape is { level: number }.

        • (label, number): object

        • Parameters

          • label: string
          • number: number

          Returns object

    • Optionallog?: ((object: Record<string, unknown>) => Record<string, unknown>)

      Changes the shape of the log object.

        • (object): Record<string, unknown>

        • Parameters

          • object: Record<string, unknown>

          Returns Record<string, unknown>

  • Optionalserialize?: boolean | string[]

    The serializers provided to pino are ignored by default in the browser, including the standard serializers provided with Pino. Since the default destination for log messages is the console, values such as Error objects are enhanced for inspection, which they otherwise wouldn't be if the Error serializer was enabled. We can turn all serializers on or we can selectively enable them via an array.

    When serialize is true the standard error serializer is also enabled (see https://github.com/pinojs/pino/blob/master/docs/api.md#pino-stdserializers). This is a global serializer which will apply to any Error objects passed to the logger methods.

    If serialize is an array the standard error serializer is also automatically enabled, it can be explicitly disabled by including a string in the serialize array: !stdSerializers.err (see example).

    The serialize array also applies to any child logger serializers (see https://github.com/pinojs/pino/blob/master/docs/api.md#bindingsserializers-object for how to set child-bound serializers).

    Unlike server pino the serializers apply to every object passed to the logger method, if the asObject option is true, this results in the serializers applying to the first object (as in server pino).

    For more info on serializers see https://github.com/pinojs/pino/blob/master/docs/api.md#serializers-object.

    Example 

    const pino = require('pino')({
      browser: {
        serialize: true
      }
    })

    Example 

    const pino = require('pino')({
      serializers: {
        custom: myCustomSerializer,
        another: anotherSerializer
      },
      browser: {
        serialize: ['custom']
      }
    })
    // following will apply myCustomSerializer to the custom property,
    // but will not apply anotherSerializer to another key
    pino.info({custom: 'a', another: 'b'})

    Example 

    const pino = require('pino')({
      serializers: {
        custom: myCustomSerializer,
        another: anotherSerializer
      },
      browser: {
        serialize: ['!stdSerializers.err', 'custom'] //will not serialize Errors, will serialize `custom` keys
      }
    })
  • Optionaltransmit?: {
        level?: LevelOrString;
        send: ((level: Level, logEvent: LogEvent) => void);
    }

    Options for transmission of logs.

    Example 

    const pino = require('pino')({
      browser: {
        transmit: {
          level: 'warn',
          send: function (level, logEvent) {
            if (level === 'warn') {
              // maybe send the logEvent to a separate endpoint
              // or maybe analyse the messages further before sending
            }
            // we could also use the `logEvent.level.value` property to determine
            // numerical value
            if (logEvent.level.value >= 50) { // covers error and fatal

              // send the logEvent somewhere
            }
          }
        }
      }
    })
    • Optionallevel?: LevelOrString

      Specifies the minimum level (inclusive) of when the send function should be called, if not supplied the send function will be called based on the main logging level (set via options.level, defaulting to info).

    • send: ((level: Level, logEvent: LogEvent) => void)

      Remotely record log messages.

      Description

      Called after writing the log message.

        • (level, logEvent): void

        • Parameters

          • level: Level
          • logEvent: LogEvent

          Returns void

  • Optionalwrite?: WriteFn | {
        debug?: WriteFn;
        error?: WriteFn;
        fatal?: WriteFn;
        info?: WriteFn;
        trace?: WriteFn;
        warn?: WriteFn;
    } & {
        [logLevel: string]: WriteFn;
    }

    Instead of passing log messages to console.log they can be passed to a supplied function. If write is set to a single function, all logging objects are passed to this function. If write is an object, it can have methods that correspond to the levels. When a message is logged at a given level, the corresponding method is called. If a method isn't present, the logging falls back to using the console.

    Example 

    const pino = require('pino')({
      browser: {
        write: (o) => {
          // do something with o
        }
      }
    })

    Example 

    const pino = require('pino')({
      browser: {
        write: {
          info: function (o) {
            //process info log object
          },
          error: function (o) {
            //process error log object
          }
        }
      }
    })

Optionalcrlf

crlf?: boolean

logs newline delimited JSON with \r\n instead of \n. Default: false.

OptionalcustomLevels

customLevels?: {}

Use this option to define additional logging levels. The keys of the object correspond the namespace of the log level, and the values should be the numerical value of the level.

OptionaldepthLimit

depthLimit?: number

Stringification limit at a specific nesting depth when logging circular object. Default: 5.

Optionaldestination

destination?: DestinationStream

OptionaledgeLimit

edgeLimit?: number

Stringification limit of properties/elements when logging a specific object/array with circular references. Default: 100.

Optionalenabled

enabled?: boolean

Enables logging. Default: true.

OptionalerrorKey

errorKey?: string

The string key for the 'error' in the JSON object. Default: "err".

Optionalformatters

formatters?: {
    bindings?: ((bindings: Bindings) => object);
    level?: ((label: string, number: number) => object);
    log?: ((object: Record<string, unknown>) => Record<string, unknown>);
}

An object containing functions for formatting the shape of the log lines. These functions should return a JSONifiable object and should never throw. These functions allow for full customization of the resulting log lines. For example, they can be used to change the level key name or to enrich the default metadata.

Type declaration

  • Optionalbindings?: ((bindings: Bindings) => object)

    Changes the shape of the bindings. The default shape is { pid, hostname }. The function takes a single argument, the bindings object. It will be called every time a child logger is created.

      • (bindings): object

      • Parameters

        • bindings: Bindings

        Returns object

  • Optionallevel?: ((label: string, number: number) => object)

    Changes the shape of the log level. The default shape is { level: number }. The function takes two arguments, the label of the level (e.g. 'info') and the numeric value (e.g. 30).

      • (label, number): object

      • Parameters

        • label: string
        • number: number

        Returns object

  • Optionallog?: ((object: Record<string, unknown>) => Record<string, unknown>)

    Changes the shape of the log object. This function will be called every time one of the log methods (such as .info) is called. All arguments passed to the log method, except the message, will be pass to this function. By default it does not change the shape of the log object.

      • (object): Record<string, unknown>

      • Parameters

        • object: Record<string, unknown>

        Returns Record<string, unknown>

Optionalhooks

hooks?: {
    logMethod?: ((this: Logger<never>, args: [msg: string, ...args: any[]], method: LogFn, level: number) => void);
}

An object mapping to hook functions. Hook functions allow for customizing internal logger operations. Hook functions must be synchronous functions.

Type declaration

  • OptionallogMethod?: ((this: Logger<never>, args: [msg: string, ...args: any[]], method: LogFn, level: number) => void)

    Allows for manipulating the parameters passed to logger methods. The signature for this hook is logMethod (args, method, level) {}, where args is an array of the arguments that were passed to the log method and method is the log method itself, and level is the log level. This hook must invoke the method function by using apply, like so: method.apply(this, newArgumentsArray).

      • (this, args, method, level): void

      • Parameters

        • this: Logger<never>
        • args: [msg: string, ...args: any[]]
        • method: LogFn
        • level: number

        Returns void

Optionallevel

level?: LevelWithSilentOrString

One of the supported levels or silent to disable logging. Any other value defines a custom level and requires supplying a level value via levelVal. Default: 'info'.

OptionallevelComparison

levelComparison?: "ASC" | "DESC" | ((current: number, expected: number) => boolean)

Use this option to define custom comparison of log levels. Useful to compare custom log levels or non-standard level values. Default: "ASC"

OptionallevelVal

levelVal?: number

When defining a custom log level via level, set to an integer value to define the new level. Default: undefined.

Optionallogger

logger?: Logger

OptionalmessageKey

messageKey?: string

The string key for the 'message' in the JSON object. Default: "msg".

Optionalmixin

mixin?: MixinFn<never>

If provided, the mixin function is called each time one of the active logging methods is called. The function must synchronously return an object. The properties of the returned object will be added to the logged JSON.

OptionalmixinMergeStrategy

mixinMergeStrategy?: MixinMergeStrategyFn

If provided, the mixinMergeStrategy function is called each time one of the active logging methods is called. The first parameter is the value mergeObject or an empty object, the second parameter is the value resulting from mixin() or an empty object. The function must synchronously return an object.

OptionalmsgPrefix

msgPrefix?: string

A string that would be prefixed to every message (and child message)

Optionalname

name?: string

The name of the logger. Default: undefined.

OptionalnestedKey

nestedKey?: string

The string key to place any logged object under.

OptionalonChild

onChild?: OnChildCallback<never>

Optional child creation callback.

Optionalredact

redact?: string[] | redactOptions

As an array, the redact option specifies paths that should have their values redacted from any log output.

Each path must be a string using a syntax which corresponds to JavaScript dot and bracket notation.

If an object is supplied, three options can be specified:

 paths (String[]): Required. An array of paths
 censor (String): Optional. A value to overwrite key which are to be redacted. Default: '[Redacted]'
 remove (Boolean): Optional. Instead of censoring the value, remove both the key and the value. Default: false

Optionalsafe

safe?: boolean

Avoid error causes by circular references in the object tree. Default: true.

Optionalserializers

serializers?: {
    [key: string]: SerializerFn;
}

an object containing functions for custom serialization of objects. These functions should return an JSONifiable object and they should never throw. When logging an object, each top-level property matching the exact key of a serializer will be serialized using the defined serializer.

Optionaltimestamp

timestamp?: boolean | TimeFn

Enables or disables the inclusion of a timestamp in the log message. If a function is supplied, it must synchronously return a JSON string representation of the time. If set to false, no timestamp will be included in the output. See stdTimeFunctions for a set of available functions for passing in as a value for this option. Caution: any sort of formatted time will significantly slow down Pino's performance.

Optionaltransport

transport?: TransportSingleOptions<Record<string, any>> | TransportMultiOptions<Record<string, any>> | TransportPipelineOptions<Record<string, any>>

OptionaluseOnlyCustomLevels

useOnlyCustomLevels?: boolean

Use this option to only use defined customLevels and omit Pino's levels. Logger's default level must be changed to a value in customLevels in order to use useOnlyCustomLevels Warning: this option may not be supported by downstream transports.

Settings

Member Visibility

On This Page

Properties