gctuner

Documentation

Index

• Variables
• func GetGOGC() uint32
• func MaxGCPercent() uint32
• func MinGCPercent() uint32
• func SetDefaultGOGC()
• func SetMaxGCPercent(percent uint32)
• func SetMinGCPercent(percent uint32)
• func Tuning(threshold uint64)
• func WaitMemoryLimitTunerExitInTest()

Variables

var (

	// EnableGOGCTuner is to control whether enable the GOGC tuner.
	EnableGOGCTuner atomic.Bool
)

var GlobalMemoryLimitTuner = &memoryLimitTuner{}

GlobalMemoryLimitTuner only allow one memory limit tuner in one process

Functions

func GetGOGC

func GetGOGC() uint32

GetGOGC returns the current GCPercent.

func MaxGCPercent

func MaxGCPercent() uint32

MaxGCPercent get the max cost of memory.

func MinGCPercent

func MinGCPercent() uint32

MinGCPercent get the min cost of memory.

func SetDefaultGOGC

func SetDefaultGOGC()

SetDefaultGOGC is to set the default GOGC value.

func SetMaxGCPercent

func SetMaxGCPercent(percent uint32)

SetMaxGCPercent sets the max cost of memory.

func SetMinGCPercent

func SetMinGCPercent(percent uint32)

SetMinGCPercent sets the max cost of memory.

func Tuning

func Tuning(threshold uint64)

Tuning sets the threshold of heap which will be respect by gogc tuner. When Tuning, the env GOGC will not be take effect. threshold: disable tuning if threshold == 0

func WaitMemoryLimitTunerExitInTest

func WaitMemoryLimitTunerExitInTest()

WaitMemoryLimitTunerExitInTest is used to wait memory limit tuner exit in test.