home-assistant.io/source/_integrations/systemmonitor.markdown
2024-01-31 09:25:34 +01:00

2.4 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_config_flow, ha_platforms, ha_integration_type, ha_codeowners
title description ha_category ha_release ha_iot_class ha_domain ha_config_flow ha_platforms ha_integration_type ha_codeowners
System monitor Instructions on how to monitor the Home Assistant host.
System monitor
pre 0.7 Local Push systemmonitor true
sensor
integration
@gjohansson-ST

The System monitor integration allows you to monitor disk usage, memory usage, CPU usage, and running processes.

{% include integrations/config_flow.md %}

Sensors

All entities are disabled by default, you need to enable the entities that you wish to use.

Disks

  • Disk free - (One per disk/mount point)
  • Disk use - (One per disk/mount point)
  • Disk usage (percent) - (One per disk/mount point)

Network

  • IPv4 address - (One per network interface)
  • IPv6 address - (One per network interface)
  • Network in - (One per network interface)
  • Network out - (One per network interface)
  • Packets in - (One per network interface)
  • Packets out - (One per network interface)
  • Network throughput in - (One per network interface)
  • Network throughput out - (One per network interface)

Other

  • Last boot
  • Load (15m)
  • Load (5m)
  • Load (1m)
  • Memory free
  • Memory use
  • Memory usage (percent)
  • Processor use
  • Processor temperature
  • Swap free
  • Swap use
  • Swap usage (percent)

Add process sensor

The process sensor needs to be configured by the config entry options. Go to {% my integrations title="Settings > Devices & Services" %}, select the System Monitor integration and click Configure to select which process sensors should be created.

Disk usage

Note: The disk usage sensors do not support monitoring folder/directory sizes. Instead, it is only concerned with "disks" (more specifically mount points on Linux).

$ df -H
Filesystem      Size  Used Avail Use% Mounted on
/dev/root        29G   12G   16G  42% /
devtmpfs        805M     0  805M   0% /dev
tmpfs           934M     0  934M   0% /dev/shm
/dev/mmcblk0p1  253M   54M  199M  22% /boot

Processor temperature

  • If no hardware sensor data is available (e.g., because the integration runs in a virtualized environment), the sensor entity will not be created.
  • The unit of measurement (Celsius vs. Fahrenheit) will be chosen based on the system configuration.
  • Only the very first processor related hardware sensor is read, i.e. no individual core temperatures are available (even if the hardware sensor provides that level of detail).