memory

Documentation

Overview

Package memory regroups collecting information about the memory

Index

• type Memory
  • func Get() (*Memory, []string, error)
  • func (memory *Memory) Collect() (result interface{}, err error)
  • func (memory *Memory) Name() string

Types

type Memory

type Memory struct {
	// TotalBytes is the total memory for the host in byte
	TotalBytes uint64
	// SwapTotalBytes is the swap memory size in byte (Unix only)
	SwapTotalBytes uint64
}

Memory holds memory metadata about the host

func Get

func Get() (*Memory, []string, error)

Get returns a Memory struct already initialized, a list of warnings and an error. The method will try to collect as much metadata as possible, an error is returned if nothing could be collected. The list of warnings contains errors if some metadata could not be collected.

func (*Memory) Collect

func (memory *Memory) Collect() (result interface{}, err error)

Collect collects the Memory information. Returns an object which can be converted to a JSON or an error if nothing could be collected. Tries to collect as much information as possible.

func (*Memory) Name

func (memory *Memory) Name() string

Name returns the name of the package