Documentation ¶
Overview ¶
Package stats implements periodic collection and display of various - possibly interesting - statistics. A typical reading might be:
M[ 1Mb -816b ] O[ 1564 +0] G[ 39 +0] P 11/11
This shows:
M[ 1Mb -816b ] - system memory, change since last collection O[ 1564 +0] - heap objects, change since last collection G[ 39 +0] - Goroutines, change since last collection P 11/11 - Current number of players / maximum number of players
System memory is rounded to the nearest convenient units: b - bytes, kb - kilobytes, Mb - megabytes, Gb - gigabytes, Tb - terabytes, Pb - petabytes, Eb - exabytes. Everything above terabytes is included for completeness - but 64 unsigned bits *CAN* go up to 15Eb or 18,446,744,073,709,551,615 bytes ;)
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func List ¶
List returns the names of all players in the player list. The omit parameter may be used to specify a player that should be omitted from the list.
func Remove ¶
Remove removes the specified player from the list of players.
func Start ¶
func Start()
Start begins collection and reporting of statistics. The interval between updates is controlled via config.StatsRate which if set to zero disables collection and reporting.
Types ¶
This section is empty.