ProcessReport

sealed external interface ProcessReport(source)

Properties

Write reports in a compact format, single-line JSON, more easily consumable by log processing systems than the default multi-line format designed for human consumption.

directory

abstract var directory: String

Directory where the report is written. The default value is the empty string, indicating that reports are written to the current working directory of the Node.js process.

filename

abstract var filename: String

Filename where the report is written. If set to the empty string, the output filename will be comprised of a timestamp, PID, and sequence number. The default value is the empty string.

reportOnFatalError

abstract var reportOnFatalError: Boolean

If true, a diagnostic report is generated on fatal errors, such as out of memory errors or failed C++ assertions.

reportOnSignal

abstract var reportOnSignal: Boolean

If true, a diagnostic report is generated when the process receives the signal specified by process.report.signal.

reportOnUncaughtException

abstract var reportOnUncaughtException: Boolean

If true, a diagnostic report is generated on uncaught exception.

signal

abstract var signal: Signals

The signal used to trigger the creation of a diagnostic report.

Functions

getReport

abstract fun getReport(err: JsError = definedExternally): Any

Returns a JavaScript Object representation of a diagnostic report for the running process. The report's JavaScript stack trace is taken from err, if present.

writeReport

abstract fun writeReport(err: JsError = definedExternally): String

abstract fun writeReport(fileName: String = definedExternally, err: JsError = definedExternally): String

Writes a diagnostic report to a file. If filename is not provided, the default filename includes the date, time, PID, and a sequence number. The report's JavaScript stack trace is taken from err, if present.