types

package
v1.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2025 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatteryData added in v1.0.3 

type BatteryData struct {
	Present       bool          `json:"present"`                      // Whether a battery is present
	Batteries     []BatteryInfo `json:"batteries"`                    // Multiple batteries (some devices have 2+)
	UPSDevices    []UPSInfo     `json:"ups_devices,omitempty"`        // UPS devices
	TotalCapacity uint64        `json:"total_capacity_mwh,omitempty"` // Combined capacity of all batteries
	OnBattery     bool          `json:"on_battery"`                   // Whether system is running on battery
}

BatteryData contains battery information for laptops and UPS devices

type BatteryInfo added in v1.0.3 

type BatteryInfo struct {
	Name            string  `json:"name"`                             // Battery identifier (BAT0, BAT1, etc.)
	Vendor          string  `json:"vendor,omitempty"`                 // Battery manufacturer
	Model           string  `json:"model,omitempty"`                  // Battery model number
	SerialNumber    string  `json:"serial_number,omitempty"`          // Battery serial number
	Technology      string  `json:"technology,omitempty"`             // Li-ion, Li-poly, NiMH, etc.
	State           string  `json:"state"`                            // Charging, Discharging, Full, Idle, Not charging
	ChargeLevel     float64 `json:"charge_level_percent"`             // Current charge level (0-100)
	Capacity        uint64  `json:"capacity_mwh"`                     // Design capacity in milliwatt-hours
	CapacityFull    uint64  `json:"capacity_full_mwh"`                // Full charge capacity (current max)
	CapacityNow     uint64  `json:"capacity_now_mwh"`                 // Current charge in milliwatt-hours
	EnergyFull      uint64  `json:"energy_full_mwh,omitempty"`        // Full energy capacity
	EnergyNow       uint64  `json:"energy_now_mwh,omitempty"`         // Current energy level
	PowerNow        uint64  `json:"power_now_mw,omitempty"`           // Current power draw/charge rate
	Voltage         float64 `json:"voltage_v,omitempty"`              // Current voltage in volts
	VoltageMin      float64 `json:"voltage_min_v,omitempty"`          // Minimum design voltage
	Current         int64   `json:"current_ma,omitempty"`             // Current in milliamps (negative = discharging)
	Temperature     float64 `json:"temperature_celsius,omitempty"`    // Battery temperature
	CycleCount      uint64  `json:"cycle_count,omitempty"`            // Number of charge cycles
	Health          float64 `json:"health_percent,omitempty"`         // Battery health (capacity_full/capacity * 100)
	TimeToEmpty     int64   `json:"time_to_empty_minutes,omitempty"`  // Estimated time until empty (-1 if N/A)
	TimeToFull      int64   `json:"time_to_full_minutes,omitempty"`   // Estimated time until full (-1 if N/A)
	TimeRemaining   int64   `json:"time_remaining_minutes,omitempty"` // Estimated time remaining
	IsCharging      bool    `json:"is_charging"`                      // Currently charging
	IsDischarging   bool    `json:"is_discharging"`                   // Currently discharging
	ManufactureDate string  `json:"manufacture_date,omitempty"`       // Manufacturing date
}

BatteryInfo contains information about a single battery

type CPUData 

type CPUData struct {
	ModelName   string       `json:"model_name"`
	Cores       int32        `json:"physical_cores"`
	LogicalCPUs int32        `json:"logical_cpus"`
	Vendor      string       `json:"vendor"`
	Family      string       `json:"family"`
	Model       string       `json:"model"`
	Stepping    int32        `json:"stepping"`
	MHz         float64      `json:"mhz"`
	MinMHz      float64      `json:"min_mhz,omitempty"`
	MaxMHz      float64      `json:"max_mhz,omitempty"`
	CacheSize   int32        `json:"cache_size"`
	Usage       []float64    `json:"usage_percent"`
	LoadAvg     *LoadAverage `json:"load_average,omitempty"`
	Flags       []string     `json:"flags,omitempty"`
	Microcode   string       `json:"microcode,omitempty"`
}

CPUData contains CPU information

type DiskData 

type DiskData struct {
	Partitions    []PartitionInfo `json:"partitions"`
	PhysicalDisks []PhysicalDisk  `json:"physical_disks,omitempty"`
	IOStats       []DiskIOStat    `json:"io_stats,omitempty"`
	SMARTData     []SMARTInfo     `json:"smart_data,omitempty"`
}

DiskData contains disk and partition information

type DiskIOStat 

type DiskIOStat struct {
	Name       string `json:"name"`
	ReadCount  uint64 `json:"read_count"`
	WriteCount uint64 `json:"write_count"`
	ReadBytes  uint64 `json:"read_bytes"`
	WriteBytes uint64 `json:"write_bytes"`
	ReadTime   uint64 `json:"read_time_ms"`
	WriteTime  uint64 `json:"write_time_ms"`
	IoTime     uint64 `json:"io_time_ms"`
}

DiskIOStat contains disk I/O statistics

type GPUData 

type GPUData struct {
	GPUs []GPUInfo `json:"gpus"`
}

GPUData contains GPU information

type GPUInfo 

type GPUInfo struct {
	Index             int     `json:"index"`
	Name              string  `json:"name"`
	Vendor            string  `json:"vendor"`
	Driver            string  `json:"driver,omitempty"`
	DriverVersion     string  `json:"driver_version,omitempty"`
	MemoryTotal       uint64  `json:"memory_total_bytes,omitempty"`
	MemoryUsed        uint64  `json:"memory_used_bytes,omitempty"`
	MemoryFree        uint64  `json:"memory_free_bytes,omitempty"`
	MemoryFormatted   string  `json:"memory_total_formatted,omitempty"`
	Temperature       int     `json:"temperature_celsius,omitempty"`
	FanSpeed          int     `json:"fan_speed_percent,omitempty"`
	PowerDraw         float64 `json:"power_draw_watts,omitempty"`
	PowerLimit        float64 `json:"power_limit_watts,omitempty"`
	Utilization       int     `json:"utilization_percent,omitempty"`
	MemoryUtilization int     `json:"memory_utilization_percent,omitempty"`
	ClockSpeed        int     `json:"clock_speed_mhz,omitempty"`
	ClockSpeedMemory  int     `json:"clock_speed_memory_mhz,omitempty"`
	PCIBus            string  `json:"pci_bus,omitempty"`
	UUID              string  `json:"uuid,omitempty"`
}

GPUInfo contains information about a single GPU

type LoadAverage 

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

LoadAverage contains system load averages

type MemoryData 

type MemoryData struct {
	Total          uint64         `json:"total_bytes"`
	Available      uint64         `json:"available_bytes"`
	Used           uint64         `json:"used_bytes"`
	UsedPercent    float64        `json:"used_percent"`
	Free           uint64         `json:"free_bytes"`
	TotalFormatted string         `json:"total_formatted"`
	UsedFormatted  string         `json:"used_formatted"`
	FreeFormatted  string         `json:"free_formatted"`
	SwapTotal      uint64         `json:"swap_total_bytes"`
	SwapUsed       uint64         `json:"swap_used_bytes"`
	SwapFree       uint64         `json:"swap_free_bytes"`
	SwapPercent    float64        `json:"swap_used_percent"`
	Modules        []MemoryModule `json:"memory_modules,omitempty"`
	VirtualTotal   uint64         `json:"virtual_total_bytes,omitempty"`
	VirtualUsed    uint64         `json:"virtual_used_bytes,omitempty"`
	Cached         uint64         `json:"cached_bytes,omitempty"`
	Buffers        uint64         `json:"buffers_bytes,omitempty"`
	Shared         uint64         `json:"shared_bytes,omitempty"`
}

MemoryData contains memory information

type MemoryModule 

type MemoryModule struct {
	Locator      string `json:"locator"`
	Capacity     uint64 `json:"capacity_bytes"`
	Speed        uint64 `json:"speed_mhz,omitempty"`
	Type         string `json:"type,omitempty"`
	Manufacturer string `json:"manufacturer,omitempty"`
	PartNumber   string `json:"part_number,omitempty"`
	SerialNumber string `json:"serial_number,omitempty"`
	FormFactor   string `json:"form_factor,omitempty"`
}

MemoryModule contains information about a physical memory module

type NetworkData 

type NetworkData struct {
	Interfaces  []NetworkInterface `json:"interfaces"`
	Connections int                `json:"connection_count,omitempty"`
}

NetworkData contains network information

type NetworkInterface 

type NetworkInterface struct {
	Name         string   `json:"name"`
	HardwareAddr string   `json:"hardware_addr"`
	Addresses    []string `json:"addresses"`
	Flags        []string `json:"flags"`
	MTU          int      `json:"mtu"`
	BytesSent    uint64   `json:"bytes_sent"`
	BytesRecv    uint64   `json:"bytes_recv"`
	PacketsSent  uint64   `json:"packets_sent"`
	PacketsRecv  uint64   `json:"packets_recv"`
	ErrorsIn     uint64   `json:"errors_in"`
	ErrorsOut    uint64   `json:"errors_out"`
	DropsIn      uint64   `json:"drops_in"`
	DropsOut     uint64   `json:"drops_out"`
}

NetworkInterface contains information about a network interface

type PartitionInfo 

type PartitionInfo struct {
	Device         string  `json:"device"`
	MountPoint     string  `json:"mount_point"`
	FSType         string  `json:"fs_type"`
	Total          uint64  `json:"total_bytes"`
	Free           uint64  `json:"free_bytes"`
	Used           uint64  `json:"used_bytes"`
	UsedPercent    float64 `json:"used_percent"`
	TotalFormatted string  `json:"total_formatted"`
	UsedFormatted  string  `json:"used_formatted"`
	FreeFormatted  string  `json:"free_formatted"`
	InodesTotal    uint64  `json:"inodes_total,omitempty"`
	InodesUsed     uint64  `json:"inodes_used,omitempty"`
	InodesFree     uint64  `json:"inodes_free,omitempty"`
}

PartitionInfo contains information about a disk partition

type PhysicalDisk 

type PhysicalDisk struct {
	Name          string `json:"name"`
	Model         string `json:"model,omitempty"`
	SerialNumber  string `json:"serial_number,omitempty"`
	Size          uint64 `json:"size_bytes"`
	SizeFormatted string `json:"size_formatted"`
	Type          string `json:"type,omitempty"`      // HDD, SSD, NVMe, etc.
	Interface     string `json:"interface,omitempty"` // SATA, NVMe, USB, etc.
	RPM           uint32 `json:"rpm,omitempty"`       // For HDDs
	Removable     bool   `json:"removable"`
}

PhysicalDisk contains information about physical disks

type ProcessData 

type ProcessData struct {
	TotalCount  int           `json:"total_count"`
	Running     int           `json:"running"`
	Sleeping    int           `json:"sleeping"`
	TopByMemory []ProcessInfo `json:"top_by_memory,omitempty"`
	TopByCPU    []ProcessInfo `json:"top_by_cpu,omitempty"`
}

ProcessData contains process information

type ProcessInfo 

type ProcessInfo struct {
	PID           int32   `json:"pid"`
	Name          string  `json:"name"`
	Username      string  `json:"username,omitempty"`
	CPUPercent    float64 `json:"cpu_percent"`
	MemoryPercent float32 `json:"memory_percent"`
	MemoryMB      uint64  `json:"memory_mb"`
	Status        string  `json:"status"`
	CreateTime    int64   `json:"create_time,omitempty"`
}

ProcessInfo contains information about a single process

type SMARTAttribute 

type SMARTAttribute struct {
	ID         uint8  `json:"id"`
	Name       string `json:"name"`
	Flag       uint16 `json:"flag"`
	Value      uint8  `json:"value"`       // Current normalized value
	Worst      uint8  `json:"worst"`       // Worst value seen
	Threshold  uint8  `json:"threshold"`   // Failure threshold
	RawValue   uint64 `json:"raw_value"`   // Raw value
	Type       string `json:"type"`        // Pre-fail or Old_age
	Updated    string `json:"updated"`     // Always or Offline
	WhenFailed string `json:"when_failed"` // Never, FAILING_NOW, In_the_past
	RawString  string `json:"raw_string"`  // Human-readable raw value
}

SMARTAttribute contains detailed information about a SMART attribute

type SMARTError 

type SMARTError struct {
	ErrorNumber   uint64 `json:"error_number"`
	LifetimeHours uint64 `json:"lifetime_hours"`
	State         string `json:"state"`
	Type          string `json:"type"`
	Details       string `json:"details"`
}

SMARTError represents a single SMART error entry

type SMARTErrorLog 

type SMARTErrorLog struct {
	ErrorCount uint64       `json:"error_count"`
	Errors     []SMARTError `json:"errors,omitempty"`
}

SMARTErrorLog contains SMART error log information

type SMARTHealthStatus 

type SMARTHealthStatus struct {
	Passed            bool     `json:"passed"`
	OverallAssessment string   `json:"overall_assessment"` // PASS, FAIL, WARN
	FailingAttributes []string `json:"failing_attributes,omitempty"`
	WarningAttributes []string `json:"warning_attributes,omitempty"`
	CriticalWarning   string   `json:"critical_warning,omitempty"`
	PercentUsed       float64  `json:"percent_used,omitempty"`    // For SSDs
	AvailableSpare    float64  `json:"available_spare,omitempty"` // For NVMe
	TemperatureStatus string   `json:"temperature_status,omitempty"`
}

SMARTHealthStatus contains health assessment information

type SMARTInfo 

type SMARTInfo struct {
	Device           string             `json:"device"`
	Serial           string             `json:"serial,omitempty"`
	ModelFamily      string             `json:"model_family,omitempty"`
	DeviceModel      string             `json:"device_model,omitempty"`
	FirmwareVersion  string             `json:"firmware_version,omitempty"`
	Capacity         uint64             `json:"capacity_bytes,omitempty"`
	Healthy          bool               `json:"healthy"`
	Temperature      int                `json:"temperature_celsius,omitempty"`
	PowerOnHours     uint64             `json:"power_on_hours,omitempty"`
	PowerCycleCount  uint64             `json:"power_cycle_count,omitempty"`
	RotationRate     uint32             `json:"rotation_rate,omitempty"` // 0 for SSDs, RPM for HDDs
	FormFactor       string             `json:"form_factor,omitempty"`   // 2.5", 3.5", M.2, etc.
	ATAVersion       string             `json:"ata_version,omitempty"`
	SATAVersion      string             `json:"sata_version,omitempty"`
	LocalTime        string             `json:"local_time,omitempty"`
	Attributes       map[string]string  `json:"attributes,omitempty"`
	DetailedAttribs  []SMARTAttribute   `json:"detailed_attributes,omitempty"`
	ErrorLog         *SMARTErrorLog     `json:"error_log,omitempty"`
	SelfTestLog      *SMARTSelfTestLog  `json:"self_test_log,omitempty"`
	HealthAssessment *SMARTHealthStatus `json:"health_assessment,omitempty"`
}

SMARTInfo contains SMART data for a drive

type SMARTSelfTest 

type SMARTSelfTest struct {
	TestNumber      uint64 `json:"test_number"`
	TestDescription string `json:"test_description"`
	Status          string `json:"status"`
	PercentComplete uint8  `json:"percent_complete"`
	LifetimeHours   uint64 `json:"lifetime_hours"`
	LBA             uint64 `json:"lba,omitempty"`
}

SMARTSelfTest represents a single self-test entry

type SMARTSelfTestLog 

type SMARTSelfTestLog struct {
	TestCount uint64          `json:"test_count"`
	Tests     []SMARTSelfTest `json:"tests,omitempty"`
}

SMARTSelfTestLog contains SMART self-test log information

type SystemData 

type SystemData struct {
	Hostname        string `json:"hostname"`
	OS              string `json:"os"`
	Platform        string `json:"platform"`
	PlatformFamily  string `json:"platform_family"`
	PlatformVersion string `json:"platform_version"`
	KernelVersion   string `json:"kernel_version"`
	KernelArch      string `json:"kernel_arch"`
	Uptime          uint64 `json:"uptime_seconds"`
	UptimeFormatted string `json:"uptime_formatted"`
	BootTime        uint64 `json:"boot_time"`
	Procs           uint64 `json:"processes"`
}

SystemData contains general system information

type SystemInfo 

type SystemInfo struct {
	Timestamp time.Time    `json:"timestamp"`
	System    *SystemData  `json:"system,omitempty"`
	CPU       *CPUData     `json:"cpu,omitempty"`
	Memory    *MemoryData  `json:"memory,omitempty"`
	Disk      *DiskData    `json:"disk,omitempty"`
	Network   *NetworkData `json:"network,omitempty"`
	Processes *ProcessData `json:"processes,omitempty"`
	GPU       *GPUData     `json:"gpu,omitempty"`
	Battery   *BatteryData `json:"battery,omitempty"`
}

SystemInfo holds all collected system information

type UPSInfo added in v1.0.3 

type UPSInfo struct {
	Name           string  `json:"name"`                          // UPS device name
	Model          string  `json:"model,omitempty"`               // UPS model
	Manufacturer   string  `json:"manufacturer,omitempty"`        // UPS manufacturer
	SerialNumber   string  `json:"serial_number,omitempty"`       // UPS serial number
	Status         string  `json:"status"`                        // Online, On Battery, Low Battery, etc.
	ChargeLevel    float64 `json:"charge_level_percent"`          // Battery charge level
	Load           float64 `json:"load_percent,omitempty"`        // Current load percentage
	Runtime        int64   `json:"runtime_minutes,omitempty"`     // Estimated runtime in minutes
	Voltage        float64 `json:"voltage_v,omitempty"`           // Input/output voltage
	Power          uint64  `json:"power_w,omitempty"`             // Power rating in watts
	BatteryVoltage float64 `json:"battery_voltage_v,omitempty"`   // Battery voltage
	Temperature    float64 `json:"temperature_celsius,omitempty"` // UPS temperature
}

UPSInfo contains information about an Uninterruptible Power Supply

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.