system

Documentation

Index

• Constants
• type CPUHealth
  • func CPUCheck() *CPUHealth
  • func (c *CPUHealth) GetHealthStatusByCores() string
• type DiskHealth
  • func DiskCheck() *DiskHealth
• type Health
• type HealthPercent
  • func (h *HealthPercent) GetHealthStatusByPercent() string
• type RAMHealth
  • func RAMCheck() *RAMHealth
• type SystemInfo
  • func SystemInfoCheck() *SystemInfo

Constants

const (
	// B to byte
	B = 1
	// KB to B
	KB = 1024 * B
	// MB to KB
	MB = 1024 * KB
	// GB to MB
	GB = 1024 * MB
)

Types

type CPUHealth

type CPUHealth struct {
	Health

	CPUCores      int     `json:"cpuCores"`
	LoadAverage1  float64 `json:"loadAverage1"`
	LoadAverage5  float64 `json:"loadAverage5"`
	LoadAverage15 float64 `json:"loadAverage15"`
}

CPUHealth includes CPU cores, load average for one minutes, load average for five minutes, load average for fifteen minutes and health status

func CPUCheck

func CPUCheck() *CPUHealth

CPUCheck checks the cpu usage.

func (*CPUHealth) GetHealthStatusByCores

func (c *CPUHealth) GetHealthStatusByCores() string

GetHealthStatusByCores only fot CPU check; get health status by CPU cores

type DiskHealth

type DiskHealth struct {
	Health
	HealthPercent

	Used  string `json:"used"`
	Total string `json:"total"`
}

DiskHealth includes used disk, total disk, used percent and health status

func DiskCheck

func DiskCheck() *DiskHealth

DiskCheck checks the disk usage.

type Health

type Health struct {
	HealthStatus string `json:"healthStatus"`
}

Health basic struct include health status

type HealthPercent

type HealthPercent struct {
	UsedPercent int `json:"usedPercent"`
}

HealthPercent include health percentage

func (*HealthPercent) GetHealthStatusByPercent

func (h *HealthPercent) GetHealthStatusByPercent() string

GetHealthStatusByPercent get health status by percentage

type RAMHealth

type RAMHealth struct {
	Health
	HealthPercent

	Used  string `json:"used"`
	Total string `json:"total"`
}

RAMHealth includes used RAM, total RAM, used percent and health status

func RAMCheck

func RAMCheck() *RAMHealth

RAMCheck checks the RAM usage.

type SystemInfo

type SystemInfo struct {
	Hostname string `json:"hostname"`
	Uptime   string `json:"uptime"`
	OS       string `json:"os"`
	Platform string `json:"platform"`
}

SystemInfo system information

func SystemInfoCheck

func SystemInfoCheck() *SystemInfo

SystemInfoCheck get system information