package host

import "github.com/shirou/gopsutil/v3/host"

Index

Functions

func BootTime 

func BootTime() (uint64, error)

BootTime returns the system boot time expressed in seconds since the epoch.

func BootTimeWithContext 

func BootTimeWithContext(ctx context.Context) (uint64, error)

func EnableBootTimeCache 

func EnableBootTimeCache(enable bool)

EnableBootTimeCache change cache behavior of BootTime. If true, cache BootTime value. Default is false.

func HostID 

func HostID() (string, error)

HostID returns the unique host ID provided by the OS.

func HostIDWithContext 

func HostIDWithContext(ctx context.Context) (string, error)

func KernelArch 

func KernelArch() (string, error)

func KernelVersion 

func KernelVersion() (string, error)

func KernelVersionWithContext 

func KernelVersionWithContext(ctx context.Context) (version string, err error)

func PlatformInformation 

func PlatformInformation() (string, string, string, error)

func PlatformInformationWithContext 

func PlatformInformationWithContext(ctx context.Context) (platform string, family string, version string, err error)

func Uptime 

func Uptime() (uint64, error)

func UptimeWithContext 

func UptimeWithContext(ctx context.Context) (uint64, error)

func Virtualization 

func Virtualization() (string, string, error)

func VirtualizationWithContext 

func VirtualizationWithContext(ctx context.Context) (string, string, error)

Types

type InfoStat 

type InfoStat struct {
	Hostname             string `json:"hostname"`
	Uptime               uint64 `json:"uptime"`
	BootTime             uint64 `json:"bootTime"`
	Procs                uint64 `json:"procs"`           // number of processes
	OS                   string `json:"os"`              // ex: freebsd, linux
	Platform             string `json:"platform"`        // ex: ubuntu, linuxmint
	PlatformFamily       string `json:"platformFamily"`  // ex: debian, rhel
	PlatformVersion      string `json:"platformVersion"` // version of the complete OS
	KernelVersion        string `json:"kernelVersion"`   // version of the OS kernel (if available)
	KernelArch           string `json:"kernelArch"`      // native cpu architecture queried at runtime, as returned by `uname -m` or empty string in case of error
	VirtualizationSystem string `json:"virtualizationSystem"`
	VirtualizationRole   string `json:"virtualizationRole"` // guest or host
	HostID               string `json:"hostId"`             // ex: uuid
}

A HostInfoStat describes the host status. This is not in the psutil but it useful.

func Info 

func Info() (*InfoStat, error)

func InfoWithContext 

func InfoWithContext(ctx context.Context) (*InfoStat, error)

func (InfoStat) String 

func (h InfoStat) String() string

type TemperatureStat 

type TemperatureStat struct {
	SensorKey   string  `json:"sensorKey"`
	Temperature float64 `json:"temperature"`
	High        float64 `json:"sensorHigh"`
	Critical    float64 `json:"sensorCritical"`
}

func SensorsTemperatures 

func SensorsTemperatures() ([]TemperatureStat, error)

func SensorsTemperaturesWithContext 

func SensorsTemperaturesWithContext(ctx context.Context) ([]TemperatureStat, error)

func (TemperatureStat) String 

func (t TemperatureStat) String() string

type UserStat 

type UserStat struct {
	User     string `json:"user"`
	Terminal string `json:"terminal"`
	Host     string `json:"host"`
	Started  int    `json:"started"`
}

func Users 

func Users() ([]UserStat, error)

func UsersWithContext 

func UsersWithContext(ctx context.Context) ([]UserStat, error)

func (UserStat) String 

func (u UserStat) String() string

type Warnings 

type Warnings = common.Warnings

Source Files

host.go host_linux.go host_linux_amd64.go host_posix.go

Version
v3.24.5 (latest)
Published
May 28, 2024
Platform
linux/amd64
Imports
16 packages
Last checked
1 day ago –

Tools for package owners.