Documentation
¶
Index ¶
- func ParseSmartRawValueString(value string) (uint64, bool)
- type AtaDeviceStatistics
- type AtaDeviceStatisticsEntry
- type AtaDeviceStatisticsPage
- type AtaSmartAttribute
- type AtaSmartAttributes
- type DeviceInfo
- type NVMeSmartHealthInformationLog
- type PowerOnTimeScsi
- type RawValue
- type ScsiErrorCounter
- type ScsiErrorCounterLog
- type ScsiStartStopCycleCounter
- type SmartAttribute
- type SmartData
- type SmartDataResponse
- type SmartRawValue
- type SmartctlOutput
- type UserCapacity
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ParseSmartRawValueString ¶ added in v0.15.3
ParseSmartRawValueString attempts to extract a numeric value from the raw value strings emitted by smartctl, which sometimes include human-friendly annotations like "7344 (253d 8h)" or "0h+0m+0.000s". It returns the parsed value and a boolean indicating success.
Types ¶
type AtaDeviceStatistics ¶ added in v0.18.3
type AtaDeviceStatistics struct {
Pages []AtaDeviceStatisticsPage `json:"pages"`
}
type AtaDeviceStatisticsEntry ¶ added in v0.18.3
type AtaDeviceStatisticsPage ¶ added in v0.18.3
type AtaDeviceStatisticsPage struct {
Number uint8 `json:"number"`
Table []AtaDeviceStatisticsEntry `json:"table"`
}
type AtaSmartAttribute ¶
type AtaSmartAttributes ¶
type AtaSmartAttributes struct {
Table []AtaSmartAttribute `json:"table"`
}
type DeviceInfo ¶
type NVMeSmartHealthInformationLog ¶
type NVMeSmartHealthInformationLog struct {
CriticalWarning uint64 `json:"critical_warning"`
Temperature int64 `json:"temperature"`
AvailableSpare uint64 `json:"available_spare"`
AvailableSpareThreshold uint64 `json:"available_spare_threshold"`
PercentageUsed uint64 `json:"percentage_used"`
DataUnitsRead uint64 `json:"data_units_read"`
DataUnitsWritten uint64 `json:"data_units_written"`
HostReads uint64 `json:"host_reads"`
HostWrites uint64 `json:"host_writes"`
ControllerBusyTime uint64 `json:"controller_busy_time"`
PowerCycles uint64 `json:"power_cycles"`
PowerOnHours uint64 `json:"power_on_hours"`
UnsafeShutdowns uint64 `json:"unsafe_shutdowns"`
MediaErrors uint64 `json:"media_errors"`
NumErrLogEntries uint64 `json:"num_err_log_entries"`
WarningTempTime uint64 `json:"warning_temp_time"`
CriticalCompTime uint64 `json:"critical_comp_time"`
}
type PowerOnTimeScsi ¶ added in v0.15.1
type RawValue ¶
type RawValue struct {
Value SmartRawValue `json:"value"`
String string `json:"string"`
}
func (*RawValue) UnmarshalJSON ¶ added in v0.15.3
type ScsiErrorCounter ¶ added in v0.15.1
type ScsiErrorCounterLog ¶ added in v0.15.1
type ScsiErrorCounterLog struct {
Read ScsiErrorCounter `json:"read"`
Write ScsiErrorCounter `json:"write"`
Verify ScsiErrorCounter `json:"verify"`
}
type ScsiStartStopCycleCounter ¶ added in v0.15.1
type ScsiStartStopCycleCounter struct {
SpecifiedCycleCountOverDeviceLifetime uint64 `json:"specified_cycle_count_over_device_lifetime"`
AccumulatedStartStopCycles uint64 `json:"accumulated_start_stop_cycles"`
SpecifiedLoadUnloadCountOverDeviceLifetime uint64 `json:"specified_load_unload_count_over_device_lifetime"`
AccumulatedLoadUnloadCycles uint64 `json:"accumulated_load_unload_cycles"`
}
type SmartAttribute ¶
type SmartAttribute struct {
ID uint16 `json:"id,omitzero" cbor:"0,keyasint,omitempty"`
Name string `json:"n" cbor:"1,keyasint"`
Value uint16 `json:"v,omitzero" cbor:"2,keyasint,omitempty"`
Worst uint16 `json:"w,omitzero" cbor:"3,keyasint,omitempty"`
Threshold uint16 `json:"t,omitzero" cbor:"4,keyasint,omitempty"`
RawValue uint64 `json:"rv" cbor:"5,keyasint"`
RawString string `json:"rs,omitempty" cbor:"6,keyasint,omitempty"`
WhenFailed string `json:"wf,omitempty" cbor:"7,keyasint,omitempty"`
}
type SmartData ¶
type SmartData struct {
// ModelFamily string `json:"mf,omitempty" cbor:"0,keyasint,omitempty"`
ModelName string `json:"mn,omitempty" cbor:"1,keyasint,omitempty"`
SerialNumber string `json:"sn,omitempty" cbor:"2,keyasint,omitempty"`
FirmwareVersion string `json:"fv,omitempty" cbor:"3,keyasint,omitempty"`
Capacity uint64 `json:"c,omitzero" cbor:"4,keyasint,omitempty"`
SmartStatus string `json:"s,omitempty" cbor:"5,keyasint,omitempty"`
DiskName string `json:"dn,omitempty" cbor:"6,keyasint,omitempty"`
DiskType string `json:"dt,omitempty" cbor:"7,keyasint,omitempty"`
Temperature uint8 `json:"t,omitzero" cbor:"8,keyasint,omitempty"`
Attributes []*SmartAttribute `json:"a,omitempty" cbor:"9,keyasint,omitempty"`
}
type SmartDataResponse ¶ added in v0.18.8
type SmartDataResponse struct {
Data map[string]SmartData `json:"data" cbor:"0,keyasint"`
Complete bool `json:"complete" cbor:"1,keyasint,omitempty"` // Whether every discovered device was collected
}
SmartDataResponse contains the collected data and whether every discovered device was collected. Older agents omit Complete, so hubs must not prune from it.
type SmartRawValue ¶ added in v0.15.1
type SmartRawValue uint64
func (*SmartRawValue) UnmarshalJSON ¶ added in v0.15.1
func (v *SmartRawValue) UnmarshalJSON(data []byte) error
handles when drives report strings like "0h+0m+0.000s" or "7344 (253d 8h)" for power on hours
type SmartctlOutput ¶ added in v0.21.1
type SmartctlOutput struct {
Smartctl struct {
ExitStatus int `json:"exit_status"`
} `json:"smartctl"`
Device DeviceInfo `json:"device"`
ModelName string `json:"model_name"`
SerialNumber string `json:"serial_number"`
FirmwareVersion string `json:"firmware_version"`
UserCapacity UserCapacity `json:"user_capacity"`
SmartStatus struct {
Passed *bool `json:"passed"` // nil when smartctl could not read the health status
} `json:"smart_status"`
Temperature struct {
Current int64 `json:"current"`
} `json:"temperature"`
// ATA
AtaSmartAttributes *AtaSmartAttributes `json:"ata_smart_attributes"`
AtaDeviceStatistics json.RawMessage `json:"ata_device_statistics"` // decoded lazily, only when needed
// NVMe
NVMeTotalCapacity uint64 `json:"nvme_total_capacity"`
NVMeSmartHealthInformationLog *NVMeSmartHealthInformationLog `json:"nvme_smart_health_information_log"`
// SCSI (scsi_vendor/scsi_product are also reported for SATA disks behind SAT)
ScsiVendor string `json:"scsi_vendor"`
ScsiProduct string `json:"scsi_product"`
ScsiModelName string `json:"scsi_model_name"`
ScsiRevision string `json:"scsi_revision"`
PowerOnTime PowerOnTimeScsi `json:"power_on_time"`
ScsiStartStopCycleCounter ScsiStartStopCycleCounter `json:"scsi_start_stop_cycle_counter"`
ScsiGrownDefectList uint64 `json:"scsi_grown_defect_list"`
ScsiErrorCounterLog *ScsiErrorCounterLog `json:"scsi_error_counter_log"`
}
SmartctlOutput holds the fields we read from `smartctl -a --json` for any protocol. Sections that do not apply to a device are left nil or empty.
Counters use wide integer types on purpose: a value that overflows its Go type makes json.Unmarshal fail and drops the whole device (see #2484, #2582).