logparse / parsers / temperature.pyon commit add journald communication capability (7351cf6)
   1#
   2#   temperature.py
   3#   
   4#   Find current temperature of various system components (CPU, motherboard,
   5#   hard drives, ambient). Detection of motherboard-based temperatures (CPU
   6#   etc) uses the pysensors library, and produces a similar output to
   7#   lmsensors. HDD temperatures are obtained from the hddtemp daemon
   8#   (http://www.guzu.net/linux/hddtemp.php) which was orphaned since 2007. For
   9#   hddtemp to work, it must be started in daemon mode, either manually or with
  10#   a unit file. Manually, it would be started like this:
  11#
  12#       sudo hddtemp -d /dev/sda /dev/sdb ... /dev/sdX
  13#
  14
  15import re
  16import sensors
  17import socket, sys
  18from telnetlib import Telnet
  19from typing import List, Dict, NamedTuple
  20
  21from logparse import formatting
  22from ..formatting import *
  23from ..util import readlog, resolve
  24from ..config import * 
  25
  26import logging
  27logger = logging.getLogger(__name__)
  28
  29class Drive(NamedTuple):
  30    path: str
  31    model: str
  32    temperature: int
  33    units: str
  34
  35class HddtempClient:
  36
  37    def __init__(self, host: str='127.0.0.1', port: int=7634, timeout: int=10, sep: str='|') -> None:
  38        self.host = host
  39        self.port = port
  40        self.timeout = timeout
  41        self.sep = sep
  42
  43    def _parse_drive(self, drive: str) -> Drive:
  44        try:
  45            drive_data = drive.split(self.sep)
  46            return Drive(drive_data[0], drive_data[1], int(drive_data[2]), drive_data[3])
  47        except Exception as e:
  48            logger.warning("Error processing drive: {0}".format(str(drive_data)))
  49            return None
  50
  51    def _parse(self, data: str) -> List[Drive]:
  52        line = data.lstrip(self.sep).rstrip(self.sep)   # Remove first/last
  53        drives = line.split(self.sep * 2)
  54        parsed_drives = []
  55        for drive in drives:
  56            parsed_drive = self._parse_drive(drive)
  57            if parsed_drive != None:
  58                parsed_drives.append(parsed_drive)
  59
  60#        return [self._parse_drive(drive) for drive in drives if drive != None]
  61#        return list(filter(lambda drive: self._parse_drive(drive), drives))
  62        return parsed_drives
  63
  64    def get_drives(self) -> List[Drive]:    # Obtain data from telnet server
  65        try:
  66            with Telnet(self.host, self.port, timeout=self.timeout) as tn:
  67                raw_data = tn.read_all()
  68            return self._parse(raw_data.decode('ascii'))    # Return parsed data
  69        except Exception as e:
  70            logger.warning("Couldn't read data from {0}:{1} - {2}".format(self.host, self.port, str(e)))
  71            return 1
  72
  73
  74def parse_log():
  75
  76    logger.debug("Starting temp section")
  77    section = Section("temperatures")
  78
  79    sensors.init()
  80
  81    systemp = Data("Sys", [])
  82    coretemp = Data("Cores", [])
  83    pkgtemp = Data("Processor", [])
  84
  85    try:
  86        for chip in sensors.iter_detected_chips():
  87            for feature in chip:
  88                if "Core" in feature.label:
  89                    coretemp.items.append([feature.label, float(feature.get_value())])
  90                    continue
  91                if "CPUTIN" in feature.label:
  92                    pkgtemp.items.append([feature.label, float(feature.get_value())])
  93                    continue
  94                if "SYS" in feature.label:
  95                    systemp.items.append([feature.label, float(feature.get_value())])
  96                    continue
  97
  98        logger.debug("Core data is {0}".format(str(coretemp.items)))
  99        logger.debug("Sys data is {0}".format(str(systemp.items)))
 100        logger.debug("Pkg data is {0}".format(str(pkgtemp.items)))
 101        for temp_data in [systemp, coretemp, pkgtemp]:
 102            logger.debug("Looking at temp data {0}".format(str(temp_data.items)))
 103            if len(temp_data.items) > 1:
 104                avg = float(sum(feature[1] for feature in temp_data.items)) / len(temp_data.items)
 105                logger.debug("Avg temp for {0} is {1} {2}{3}".format(temp_data.subtitle, str(avg), DEG, CEL))
 106                temp_data.subtitle += " (avg {0}{1}{2})".format(str(avg), DEG, CEL)
 107                temp_data.items = ["{0}: {1}{2}{3}".format(feature[0], str(feature[1]), DEG, CEL) for feature in temp_data.items]
 108            else:
 109                temp_data.items = [str(temp_data.items[0][1]) + DEG + CEL]
 110            section.append_data(temp_data)
 111
 112    finally:
 113        logger.info("Finished reading onboard temperatures")
 114        sensors.cleanup()
 115
 116
 117    # drive temp
 118
 119    # For this to work, `hddtemp` must be running in daemon mode.
 120    # Start it like this (bash):   sudo hddtemp -d /dev/sda /dev/sdX...
 121    
 122    received = ''
 123    sumtemp = 0.0 
 124    data = ""
 125    hddtemp_data = Data("Disks")
 126    
 127    client = HddtempClient(host=config.prefs['hddtemp']['host'], port=int(config.prefs['hddtemp']['port']), sep=config.prefs['hddtemp']['separator'], timeout=int(config.prefs['hddtemp']['timeout']))
 128    drives = client.get_drives()
 129    logger.debug("Received drive info: " + str(drives))
 130
 131    for drive in sorted(drives, key=lambda x: x.path):
 132        if drive.path in config.prefs['hddtemp']['drives']:
 133            sumtemp += drive.temperature
 134            hddtemp_data.items.append(("{0} ({1})".format(drive.path, drive.model) if config.prefs['hddtemp']['show-model'] else drive.path) + ": {0}{1}{2}".format(drive.temperature, DEG, drive.units))
 135        else:
 136            drives.remove(drive)
 137            logger.debug("Ignoring drive {0} ({1}) due to config".format(drive.path, drive.model))
 138    logger.debug("Sorted drive info: " + str(drives))
 139
 140    hddavg = '{0:.1f}{1}{2}'.format(sumtemp/len(drives), DEG, drives[0].units) # use units of first drive
 141    logger.debug("Sum of temperatures: {}; Number of drives: {}; => Avg disk temp is {}".format(str(sumtemp), str(len(drives)), hddavg)) 
 142    hddtemp_data.subtitle += " (avg {0}{1}{2})".format(str(hddavg), DEG, CEL)
 143
 144    logger.info("Finished processing drive temperatures")
 145
 146    logger.info("Finished temp section")
 147    return section