jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sensor.systemmonitor.html
Paulus Schoutsen 2e727a5332 Site updated at 2015-08-29 16:17:09 UTC
2015-08-29 09:17:09 -07:00

266 lines
No EOL
9.6 KiB
HTML
Raw Blame History

<!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>Monitor server resources - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to integrate server resources within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Monitor server resources">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.systemmonitor.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to integrate server resources within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.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>
<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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Initial configuration</a></li>
<li><a href='/components/'>Component overview</a></li>
<li><a href='/getting-started/android.html'>Setting up Android</a></li>
</ul>
</li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture.html">Architecture</a></li>
<li><a href="/developers/frontend.html">Frontend development</a></li>
<li><a href="/developers/creating_components.html">
Creating components
</a></li>
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">API</a></li>
<li><a href="/developers/credits.html">Credits</a></li>
</ul>
</li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</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">
Monitor Server Resources
</h1>
</header>
<hr class="divider">
<p><img src='/images/supported_brands/utilities-system-monitor.png' class='brand pull-right' />
The system monitoring sensor platform to allow you to monitor disk usage, memory usage, CPU usage, and running processes. This platform has superseded the process component which is now considered deprecated.</p>
<p>To add this platform to your installation, add the following to your <code>configuration.yaml</code> file:</p>
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
<span class='line-number'>2</span>
<span class='line-number'>3</span>
<span class='line-number'>4</span>
<span class='line-number'>5</span>
<span class='line-number'>6</span>
<span class='line-number'>7</span>
<span class='line-number'>8</span>
</pre></td><td class='code'><pre><code class='yaml'><span class='line'><span class="c1"># Example configuration.yaml entry</span>
</span><span class='line'><span class="l-Scalar-Plain">sensor</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">platform</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">systemmonitor</span>
</span><span class='line'> <span class="l-Scalar-Plain">resources</span><span class="p-Indicator">:</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">disk_use_percent</span>
</span><span class='line'> <span class="l-Scalar-Plain">arg</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">/home</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">memory_free</span>
</span><span class='line'> <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">processor_use</span>
</span></code></pre></td></tr></table></div></figure>
<p>The table contains types and their argument to use in your <code>configuration.yaml</code> file.</p>
<table>
<thead>
<tr>
<th style="text-align:left;"> Type (- type:) </th>
<th style="text-align:left;"> Argument (arg:) </th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;"> disk_use_percent </td>
<td style="text-align:left;"> Path, eg. &lsquo;/&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> disk_use </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> disk_free </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> memory_use_percent </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> memory_use </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> memory_free </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> swap_use_percent </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> swap_use </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> swap_free </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> network_in </td>
<td style="text-align:left;"> Interface, eg. &lsquo;eth0&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> network_out </td>
<td style="text-align:left;"> Interface, eg. &lsquo;eth0&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> packets_in </td>
<td style="text-align:left;"> Interface, eg. &lsquo;eth0&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> packets_out </td>
<td style="text-align:left;"> Interface, eg. &lsquo;eth0&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> ipv4_address </td>
<td style="text-align:left;"> Interface, eg. &lsquo;eth0&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> ipv6_address </td>
<td style="text-align:left;"> Interface, eg. &lsquo;eth0&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> processor_use </td>
<td style="text-align:left;"> Interface, eg. &lsquo;eth0&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> process </td>
<td style="text-align:left;"> Binary, eg. &lsquo;octave-cli&rsquo; </td>
</tr>
<tr>
<td style="text-align:left;"> last_boot </td>
<td style="text-align:left;"> </td>
</tr>
<tr>
<td style="text-align:left;"> since_last_boot </td>
<td style="text-align:left;"> </td>
</tr>
</tbody>
</table>
<p><a href="https://github.com/theolind">Theodor Lindquist</a> has contributed the System monitoring platform.</p>
</article>
</div>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</div>
</div>
</div>
</footer>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<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>
</body>
</html>
Reference in a new issue View git blame Copy permalink