// Copyright 2022 The Prometheus Authors // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package main import ( "fmt" "io/ioutil" "os" "os/exec" "strings" "time" "github.com/tidwall/gjson" ) // JSONCache caching json type JSONCache struct { JSON gjson.Result LastCollect time.Time } var ( jsonCache map[string]JSONCache ) func init() { jsonCache = make(map[string]JSONCache) } // Parse json to gjson object func parseJSON(data string) gjson.Result { if !gjson.Valid(data) { return gjson.Parse("{}") } return gjson.Parse(data) } // Reading fake smartctl json func readFakeSMARTctl(device string) gjson.Result { s := strings.Split(device, "/") filename := fmt.Sprintf("debug/%s.json", s[len(s)-1]) logger.Verbose("Read fake S.M.A.R.T. data from json: %s", filename) jsonFile, err := ioutil.ReadFile(filename) if err != nil { logger.Error("Fake S.M.A.R.T. data reading error: %s", err) return parseJSON("{}") } return parseJSON(string(jsonFile)) } // Get json from smartctl and parse it func readSMARTctl(device string) (gjson.Result, bool) { logger.Debug("Collecting S.M.A.R.T. counters, device: %s", device) out, err := exec.Command(options.SMARTctl.SMARTctlLocation, "--json", "--xall", device).Output() if err != nil { logger.Warning("S.M.A.R.T. output reading error: %s", err) } json := parseJSON(string(out)) rcOk := resultCodeIsOk(json.Get("smartctl.exit_status").Int()) jsonOk := jsonIsOk(json) return json, rcOk && jsonOk } func readSMARTctlDevices() gjson.Result { logger.Debug("Collecting devices") out, err := exec.Command(options.SMARTctl.SMARTctlLocation, "--json", "--scan-open").Output() if err != nil { logger.Warning("S.M.A.R.T. output reading error: %s", err) } return parseJSON(string(out)) } // Select json source and parse func readData(device string) (gjson.Result, error) { if options.SMARTctl.FakeJSON { return readFakeSMARTctl(device), nil } if _, err := os.Stat(device); err == nil { cacheValue, cacheOk := jsonCache[device] if !cacheOk || time.Now().After(cacheValue.LastCollect.Add(options.SMARTctl.CollectPeriodDuration)) { json, ok := readSMARTctl(device) if ok { jsonCache[device] = JSONCache{JSON: json, LastCollect: time.Now()} return jsonCache[device].JSON, nil } return gjson.Parse("{}"), fmt.Errorf("smartctl returned bad data for device %s", device) } return cacheValue.JSON, nil } return gjson.Parse("{}"), fmt.Errorf("Device %s unavialable", device) } // Parse smartctl return code func resultCodeIsOk(SMARTCtlResult int64) bool { result := true if SMARTCtlResult > 0 { b := SMARTCtlResult if (b & 1) != 0 { logger.Error("Command line did not parse.") result = false } if (b & (1 << 1)) != 0 { logger.Error("Device open failed, device did not return an IDENTIFY DEVICE structure, or device is in a low-power mode") result = false } if (b & (1 << 2)) != 0 { logger.Warning("Some SMART or other ATA command to the disk failed, or there was a checksum error in a SMART data structure") } if (b & (1 << 3)) != 0 { logger.Warning("SMART status check returned 'DISK FAILING'.") } if (b & (1 << 4)) != 0 { logger.Warning("We found prefail Attributes <= threshold.") } if (b & (1 << 5)) != 0 { logger.Warning("SMART status check returned 'DISK OK' but we found that some (usage or prefail) Attributes have been <= threshold at some time in the past.") } if (b & (1 << 6)) != 0 { logger.Warning("The device error log contains records of errors.") } if (b & (1 << 7)) != 0 { logger.Warning("The device self-test log contains records of errors. [ATA only] Failed self-tests outdated by a newer successful extended self-test are ignored.") } } return result } // Check json func jsonIsOk(json gjson.Result) bool { messages := json.Get("smartctl.messages") // logger.Debug(messages.String()) if messages.Exists() { for _, message := range messages.Array() { if message.Get("severity").String() == "error" { logger.Error(message.Get("string").String()) return false } } } return true }