Documentation
¶
Overview ¶
Package sysfs provides functions to retrieve system and kernel metrics from the pseudo-filesystem sys.
Index ¶
- Constants
- type ClassThermalZoneStats
- type ClockSource
- type FS
- func (fs FS) ClockSources() ([]ClockSource, error)
- func (fs FS) NetClassDevices() ([]string, error)
- func (fs FS) NewClassThermalZoneStats() ([]ClassThermalZoneStats, error)
- func (fs FS) NewNetClass() (NetClass, error)
- func (fs FS) NewPowerSupplyClass() (PowerSupplyClass, error)
- func (fs FS) NewSystemCpufreq() ([]SystemCPUCpufreqStats, error)
- type NetClass
- type NetClassIface
- type PowerSupply
- type PowerSupplyClass
- type SystemCPUCpufreqStats
Constants ¶
const DefaultMountPoint = fs.DefaultSysMountPoint
DefaultMountPoint is the common mount point of the sys filesystem.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClassThermalZoneStats ¶
type ClassThermalZoneStats struct { Name string // The name of the zone from the directory structure. Type string // The type of thermal zone. Temp uint64 // Temperature in millidegree Celsius. Policy string // One of the various thermal governors used for a particular zone. Mode *bool // Optional: One of the predefined values in [enabled, disabled]. Passive *uint64 // Optional: millidegrees Celsius. (0 for disabled, > 1000 for enabled+value) }
ClassThermalZoneStats contains info from files in /sys/class/thermal/thermal_zone<zone> for a single <zone>. https://www.kernel.org/doc/Documentation/thermal/sysfs-api.txt
type ClockSource ¶
ClockSource contains metrics related to the clock source
type FS ¶
type FS struct {
// contains filtered or unexported fields
}
FS represents the pseudo-filesystem sys, which provides an interface to kernel data structures.
func NewFS ¶
NewFS returns a new FS mounted under the given mountPoint. It will error if the mount point can't be read.
func (FS) ClockSources ¶
func (fs FS) ClockSources() ([]ClockSource, error)
ClockSources returns clocksource information including current and available clocksources read from '/sys/devices/system/clocksource'
func (FS) NetClassDevices ¶
NetClassDevices scans /sys/class/net for devices and returns them as a list of names.
func (FS) NewClassThermalZoneStats ¶
func (fs FS) NewClassThermalZoneStats() ([]ClassThermalZoneStats, error)
NewClassThermalZoneStats returns Thermal Zone metrics for all zones.
func (FS) NewNetClass ¶
NewNetClass returns info for all net interfaces (iface) read from /sys/class/net/<iface>.
func (FS) NewPowerSupplyClass ¶
func (fs FS) NewPowerSupplyClass() (PowerSupplyClass, error)
NewPowerSupplyClass returns info for all power supplies read from /sys/class/power_supply/.
func (FS) NewSystemCpufreq ¶
func (fs FS) NewSystemCpufreq() ([]SystemCPUCpufreqStats, error)
NewSystemCpufreq returns CPU frequency metrics for all CPUs.
type NetClass ¶
type NetClass map[string]NetClassIface
NetClass is collection of info for every interface (iface) in /sys/class/net. The map keys are interface (iface) names.
func NewNetClass ¶
NewNetClass returns info for all net interfaces (iface) read from /sys/class/net/<iface>.
type NetClassIface ¶
type NetClassIface struct { Name string // Interface name AddrAssignType *int64 `fileName:"addr_assign_type"` // /sys/class/net/<iface>/addr_assign_type AddrLen *int64 `fileName:"addr_len"` // /sys/class/net/<iface>/addr_len Address string `fileName:"address"` // /sys/class/net/<iface>/address Broadcast string `fileName:"broadcast"` // /sys/class/net/<iface>/broadcast Carrier *int64 `fileName:"carrier"` // /sys/class/net/<iface>/carrier CarrierChanges *int64 `fileName:"carrier_changes"` // /sys/class/net/<iface>/carrier_changes CarrierUpCount *int64 `fileName:"carrier_up_count"` // /sys/class/net/<iface>/carrier_up_count CarrierDownCount *int64 `fileName:"carrier_down_count"` // /sys/class/net/<iface>/carrier_down_count DevID *int64 `fileName:"dev_id"` // /sys/class/net/<iface>/dev_id Dormant *int64 `fileName:"dormant"` // /sys/class/net/<iface>/dormant Duplex string `fileName:"duplex"` // /sys/class/net/<iface>/duplex Flags *int64 `fileName:"flags"` // /sys/class/net/<iface>/flags IfAlias string `fileName:"ifalias"` // /sys/class/net/<iface>/ifalias IfIndex *int64 `fileName:"ifindex"` // /sys/class/net/<iface>/ifindex IfLink *int64 `fileName:"iflink"` // /sys/class/net/<iface>/iflink LinkMode *int64 `fileName:"link_mode"` // /sys/class/net/<iface>/link_mode MTU *int64 `fileName:"mtu"` // /sys/class/net/<iface>/mtu NameAssignType *int64 `fileName:"name_assign_type"` // /sys/class/net/<iface>/name_assign_type NetDevGroup *int64 `fileName:"netdev_group"` // /sys/class/net/<iface>/netdev_group OperState string `fileName:"operstate"` // /sys/class/net/<iface>/operstate PhysPortID string `fileName:"phys_port_id"` // /sys/class/net/<iface>/phys_port_id PhysPortName string `fileName:"phys_port_name"` // /sys/class/net/<iface>/phys_port_name PhysSwitchID string `fileName:"phys_switch_id"` // /sys/class/net/<iface>/phys_switch_id Speed *int64 `fileName:"speed"` // /sys/class/net/<iface>/speed TxQueueLen *int64 `fileName:"tx_queue_len"` // /sys/class/net/<iface>/tx_queue_len Type *int64 `fileName:"type"` // /sys/class/net/<iface>/type }
NetClassIface contains info from files in /sys/class/net/<iface> for single interface (iface).
type PowerSupply ¶
type PowerSupply struct { Name string // Power Supply Name Authentic *int64 `fileName:"authentic"` // /sys/class/power_suppy/<Name>/authentic Calibrate *int64 `fileName:"calibrate"` // /sys/class/power_suppy/<Name>/calibrate Capacity *int64 `fileName:"capacity"` // /sys/class/power_suppy/<Name>/capacity CapacityAlertMax *int64 `fileName:"capacity_alert_max"` // /sys/class/power_suppy/<Name>/capacity_alert_max CapacityAlertMin *int64 `fileName:"capacity_alert_min"` // /sys/class/power_suppy/<Name>/capacity_alert_min CapacityLevel string `fileName:"capacity_level"` // /sys/class/power_suppy/<Name>/capacity_level ChargeAvg *int64 `fileName:"charge_avg"` // /sys/class/power_suppy/<Name>/charge_avg ChargeControlLimit *int64 `fileName:"charge_control_limit"` // /sys/class/power_suppy/<Name>/charge_control_limit ChargeControlLimitMax *int64 `fileName:"charge_control_limit_max"` // /sys/class/power_suppy/<Name>/charge_control_limit_max ChargeCounter *int64 `fileName:"charge_counter"` // /sys/class/power_suppy/<Name>/charge_counter ChargeEmpty *int64 `fileName:"charge_empty"` // /sys/class/power_suppy/<Name>/charge_empty ChargeEmptyDesign *int64 `fileName:"charge_empty_design"` // /sys/class/power_suppy/<Name>/charge_empty_design ChargeFull *int64 `fileName:"charge_full"` // /sys/class/power_suppy/<Name>/charge_full ChargeFullDesign *int64 `fileName:"charge_full_design"` // /sys/class/power_suppy/<Name>/charge_full_design ChargeNow *int64 `fileName:"charge_now"` // /sys/class/power_suppy/<Name>/charge_now ChargeTermCurrent *int64 `fileName:"charge_term_current"` // /sys/class/power_suppy/<Name>/charge_term_current ChargeType string `fileName:"charge_type"` // /sys/class/power_supply/<Name>/charge_type ConstantChargeCurrent *int64 `fileName:"constant_charge_current"` // /sys/class/power_suppy/<Name>/constant_charge_current ConstantChargeCurrentMax *int64 `fileName:"constant_charge_current_max"` // /sys/class/power_suppy/<Name>/constant_charge_current_max ConstantChargeVoltage *int64 `fileName:"constant_charge_voltage"` // /sys/class/power_suppy/<Name>/constant_charge_voltage ConstantChargeVoltageMax *int64 `fileName:"constant_charge_voltage_max"` // /sys/class/power_suppy/<Name>/constant_charge_voltage_max CurrentAvg *int64 `fileName:"current_avg"` // /sys/class/power_suppy/<Name>/current_avg CurrentBoot *int64 `fileName:"current_boot"` // /sys/class/power_suppy/<Name>/current_boot CurrentMax *int64 `fileName:"current_max"` // /sys/class/power_suppy/<Name>/current_max CurrentNow *int64 `fileName:"current_now"` // /sys/class/power_suppy/<Name>/current_now CycleCount *int64 `fileName:"cycle_count"` // /sys/class/power_suppy/<Name>/cycle_count EnergyAvg *int64 `fileName:"energy_avg"` // /sys/class/power_supply/<Name>/energy_avg EnergyEmpty *int64 `fileName:"energy_empty"` // /sys/class/power_suppy/<Name>/energy_empty EnergyEmptyDesign *int64 `fileName:"energy_empty_design"` // /sys/class/power_suppy/<Name>/energy_empty_design EnergyFull *int64 `fileName:"energy_full"` // /sys/class/power_suppy/<Name>/energy_full EnergyFullDesign *int64 `fileName:"energy_full_design"` // /sys/class/power_suppy/<Name>/energy_full_design EnergyNow *int64 `fileName:"energy_now"` // /sys/class/power_supply/<Name>/energy_now Health string `fileName:"health"` // /sys/class/power_suppy/<Name>/health InputCurrentLimit *int64 `fileName:"input_current_limit"` // /sys/class/power_suppy/<Name>/input_current_limit Manufacturer string `fileName:"manufacturer"` // /sys/class/power_suppy/<Name>/manufacturer ModelName string `fileName:"model_name"` // /sys/class/power_suppy/<Name>/model_name Online *int64 `fileName:"online"` // /sys/class/power_suppy/<Name>/online PowerAvg *int64 `fileName:"power_avg"` // /sys/class/power_suppy/<Name>/power_avg PowerNow *int64 `fileName:"power_now"` // /sys/class/power_suppy/<Name>/power_now PrechargeCurrent *int64 `fileName:"precharge_current"` // /sys/class/power_suppy/<Name>/precharge_current Present *int64 `fileName:"present"` // /sys/class/power_suppy/<Name>/present Scope string `fileName:"scope"` // /sys/class/power_suppy/<Name>/scope SerialNumber string `fileName:"serial_number"` // /sys/class/power_suppy/<Name>/serial_number Status string `fileName:"status"` // /sys/class/power_supply/<Name>/status Technology string `fileName:"technology"` // /sys/class/power_suppy/<Name>/technology Temp *int64 `fileName:"temp"` // /sys/class/power_suppy/<Name>/temp TempAlertMax *int64 `fileName:"temp_alert_max"` // /sys/class/power_suppy/<Name>/temp_alert_max TempAlertMin *int64 `fileName:"temp_alert_min"` // /sys/class/power_suppy/<Name>/temp_alert_min TempAmbient *int64 `fileName:"temp_ambient"` // /sys/class/power_suppy/<Name>/temp_ambient TempAmbientMax *int64 `fileName:"temp_ambient_max"` // /sys/class/power_suppy/<Name>/temp_ambient_max TempAmbientMin *int64 `fileName:"temp_ambient_min"` // /sys/class/power_suppy/<Name>/temp_ambient_min TempMax *int64 `fileName:"temp_max"` // /sys/class/power_suppy/<Name>/temp_max TempMin *int64 `fileName:"temp_min"` // /sys/class/power_suppy/<Name>/temp_min TimeToEmptyAvg *int64 `fileName:"time_to_empty_avg"` // /sys/class/power_suppy/<Name>/time_to_empty_avg TimeToEmptyNow *int64 `fileName:"time_to_empty_now"` // /sys/class/power_suppy/<Name>/time_to_empty_now TimeToFullAvg *int64 `fileName:"time_to_full_avg"` // /sys/class/power_suppy/<Name>/time_to_full_avg TimeToFullNow *int64 `fileName:"time_to_full_now"` // /sys/class/power_suppy/<Name>/time_to_full_now Type string `fileName:"type"` // /sys/class/power_supply/<Name>/type UsbType string `fileName:"usb_type"` // /sys/class/power_supply/<Name>/usb_type VoltageAvg *int64 `fileName:"voltage_avg"` // /sys/class/power_supply/<Name>/voltage_avg VoltageBoot *int64 `fileName:"voltage_boot"` // /sys/class/power_suppy/<Name>/voltage_boot VoltageMax *int64 `fileName:"voltage_max"` // /sys/class/power_suppy/<Name>/voltage_max VoltageMaxDesign *int64 `fileName:"voltage_max_design"` // /sys/class/power_suppy/<Name>/voltage_max_design VoltageMin *int64 `fileName:"voltage_min"` // /sys/class/power_suppy/<Name>/voltage_min VoltageMinDesign *int64 `fileName:"voltage_min_design"` // /sys/class/power_suppy/<Name>/voltage_min_design VoltageNow *int64 `fileName:"voltage_now"` // /sys/class/power_supply/<Name>/voltage_now VoltageOCV *int64 `fileName:"voltage_ocv"` // /sys/class/power_suppy/<Name>/voltage_ocv }
PowerSupply contains info from files in /sys/class/power_supply for a single power supply.
type PowerSupplyClass ¶
type PowerSupplyClass map[string]PowerSupply
PowerSupplyClass is a collection of every power supply in /sys/class/power_supply/. The map keys are the names of the power supplies.
func NewPowerSupplyClass ¶
func NewPowerSupplyClass() (PowerSupplyClass, error)
NewPowerSupplyClass returns info for all power supplies read from /sys/class/power_supply/.
type SystemCPUCpufreqStats ¶
type SystemCPUCpufreqStats struct { Name string CpuinfoCurrentFrequency *uint64 CpuinfoMinimumFrequency *uint64 CpuinfoMaximumFrequency *uint64 CpuinfoTransitionLatency *uint64 ScalingCurrentFrequency *uint64 ScalingMinimumFrequency *uint64 ScalingMaximumFrequency *uint64 AvailableGovernors string Driver string Governor string RelatedCpus string SetSpeed string }
SystemCPUCpufreqStats contains stats from devices/system/cpu/cpu[0-9]*/cpufreq/...
func NewSystemCpufreq ¶
func NewSystemCpufreq() ([]SystemCPUCpufreqStats, error)
NewSystemCpufreq returns CPU frequency metrics for all CPUs.