memwatch

package

v1.25.0 Latest Latest Go to latest Published: May 9, 2024 License: BSD-3-Clause Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/weaviate/weaviate

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func EstimateObjectDeleteMemory() int64
func EstimateObjectMemory(object *models.Object) int64
func LiveHeapReader() int64
type AllocChecker
type Monitor
- func NewDummyMonitor() *Monitor
- func NewMonitor(metricsReader metricsReader, limitSetter limitSetter, maxRatio float64) *Monitor

Constants ¶

View Source

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 ¶

View Source

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

Functions ¶

func EstimateObjectDeleteMemory ¶ added in v1.24.9

func EstimateObjectDeleteMemory() int64

func EstimateObjectMemory ¶ added in v1.24.9

func EstimateObjectMemory(object *models.Object) int64

func LiveHeapReader ¶ added in v1.22.5

func LiveHeapReader() int64

Types ¶

type AllocChecker ¶ added in v1.24.9

type AllocChecker interface {
	CheckAlloc(sizeInBytes int64) error
	CheckMappingAndReserve(numberMappings int64, reservationTimeInS int) error
	Refresh()
}

type Monitor ¶

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

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

func NewDummyMonitor ¶ added in v1.24.9

func NewDummyMonitor() *Monitor

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 ¶ added in v1.22.0

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

func (*Monitor) CheckMappingAndReserve ¶ added in v1.24.9

func (m *Monitor) CheckMappingAndReserve(numberMappings int64, reservationTimeInS int) error

func (*Monitor) Ratio ¶

func (m *Monitor) Ratio() float64

func (*Monitor) Refresh ¶ added in v1.22.0

func (m *Monitor) Refresh()

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

Source Files ¶

View all Source files

monitor.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL