Interface Logger

Records messages at four levels, redacting every secret first.

interface Logger {
    redactor: Redactor;
    close(): void;
    debug(message: string, fields?: Record<string, unknown>): void;
    error(message: string, fields?: Record<string, unknown>): void;
    info(message: string, fields?: Record<string, unknown>): void;
    warn(message: string, fields?: Record<string, unknown>): void;
}

Index

Properties

Methods

close debug error info warn

Properties

`Readonly`redactor

redactor: Redactor

Scrubs every record; register secrets with it as soon as they are known.

Methods

close

close(): void
Closes every sink.

Returns void
- Defined in log/logger.ts:41

debug

debug(message: string, fields?: Record<string, unknown>): void
Protocol traces and details for troubleshooting.
Parameters
- message: string
- Optionalfields: Record<string, unknown>
Returns void
- Defined in log/logger.ts:37

error

error(message: string, fields?: Record<string, unknown>): void
A failure the run reports.
Parameters
- message: string
- Optionalfields: Record<string, unknown>
Returns void
- Defined in log/logger.ts:31

info

info(message: string, fields?: Record<string, unknown>): void
What the run did.
Parameters
- message: string
- Optionalfields: Record<string, unknown>
Returns void
- Defined in log/logger.ts:35

warn

warn(message: string, fields?: Record<string, unknown>): void
Something the person should know, such as an insecure protocol in use.
Parameters
- message: string
- Optionalfields: Record<string, unknown>
Returns void
- Defined in log/logger.ts:33