Skip to content

DiskIO values as extra attributes in Disk Entity #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lockenkop wants to merge 6 commits into
base: main
Choose a base branch
from
Open

DiskIO values as extra attributes in Disk Entity #87

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
677074d
firt mock for smart values in disk
Dec 10, 2023
2640453
fix write count typo
lockenkop Dec 11, 2023
6ae4979
have linux use partitionnames as devnames
Dec 12, 2023
940d766
ensure only linux does diskio
Dec 12, 2023
a11321a
Merge branch 'richibrics:main' into diskio
lockenkop Jun 30, 2024
259fa00
Valueformatteroptions, formatting, calculate red/write-rates
Jun 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
207 changes: 175 additions & 32 deletions IoTuring/Entity/Deployments/Disk/Disk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import psutil
from time import time

from IoTuring.Entity.Entity import Entity
from IoTuring.Entity.EntityData import EntitySensor
from IoTuring.Configurator.MenuPreset import MenuPreset
Expand All @@ -8,27 +10,49 @@
KEY_USED_PERCENTAGE = "space_used_percentage"
CONFIG_KEY_DU_PATH = "path"

CONFIG_KEY_DISKIO = "IO"

EXTRA_KEY_DISK_MOUNTPOINT = "Mountpoint"
EXTRA_KEY_DISK_FSTYPE = "Filesystem"
EXTRA_KEY_DISK_DEVICE = "Device"
EXTRA_KEY_DISK_TOTAL = "Total"
EXTRA_KEY_DISK_USED = "Used"
EXTRA_KEY_DISK_FREE = "Free"
EXTRA_KEY_DISK_READ_COUNT = "Read count"
EXTRA_KEY_DISK_WRITE_COUNT = "Write count"
EXTRA_KEY_DISK_READ_BYTES = "Read bytes"
EXTRA_KEY_DISK_WRITE_BYTES = "Write bytes"
EXTRA_KEY_DISK_READ_TIME = "Read time"
EXTRA_KEY_DISK_WRTIE_TIME = "Write time"
EXTRA_KEY_DISK_READ_RATE = "Read rate"
EXTRA_KEY_DISK_WRITE_RATE = "Write rate"
EXTRA_KEY_DISK_READ_MERGED_COUNT = "Read merged count"
EXTRA_KEY_DISK_WRITE_MERGED_COUNT = "Write merged count"
EXTRA_KEY_DISK_BUSY_TIME = "Busy time"

VALUEFORMATOPTIONS_DISK_GB = ValueFormatterOptions(
ValueFormatterOptions.TYPE_BYTE, 0, "GB")

VALUEFORMATOPTIONS_GB = ValueFormatterOptions(ValueFormatterOptions.TYPE_BYTE, 0, "GB")

DEFAULT_PATH = {
OsD.WINDOWS: "C:\\",
OsD.MACOS: "/",
OsD.LINUX: "/"
}
VALUEFORMATOPTIONS_B = ValueFormatterOptions(ValueFormatterOptions.TYPE_BYTE, 0, "B")

VALUEFORMATOPTIONS_TIME = ValueFormatterOptions(
ValueFormatterOptions.TYPE_TIME, 0, "ms"
)

VALUEFORMATOPTIONS_PERCENT = ValueFormatterOptions(
ValueFormatterOptions.TYPE_PERCENTAGE, 1, "%"
)

VALUEFORMATOPTIONS_BpS = ValueFormatterOptions(
ValueFormatterOptions.TYPE_BYTE_PER_SECOND, 0, "B/s"
)

DEFAULT_PATH = {OsD.WINDOWS: "C:\\", OsD.MACOS: "/", OsD.LINUX: "/"}

DISK_CHOICE_STRING = {
OsD.WINDOWS: "Drive with Driveletter {}",
OsD.MACOS: "{}, mounted in {}",
OsD.LINUX: "{}, mounted in {}"
OsD.LINUX: "{}, mounted in {}",
}


Expand All @@ -37,15 +61,21 @@ class Disk(Entity):
ALLOW_MULTI_INSTANCE = True

def Initialize(self) -> None:
"""Initialise the DiskUsage Entity and Register it
"""
"""Initialise the DiskUsage Entity and Register it"""

self.configuredPath = self.GetFromConfigurations(CONFIG_KEY_DU_PATH)
self.configuredIo = self.GetFromConfigurations(CONFIG_KEY_DISKIO)
self.lastUpdate = ""

try:
# Get partision info for extra attributes:
# Get partition info for extra attributes:
self.disk_partition = next(
(d for d in psutil.disk_partitions() if d.mountpoint == self.configuredPath))
(
d
for d in psutil.disk_partitions()
if d.mountpoint == self.configuredPath
)
)
except StopIteration:
raise Exception(f"Device not found: {self.configuredPath}")

Expand All @@ -56,70 +86,183 @@ def Initialize(self) -> None:
supportsExtraAttributes=True,
valueFormatterOptions=ValueFormatterOptions(
ValueFormatterOptions.TYPE_PERCENTAGE
)
),
)
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_MOUNTPOINT,
attributeValue=self.disk_partition.mountpoint)
attributeValue=self.disk_partition.mountpoint,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_FSTYPE,
attributeValue=self.disk_partition.fstype)
attributeValue=self.disk_partition.fstype,
)

if not OsD.IsWindows():
self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_DEVICE,
attributeValue=self.disk_partition.device)
attributeValue=self.disk_partition.device,
)

def Update(self) -> None:
"""UpdateMethod, psutil does not need separate behaviour on any os
"""
"""UpdateMethod, psutil does not need separate behaviour on any os"""

usage = psutil.disk_usage(self.configuredPath)

self.SetEntitySensorValue(
key=KEY_USED_PERCENTAGE,
value=usage.percent)
self.SetEntitySensorValue(key=KEY_USED_PERCENTAGE, value=usage.percent)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_TOTAL,
attributeValue=usage.total,
valueFormatterOptions=VALUEFORMATOPTIONS_DISK_GB)
valueFormatterOptions=VALUEFORMATOPTIONS_GB,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_USED,
attributeValue=usage.used,
valueFormatterOptions=VALUEFORMATOPTIONS_DISK_GB)
valueFormatterOptions=VALUEFORMATOPTIONS_GB,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_FREE,
attributeValue=usage.free,
valueFormatterOptions=VALUEFORMATOPTIONS_DISK_GB)
valueFormatterOptions=VALUEFORMATOPTIONS_GB,
)

if self.configuredIo and OsD.IsLinux():
# the following are supported on nearly every OS, Windows drivenames/devnames are complicated, so no Windows support

devname = self.disk_partition.device.split("/")[-1]
disk_io: psutil._common.sdiskio = psutil.disk_io_counters(perdisk=True)[
devname
]
currentTime = time()
if self.lastUpdate:
timeSinceLastUpdate = currentTime - self.lastUpdate
readrate = (
disk_io.read_bytes - self.lastReadBytes
) / timeSinceLastUpdate
writerate = (
disk_io.write_bytes - self.lastWriteBytes
) / timeSinceLastUpdate
else:
readrate = 0
writerate = 0

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_READ_COUNT,
attributeValue=disk_io.read_count,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_WRITE_COUNT,
attributeValue=disk_io.write_count,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_READ_BYTES,
attributeValue=disk_io.read_bytes,
valueFormatterOptions=VALUEFORMATOPTIONS_B,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_WRITE_BYTES,
attributeValue=disk_io.write_bytes,
valueFormatterOptions=VALUEFORMATOPTIONS_B,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_READ_TIME,
attributeValue=disk_io.read_time,
valueFormatterOptions=VALUEFORMATOPTIONS_TIME,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_WRTIE_TIME,
attributeValue=disk_io.write_time,
valueFormatterOptions=VALUEFORMATOPTIONS_TIME,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_READ_RATE,
attributeValue=readrate,
valueFormatterOptions=VALUEFORMATOPTIONS_BpS,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_WRITE_RATE,
attributeValue=writerate,
valueFormatterOptions=VALUEFORMATOPTIONS_BpS,
)

# the following are only supported in linux
self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_READ_MERGED_COUNT,
attributeValue=disk_io.read_merged_count,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_WRITE_MERGED_COUNT,
attributeValue=disk_io.write_merged_count,
)

self.SetEntitySensorExtraAttribute(
sensorDataKey=KEY_USED_PERCENTAGE,
attributeKey=EXTRA_KEY_DISK_BUSY_TIME,
attributeValue=disk_io.busy_time,
valueFormatterOptions=VALUEFORMATOPTIONS_TIME,
)

self.lastUpdate = time()
self.lastReadBytes = disk_io.read_bytes
self.lastWriteBytes = disk_io.write_bytes

@classmethod
def ConfigurationPreset(cls) -> MenuPreset:

# Get the choices for menu:
DISK_CHOICES = []

for disk in psutil.disk_partitions():
DISK_CHOICES.append(
{"name":
DISK_CHOICE_STRING[OsD.GetOs()].format(
disk.device, disk.mountpoint),
"value": disk.mountpoint}
{
"name": DISK_CHOICE_STRING[OsD.GetOs()].format(
disk.device, disk.mountpoint
),
"value": disk.mountpoint,
}
)

preset = MenuPreset()
preset.AddEntry(name="Drive to check",
key=CONFIG_KEY_DU_PATH, mandatory=False,
question_type="select", choices=DISK_CHOICES)
preset.AddEntry(
name="Drive to check",
key=CONFIG_KEY_DU_PATH,
mandatory=True,
question_type="select",
choices=DISK_CHOICES,
)
if OsD.IsLinux():
preset.AddEntry(
name="Update DiskIO",
key=CONFIG_KEY_DISKIO,
mandatory=True,
question_type="yesno",
)
return preset