Server Status

This program sends machine status messages to an MQTT broker.

Currently, this program supports sending the following machine status information:

• Processor use (in percentage)
• Processor temperature
• RAM use (in megabytes)
• Disk use (in percentage, multiple disk paths can be specified)
• Last boot time
• Machine hostname

Requirements

• Rust and cargo if you want to build from source. Otherwise, binaries can be downloaded from this Github repo.

Installation

Clone this repo somewhere on the host machine and run the following in that directory.

cargo install --path /desired/install/location

This will build and install the program.

You can then install a systemd service and enable it on your system. This will run the program and set it to persist through reboots.

make deploy
systemctl enable --now server-status-mqtt.service

Usage

Messages will be published with the following topics:

server_status/<hostname_of_machine>/processor_use
server_status/<hostname_of_machine>/processor_temperature
server_status/<hostname_of_machine>/memory_use
server_status/<hostname_of_machine>/disk_use_percent_disk<number>
server_status/<hostname_of_machine>/last_boot

(disk_use_percent_disk<number> will be numbered in the order in which the paths are specified in config.yaml.)

Configuration

All configuration information is set in config.yaml. The program will look for this file in /etc/server-status/. Rename the config-example.yaml file and adjust the values as necessary.

Boolean values must be set to determine which messages you would like to be sent. If a key is missing, it will be assumed false.

Additionally, you can specify which disk paths are to be used for calculating disk use percent with the tuple DISK_PATHS. The default is /, the root directory of the system. Specifying a subdirectory of / which is on the same disk partition will return the same value as /.

To find the paths to available partitions on your system, run df and look at the "Mounted on" column:

Filesystem     1K-blocks      Used Available Use% Mounted on
dev             32847328         0  32847328   0% /dev
run             32857084      1992  32855092   1% /run
/dev/nvme0n1p2 888837712 661256828 182356664  79% /
tmpfs           32857084    428040  32429044   2% /dev/shm
tmpfs           32857088     64836  32792252   1% /tmp
/dev/nvme0n1p1    306572       296    306276   1% /boot/efi
tmpfs            6571416       360   6571056   1% /run/user/1000

Home Assistant Integration

These MQTT messages can be used to create custom sensors in Home Assistant.

The following template can be added to your configuration.yaml file to create an MQTT sensor.

mqtt:
  sensor:
    - name: "Server1 disk use percent"
      state_topic: "server_status/server1/disk_use_percent_disk1"
      unit_of_measurement: "%"
      icon: mdi:harddisk
    - name: "Server1 memory use"
      state_topic: "server_status/server1/memory_use"
      unit_of_measurement: "MB"
      icon: mdi:memory