Glances


The glances sensor platform is consuming the system information provided by the Glances API. This enables one to track remote host and display their stats in Home Assistant.

Setup

This sensors needs a running instance of glances on the host. The minimal supported version of glances is 2.3. To start a Glances RESTful API server on its default port 61208, the a test the following command can be used:

$ sudo glances -w
Glances web server started on http://0.0.0.0:61208/

Check if you are able to access the API located at http://IP_ADRRESS:61208/api/2. Don’t use -s as this will start the XMLRPC server on port 61209. Home Assistant only supports the REST API of GLANCES.

The details about your memory usage is provided as a JSON response. If so, you are good to proceed.

$ curl -X GET http://IP_ADDRESS:61208/api/2/mem/free
{"free": 203943936}

For details about auto-starting glances, please refer to Start Glances through Systemd.

Configuration

To enable the Glances sensor, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
sensor:
  - platform: glances
    host: IP_ADDRESS
    resources:
      - 'disk_use_percent'

Configuration Variables

host

(string)(Optional)IP address of the host where Glances is running.

Default value: localhost

port

(int)(Optional)The port where Glances is listening.

Default value: 61208

name

(string)(Optional)The prefix for the sensors.

Default value: Glances

version

(int)(Optional)The version of the Glances API. Supported version: 2 and 3.

Default value: 2

resources

(map)(Optional)Entries to monitor.

Default value: disk_use

disk_use_percent

The used disk space in percent.

disk_use

The used disk space.

disk_free

The free disk space.

memory_use_percent

The used memory in percent.

memory_use

The used memory.

memory_free

The free memory.

swap_use_percent

The used swap space in percent.

swap_use

The used swap space.

swap_free

The free swap space.

processor_load

The load.

process_running

The number of running processes.

process_total

The total number of processes.

process_thread

The number of threads.

process_sleeping

The number of sleeping processes.

cpu_temp

The CPU temperature (may not be available on all platforms).

docker_active

The count of active Docker containers.

docker_cpu_use

The total CPU usage in percent of Docker containers.

docker_memory_use

The total memory used by Docker containers.

Not all platforms are able to provide all metrics. For instance cpu_temp is requires installing and configuring lmsensors in Ubuntu, and may not be available at all in other platforms.