SystemStatusOptions

Index

Properties

• currentHistorySecs
• loadSignals
• maxClientOverloadedRatio
• maxCpuOverloadedRatio
• maxEventLoopOverloadedRatio
• maxMemoryOverloadedRatio
• snapshotter

Properties

optionalcurrentHistorySecs

currentHistorySecs?: number = 5

Defines max age of snapshots used in the SystemStatus.getCurrentStatus measurement.

optionalloadSignals

loadSignals?: LoadSignal[]

Additional load signals to include in the system status evaluation. These are evaluated alongside the built-in memory, CPU, event loop, and client signals. If any signal reports overload, the system is considered overloaded.

optionalmaxClientOverloadedRatio

maxClientOverloadedRatio?: number = 0.3

Sets the maximum ratio of overloaded snapshots in a Client sample. If the sample exceeds this ratio, the system will be overloaded.

optionalmaxCpuOverloadedRatio

maxCpuOverloadedRatio?: number = 0.4

Sets the maximum ratio of overloaded snapshots in a CPU sample. If the sample exceeds this ratio, the system will be overloaded.

optionalmaxEventLoopOverloadedRatio

maxEventLoopOverloadedRatio?: number = 0.6

Sets the maximum ratio of overloaded snapshots in an event loop sample. If the sample exceeds this ratio, the system will be overloaded.

optionalmaxMemoryOverloadedRatio

maxMemoryOverloadedRatio?: number = 0.2

Sets the maximum ratio of overloaded snapshots in a memory sample. If the sample exceeds this ratio, the system will be overloaded.

optionalsnapshotter

snapshotter?: Snapshotter

The Snapshotter instance to be queried for SystemStatus.