281 lines
14 KiB
HTML
281 lines
14 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>Glances - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate Glances sensors into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.glances/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Glances">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.glances/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate Glances sensors into Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="Glances">
|
||
<meta name="twitter:description" content="Instructions how to integrate Glances sensors into Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
Glances
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">glances</code> sensor platform is consuming the system information provided by the <a href="https://github.com/nicolargo/glances">Glances</a> API. This enables one to track remote host and display their stats in Home Assistant.</p>
|
||
<p>This sensors needs a running instance of <code class="highlighter-rouge">glances</code> on the host. The minimal supported version of <code class="highlighter-rouge">glances</code> is 2.3.
|
||
To start a Glances RESTful API server on its default port 61208, the a test the following command can be used:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo glances -w
|
||
Glances web server started on http://0.0.0.0:61208/
|
||
</code></pre>
|
||
</div>
|
||
<p>Check if you are able to access the API located at <code class="highlighter-rouge">http://IP_ADRRESS:61208/api/2</code>. Don’t use <code class="highlighter-rouge">-s</code> as this will start the XMLRPC server on port 61209. Home Assistant only supports the REST API of GLANCES.</p>
|
||
<p>The details about your memory usage is provided as a JSON response. If so, you are good to proceed.</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>curl -X GET http://IP_ADDRESS:61208/api/2/mem/free
|
||
<span class="o">{</span><span class="s2">"free"</span>: 203943936<span class="o">}</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>For details about auto-starting <code class="highlighter-rouge">glances</code>, please refer to <a href="https://github.com/nicolargo/glances/wiki/Start-Glances-through-Systemd">Start Glances through Systemd</a>.</p>
|
||
<p>To enable the Glances sensor, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">glances</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
|
||
<span class="s">resources</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">disk_use_percent'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">disk_use'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">disk_free'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">memory_use_percent'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">memory_use'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">memory_free'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">swap_use_percent'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">swap_use'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">swap_free'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">processor_load'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">process_running'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">process_total'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">process_thread'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">process_sleeping'</span>
|
||
<span class="pi">-</span> <span class="s1">'</span><span class="s">cpu_temp'</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): The IP address of your host, eg. <code class="highlighter-rouge">192.168.1.32</code>.</li>
|
||
<li><strong>port</strong> (<em>Option</em>): The network port to connect to. Default is <code class="highlighter-rouge">61208</code>.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): Name of the Glances sensor.</li>
|
||
<li><strong>resources</strong> (<em>Required</em>): Entries to monitor.
|
||
<ul>
|
||
<li><strong>disk_use_percent</strong>: Used disk space in percent</li>
|
||
<li><strong>disk_use</strong>: Used disk space</li>
|
||
<li><strong>disk_free</strong>: Free disk space</li>
|
||
<li><strong>memory_use_percent</strong>: Used memory in percent</li>
|
||
<li><strong>memory_use</strong>: Used memory</li>
|
||
<li><strong>memory_free</strong>: Free memory</li>
|
||
<li><strong>swap_use_percent</strong>: Used swap space in percent</li>
|
||
<li><strong>swap_use</strong>: Used swap space</li>
|
||
<li><strong>swap_free</strong>: Free swap space</li>
|
||
<li><strong>processor_load</strong>: Load</li>
|
||
<li><strong>process_running</strong>: Number of running processes</li>
|
||
<li><strong>process_total</strong>: Total number of processes</li>
|
||
<li><strong>process_thread</strong>: Number of threads</li>
|
||
<li><strong>process_sleeping</strong>: Number of sleeping processes</li>
|
||
<li><strong>cpu_temp</strong>: CPU Temperature (may not available on all platforms)</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>Not all platforms are able to provide all metrics. For instance <code class="highlighter-rouge">cpu_temp</code> is requires installing and configuring <code class="highlighter-rouge">lmsensors</code> in Ubuntu, and may not be available at all in other platforms.</p>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.glances.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/glances.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.7.3
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category System Monitor</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.cups/'>CUPS Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.cert_expiry/'>Certificate Expiry</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/binary_sensor.digital_ocean/'>Digital Ocean Binary Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dovado/'>Dovado</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.fritzbox_callmonitor/'>FRITZ!Box</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.fritzbox_netmonitor/'>FRITZ!Box</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.fastdotcom/'>Fast.com</a>
|
||
</li>
|
||
<li>
|
||
Glances
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.hddtemp/'>HDDTemp</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nut/'>NUT Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.netdata/'>Netdata</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.snmp/'>SNMP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.supervisord/'>Supervisord</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zabbix/'>Zabbix</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.zabbix/'>Zabbix Sensor</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|