Skip to main content
Version: v2.10.3

NodeStats

frameStats can be null. NodeLink may report cpu.nodelinkLoad; do not assume JVM-only statistics are available.

Definition​

export interface NodeStats {
/** The amount of players on the node. */
players: number;
/** The amount of playing players on the node. */
playingPlayers: number;
/** The uptime for the node. */
uptime: number;
/** The memory stats for the node. */
memory: MemoryStats;
/** The cpu stats for the node. */
cpu: CPUStats;
/** The frame stats for the node. */
frameStats: FrameStats | null;
}

MemoryStats​

export interface MemoryStats {
/** The free memory of the allocated amount. */
free: number;
/** The used memory of the allocated amount. */
used: number;
/** The total allocated memory. */
allocated: number;
/** The reservable memory. */
reservable: number;
}

CPUStats​

See CPUStats for the process-load fields, including NodeLink's optional nodelinkLoad.

FrameStats​

See FrameStats. Individual fields can be absent, and the containing NodeStats.frameStats value can be null.