memwatch

Documentation

Index

• Constants
• Variables
• func LiveHeapReader() int64
• type Monitor
  • func NewMonitor(metricsReader metricsReader, limitSetter limitSetter, maxRatio float64) *Monitor
  • func (m *Monitor) CheckAlloc(sizeInBytes int64) error
  • func (m *Monitor) Ratio() float64
  • func (m *Monitor) Refresh()

Constants

const (
	B   = 1
	KiB = 1 << (10 * iota) // 2^10
	MiB = 1 << (10 * iota) // 2^20
	GiB = 1 << (10 * iota) // 2^30
	TiB = 1 << (10 * iota) // 2^40
)

Variables

var ErrNotEnoughMemory = fmt.Errorf("not enough memory")

Functions

func LiveHeapReader

func LiveHeapReader() int64

Types

type Monitor

type Monitor struct {
	// contains filtered or unexported fields
}

Monitor allows making statements about the memory ratio used by the application

func NewMonitor

func NewMonitor(metricsReader metricsReader, limitSetter limitSetter,
	maxRatio float64,
) *Monitor

NewMonitor creates a Monitor with the given metrics reader and target ratio

Typically this would be called with LiveHeapReader and debug.SetMemoryLimit

func (*Monitor) CheckAlloc

func (m *Monitor) CheckAlloc(sizeInBytes int64) error

func (*Monitor) Ratio

func (m *Monitor) Ratio() float64

func (*Monitor) Refresh

func (m *Monitor) Refresh()

Refresh retrieves the current memory stats from the runtime and stores them in the local cache