mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Update glances.markdown (#10711)
This commit is contained in:
parent
0fca2234e3
commit
5d844c9a38
@ -9,42 +9,39 @@ ha_release: 0.7.3
|
|||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `glances` sensor platform is consuming the system information provided by the [Glances](https://github.com/nicolargo/glances) API. This enables one to track remote host and display their stats in Home Assistant.
|
The `glances` integration allows you to monitor the system information provided by the [Glances](https://github.com/nicolargo/glances) API. This enables one to track remote host and display their stats in Home Assistant.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
This sensors needs a running instance of `glances` on the host. The minimal supported version of `glances` is 2.3.
|
These 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:
|
To start a Glances RESTful API server on its default port 61208 then test you can use the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo glances -w
|
$ sudo glances -w
|
||||||
Glances web server started on http://0.0.0.0:61208/
|
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.
|
Check if you are able to access the API located at `http://IP_ADRRESS:61208/api/3`. 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.
|
The details about your memory usage is provided as a JSON response. If so, you are good to proceed.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ curl -X GET http://IP_ADDRESS:61208/api/2/mem/free
|
$ curl -X GET http://IP_ADDRESS:61208/api/3/mem/free
|
||||||
{"free": 203943936}
|
{"free": 203943936}
|
||||||
```
|
```
|
||||||
|
|
||||||
If this doesn't work, try changing the `2` for `3`, if you have installed the latest version of Glances.
|
If this doesn't work, try changing the `3` to `2`, if you don't have the latest version of Glances installed.
|
||||||
|
|
||||||
For details about auto-starting `glances`, please refer to [Start Glances through Systemd](https://github.com/nicolargo/glances/wiki/Start-Glances-through-Systemd).
|
For details about auto-starting `glances`, please refer to [Start Glances through Systemd](https://github.com/nicolargo/glances/wiki/Start-Glances-through-Systemd).
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
To enable the Glances sensor, add the following lines to your `configuration.yaml`:
|
Set up the integration through **Configuration -> Integrations -> Glances**. To import the configuration from `configuration.yaml` remove any previously configured sensors with platform type `glances` and add the following lines:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
glances:
|
||||||
- platform: glances
|
- host: IP_ADDRESS
|
||||||
host: IP_ADDRESS
|
|
||||||
resources:
|
|
||||||
- 'disk_use_percent'
|
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -85,51 +82,31 @@ version:
|
|||||||
description: "The version of the Glances API. Supported version: `2` and `3`."
|
description: "The version of the Glances API. Supported version: `2` and `3`."
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
default: 2
|
default: 3
|
||||||
resources:
|
|
||||||
description: Entries to monitor.
|
|
||||||
required: false
|
|
||||||
type: list
|
|
||||||
default: disk_use
|
|
||||||
keys:
|
|
||||||
disk_use_percent:
|
|
||||||
description: The used disk space in percent.
|
|
||||||
disk_use:
|
|
||||||
description: The used disk space.
|
|
||||||
disk_free:
|
|
||||||
description: The free disk space.
|
|
||||||
memory_use_percent:
|
|
||||||
description: The used memory in percent.
|
|
||||||
memory_use:
|
|
||||||
description: The used memory.
|
|
||||||
memory_free:
|
|
||||||
description: The free memory.
|
|
||||||
swap_use_percent:
|
|
||||||
description: The used swap space in percent.
|
|
||||||
swap_use:
|
|
||||||
description: The used swap space.
|
|
||||||
swap_free:
|
|
||||||
description: The free swap space.
|
|
||||||
processor_load:
|
|
||||||
description: The load.
|
|
||||||
process_running:
|
|
||||||
description: The number of running processes.
|
|
||||||
process_total:
|
|
||||||
description: The total number of processes.
|
|
||||||
process_thread:
|
|
||||||
description: The number of threads.
|
|
||||||
process_sleeping:
|
|
||||||
description: The number of sleeping processes.
|
|
||||||
cpu_use_percent:
|
|
||||||
description: The used CPU in percent.
|
|
||||||
cpu_temp:
|
|
||||||
description: The CPU temperature (may not be available on all platforms).
|
|
||||||
docker_active:
|
|
||||||
description: The count of active Docker containers.
|
|
||||||
docker_cpu_use:
|
|
||||||
description: The total CPU usage in percent of Docker containers.
|
|
||||||
docker_memory_use:
|
|
||||||
description: The total memory used by Docker containers.
|
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
## Integration Entities
|
||||||
|
|
||||||
|
Glances integration will add the following sensors:
|
||||||
|
|
||||||
|
- 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_use_percent: The used CPU in percent.
|
||||||
|
- 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.
|
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.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user