metrics

Documentation

Index

• type BatteryInfo
• type FanInfo
• type GPUInfo
• type LoadAverages
• type MachineType
• type NetworkIO
• type PlatformInfo
• type Snapshot
  • func Gather() (*Snapshot, error)
  • func SnapshotFromJSON(data string) (*Snapshot, error)
  • func (s *Snapshot) ToJSON() (string, error)
• type ThermalInfo
• type TimeOfDay

Types

type BatteryInfo

type BatteryInfo struct {
	Percent  float64 `json:"percent"`
	Charging bool    `json:"charging"`
}

BatteryInfo holds battery status (nil on desktops or if unavailable)

type FanInfo

type FanInfo struct {
	Speed float64 `json:"speed"` // RPM
	Name  string  `json:"name"`  // Fan identifier
}

FanInfo holds fan speed readings

type GPUInfo

type GPUInfo struct {
	Usage       *float64 `json:"usage,omitempty"`        // GPU utilization percent
	MemoryUsed  *uint64  `json:"memory_used,omitempty"`  // VRAM used in bytes
	MemoryTotal *uint64  `json:"memory_total,omitempty"` // Total VRAM in bytes
}

GPUInfo holds GPU metrics

type LoadAverages

type LoadAverages struct {
	Load1  float64 `json:"load1"`
	Load5  float64 `json:"load5"`
	Load15 float64 `json:"load15"`
}

LoadAverages holds Unix-style load averages (nil on Windows)

type MachineType

type MachineType string

MachineType represents the type of machine

const (
	MachineTypeLaptop    MachineType = "laptop"
	MachineTypeDesktop   MachineType = "desktop"
	MachineTypeServer    MachineType = "server"
	MachineTypeVM        MachineType = "virtual_machine"
	MachineTypeContainer MachineType = "container"
	MachineTypeUnknown   MachineType = "unknown"
)

type NetworkIO

type NetworkIO struct {
	BytesSent uint64 `json:"bytes_sent"`
	BytesRecv uint64 `json:"bytes_recv"`
}

NetworkIO holds network traffic counters

type PlatformInfo

type PlatformInfo struct {
	OS           string `json:"os"`           // darwin, linux, windows
	Architecture string `json:"architecture"` // amd64, arm64
	OSVersion    string `json:"os_version"`   // e.g., "14.0" for macOS Sonoma
	Kernel       string `json:"kernel"`       // kernel version
}

PlatformInfo holds OS and architecture info

type Snapshot

type Snapshot struct {
	Timestamp     time.Time     `json:"timestamp"`
	Uptime        time.Duration `json:"uptime"`
	MemoryTotal   uint64        `json:"memory_total"`
	MemoryUsed    uint64        `json:"memory_used"`
	MemoryPercent float64       `json:"memory_percent"`
	CPUPercent    float64       `json:"cpu_percent"`
	DiskTotal     uint64        `json:"disk_total"`
	DiskUsed      uint64        `json:"disk_used"`
	DiskPercent   float64       `json:"disk_percent"`

	// Machine identity
	MachineType MachineType   `json:"machine_type"`
	Platform    *PlatformInfo `json:"platform,omitempty"`
	TimeOfDay   TimeOfDay     `json:"time_of_day"`

	// Optional metrics (nil if unavailable on platform)
	LoadAverages *LoadAverages `json:"load_averages,omitempty"`
	SwapTotal    *uint64       `json:"swap_total,omitempty"`
	SwapUsed     *uint64       `json:"swap_used,omitempty"`
	SwapPercent  *float64      `json:"swap_percent,omitempty"`
	Battery      *BatteryInfo  `json:"battery,omitempty"`
	ProcessCount *int          `json:"process_count,omitempty"`
	NetworkIO    *NetworkIO    `json:"network_io,omitempty"`
	Thermal      *ThermalInfo  `json:"thermal,omitempty"`
	Fans         []*FanInfo    `json:"fans,omitempty"`
	GPU          *GPUInfo      `json:"gpu,omitempty"`
}

Snapshot represents a moment-in-time capture of system state

func Gather

func Gather() (*Snapshot, error)

Gather collects current system metrics and returns a snapshot

func SnapshotFromJSON

func SnapshotFromJSON(data string) (*Snapshot, error)

SnapshotFromJSON deserializes a snapshot from a JSON string

func (*Snapshot) ToJSON

func (s *Snapshot) ToJSON() (string, error)

ToJSON serializes the snapshot to a JSON string

type ThermalInfo

type ThermalInfo struct {
	CPUTemp     *float64 `json:"cpu_temp,omitempty"` // Celsius
	GPUTemp     *float64 `json:"gpu_temp,omitempty"` // Celsius
	HighestTemp float64  `json:"highest_temp"`       // Highest sensor reading
	SensorCount int      `json:"sensor_count"`       // Number of sensors read
}

ThermalInfo holds temperature readings

type TimeOfDay

type TimeOfDay string

TimeOfDay represents the general time period

const (
	TimeOfDayNight     TimeOfDay = "night"     // 12am - 6am
	TimeOfDayMorning   TimeOfDay = "morning"   // 6am - 12pm
	TimeOfDayAfternoon TimeOfDay = "afternoon" // 12pm - 6pm
	TimeOfDayEvening   TimeOfDay = "evening"   // 6pm - 12am
)