cpulimit

README

go-cpulimit

With go-cpulimit you can limit the CPU usage of your go program. It provides a function called Wait() that holds your program, until the CPU usage is below max CPU usage.

You should use this Wait() function in as many situations as possible, e.g. on every iteration in a for loop.

Warning: This limiter does not work, if there are insufficient Wait() calls.

This package requires github.com/shirou/gopsutil (Copyright (c) 2014, WAKAYAMA Shirou) to be installed.

Example

limiter := &cpulimit.Limiter{
    MaxCPUUsage:     50.0,                   // throttle CPU usage to 50%
    MeasureInterval: time.Millisecond * 333, // measure cpu usage in an interval of 333 ms
    Measurements:    3,                      // use the avg of the last 3 measurements
}
limiter.Start()
defer limiter.Stop()
for {
    limiter.Wait() // wait until cpu usage is below 50%
    /*
     * do some work
     */
}

Documentation

Index

• Constants
• type Limiter
  • func (l *Limiter) Start() error
  • func (l *Limiter) Stop()
  • func (l *Limiter) Wait()

Constants

const (
	// DefaultLimit is 80%
	DefaultLimit float64 = 80.0
	// DefaultInterval is 333 ms
	DefaultInterval time.Duration = time.Millisecond * 333
	// DefaultMeasurements is 3
	DefaultMeasurements int = 3
)

Types

type Limiter

type Limiter struct {
	// MaxCPUUsage specifies the maximum CPU usage; wait will block if the
	// average CPU usage during the previous measurements exceeds this value.
	MaxCPUUsage float64
	// MeasureInterval specifies how often the CPU usage should be measured.
	MeasureInterval time.Duration
	// Measurements specifies how many measurements should be retained for the
	// average CPU usage calculation.
	Measurements int
	// CurrentProcessOnly specifies that only the CPU usage of the current process
	// should be measured; otherwise, the full CPU usage is measured.
	CurrentProcessOnly bool
	// contains filtered or unexported fields
}

Limiter limits the CPU usage

func (*Limiter) Start

func (l *Limiter) Start() error

Start starts the CPU limiter. If there are undefined variables Start() will set them to the default values.

func (*Limiter) Stop

func (l *Limiter) Stop()

Stop stops the limiter. After this stop, Wait() won't block anymore.

func (*Limiter) Wait

func (l *Limiter) Wait()

Wait waits until the CPU usage is below MaxCPUUsage