Glances - Community Hass.io Add-on for Home Assistant
Branch: master
Clone or download
Latest commit e826572 Feb 5, 2019

README.md

Community Hass.io Add-ons: Glances

GitHub Release Project Stage License

GitLab CI Project Maintenance GitHub Activity

Discord Community Forum

Buy me a coffee

Support my work on Patreon

Glances is a cross-platform system monitoring tool written in Python.

The Glances Hass.io add-on

About

Glances is a cross-platform monitoring tool which aims to present a maximum of information in a minimum of space through a Web-based interface.

Glances can export all system statistics to InfluxDB, allowing you to look at all your system information and its behavior over time.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Add our Hass.io add-ons repository to your Hass.io instance.
  2. Install the "Glances" add-on.
  3. Disable "Protection mode" in the add-on panel.
  4. Start the "Glances" add-on.
  5. Check the logs of the "Glances" to see if everything went well.
  6. Click the "OPEN WEB UI" button take a glance at Glances.

NOTE: Do not add this repository to Hass.io, please use: https://github.com/hassio-addons/repository.

Docker status

Supports armhf Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Docker Layers Docker Pulls

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

{
  "log_level": "info",
  "ssl": false,
  "certfile": "fullchain.pem",
  "keyfile": "privkey.pem",
  "influxdb": {
    "enabled": false,
    "host": "a0d7b954-influxdb",
    "port": 8086,
    "username": "glances",
    "password": "!secret glances_influxdb_password",
    "database": "glances",
    "prefix": "localhost",
    "interval": 60
  }
}

Note: This is just an example, don't copy and paste it! Create your own!

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Option: ssl

Enables/Disables SSL (HTTPS) on the Glances Web UI. Set it true to enable it, false otherwise.

Option: certfile

The certificate file to use for SSL.

Note: The file MUST be stored in /ssl/, which is default for Hass.io

Option: keyfile

The private key file to use for SSL.

Note: The file MUST be stored in /ssl/, which is default for Hass.io

Option group influxdb


The following options are for the option group: influxdb. These settings only apply to the Glances InfluxDB data export.

Option influxdb: enabled

Enables/Disables the Glances data export to InfluxDB.

Option influxdb: host

The hostname where InfluxDB is running.

Note: If you are using the Community InfluxDB add-on, use a0d7b954-influxdb as the hostname.

Option influxdb: port

The port on which InfluxDB is listening.

Option influxdb: username

The username that you have created for Glances to authenticate against InfluxDB.

Option influxdb: password

The password for the above username option.

Option influxdb: database

The name of the database to store all Glances information into.

Note: It is strongly recommended to create a separate database for glances and not store this in the same database name as Home Assistant.

Option prefix: localhost

The hostname to append for exported data.

Note: For the Grafana Glances dashboard set this to localhost.

Option influxdb: interval

Defines the interval (in seconds) on how often Glances exports data to InfluxDB.

Embedding into Home Assistant

It is possible to embed Glances directly into Home Assistant, allowing you to access Glances through the Home Assistant frontend.

Home Assistant provides the panel_iframe component, for these purposes.

Example configuration:

panel_iframe:
  glances:
    title: Glances
    icon: mdi:speedometer
    url: http://hassio.local:61208

Adding Glances as a sensor into Home Assistant

The Home Assistant Glances sensor platform is consuming the system information provided by the Glances API.

This enables one to track and display their stats in Home Assistant, and even build automations based on that data.

sensor:
  - platform: glances
    host: 127.0.0.1
    username: YOUR_GLANCES_USERNAME
    password: YOUR_GLANCES_PASSWORD
    version: 3
    resources:
      - 'processor_load'
      - 'memory_use_percent'
      - 'disk_use_percent'

More information about the Glances sensor platform can be found in the Home Assistant documentation:

https://www.home-assistant.io/components/sensor.glances/

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2019 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.