jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/recorder/index.html
Travis CI ebffa845cd Site updated at 2017-05-20 22:59:15 UTC
2017-05-20 22:59:15 +00:00

281 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Recorder - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to configure the data recorder for Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/recorder/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Recorder">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/recorder/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to configure the data recorder for 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="Recorder">
<meta name="twitter:description" content="Instructions how to configure the data recorder for 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>
<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>
</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">
Recorder
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">recorder</code> component is storing details in a database which then are handled by the <a href="/components/history/"><code class="highlighter-rouge">history</code> component</a>.</p>
<p>Home Assistant uses <a href="http://www.sqlalchemy.org/">SQLAlchemy</a> as Object Relational Mapper (ORM). This means that you can now use <strong>any</strong> SQL backend for the recorder that is supported by SQLAlchemy, like <a href="https://www.mysql.com/">MySQL</a>, <a href="https://mariadb.org/">MariaDB</a>, or <a href="https://www.postgresql.org/">PostgreSQL</a>.</p>
<p>The default database engine is <a href="https://www.sqlite.org/">SQLite</a> which doesn’t require any configuration. The database is stored in your Home Assistant configuration directory (<code class="highlighter-rouge">.homeassistant</code>) and called <code class="highlighter-rouge">home-assistant_v2.db</code>.</p>
<p>To setup the <code class="highlighter-rouge">recorder</code> component in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">recorder</span><span class="pi">:</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>purge_days</strong> (<em>Optional</em>): Delete events and states older than x days.</li>
<li><strong>exclude</strong> (<em>Optional</em>): Configure which components should be excluded from recordings.
<ul>
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be excluded from recordings.</li>
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be excluded from recordings.</li>
</ul>
</li>
<li><strong>include</strong> (<em>Optional</em>): Configure which components should be included in recordings. If set, all other entities will not be recorded.
<ul>
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be included from recordings.</li>
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be included from recordings.</li>
</ul>
</li>
<li><strong>db_url</strong> (<em>Optional</em>): The URL which point to your database.</li>
</ul>
<p>Define domains and entities to <code class="highlighter-rouge">exclude</code> (aka. blacklist). This is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like <code class="highlighter-rouge">weblink</code>) or rarely change (<code class="highlighter-rouge">updater</code> or <code class="highlighter-rouge">automation</code>).</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry with exclude</span>
<span class="s">recorder</span><span class="pi">:</span>
<span class="s">purge_days</span><span class="pi">:</span> <span class="s">5</span>
<span class="s">db_url</span><span class="pi">:</span> <span class="s">sqlite:///home/user/.homeassistant/test</span>
<span class="s">exclude</span><span class="pi">:</span>
<span class="s">domains</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">automation</span>
<span class="pi">-</span> <span class="s">weblink</span>
<span class="pi">-</span> <span class="s">updater</span>
<span class="s">entities</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sun.sun</span> <span class="c1"># Don't record sun data</span>
<span class="pi">-</span> <span class="s">sensor.last_boot</span>
<span class="pi">-</span> <span class="s">sensor.date</span>
</code></pre>
</div>
<p>Define domains and entities to record by using the <code class="highlighter-rouge">include</code> configuration (aka. whitelist). If you have a lot of entities in your system and your <code class="highlighter-rouge">exclude</code> lists possibly get very large, it might be better just to define the entities or domains to record.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry with include</span>
<span class="s">recorder</span><span class="pi">:</span>
<span class="s">include</span><span class="pi">:</span>
<span class="s">domains</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor</span>
<span class="pi">-</span> <span class="s">switch</span>
<span class="pi">-</span> <span class="s">media_player</span>
</code></pre>
</div>
<p>Use the <code class="highlighter-rouge">include</code> list to define the domains/entities to record, and exclude some of them with in the <code class="highlighter-rouge">exclude</code> list. This makes sense if you for instance include the <code class="highlighter-rouge">sensor</code> domain, but want to exclude some specific sensors. Instead of adding every sensor entity to the <code class="highlighter-rouge">include</code> <code class="highlighter-rouge">entities</code> list just include the <code class="highlighter-rouge">sensor</code> domain and exclude the sensor entities you are not interested in.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry with include and exclude</span>
<span class="s">recorder</span><span class="pi">:</span>
<span class="s">include</span><span class="pi">:</span>
<span class="s">domains</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor</span>
<span class="pi">-</span> <span class="s">switch</span>
<span class="pi">-</span> <span class="s">media_player</span>
<span class="s">exclude</span><span class="pi">:</span>
<span class="s">entities</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor.last_boot</span>
<span class="pi">-</span> <span class="s">sensor.date</span>
</code></pre>
</div>
<p>If you only want to hide events from e.g. your history, take a look at the <a href="/components/history/"><code class="highlighter-rouge">history</code> component</a>. Same goes for logbook. But if you have privacy concerns about certain events or neither want them in history or logbook, you should use the <code class="highlighter-rouge">exclude</code>/<code class="highlighter-rouge">include</code> options of the <code class="highlighter-rouge">recorder</code> component, that they aren’t even in your database. That way you can save storage and keep the database small by excluding certain often-logged events (like <code class="highlighter-rouge">sensor.last_boot</code>).</p>
<h2>Custom database engines</h2>
<table>
<thead>
<tr>
<th style="text-align: left">Database engine</th>
<th style="text-align: left"><code class="highlighter-rouge">db_url</code></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">SQLite</td>
<td style="text-align: left"><code class="highlighter-rouge">sqlite:///PATH/TO/DB_NAME</code></td>
</tr>
<tr>
<td style="text-align: left">MySQL</td>
<td style="text-align: left"><code class="highlighter-rouge">mysql://SERVER_IP/DB_NAME</code></td>
</tr>
<tr>
<td style="text-align: left">MySQL          </td>
<td style="text-align: left"><code class="highlighter-rouge">mysql://user:password@SERVER_IP/DB_NAME</code>      </td>
</tr>
<tr>
<td style="text-align: left">MySQL (pymysql)</td>
<td style="text-align: left"><code class="highlighter-rouge">mysql+pymysql://SERVER_IP/DB_NAME</code></td>
</tr>
<tr>
<td style="text-align: left">MySQL (pymysql)</td>
<td style="text-align: left"><code class="highlighter-rouge">mysql+pymysql://user:password@SERVER_IP/DB_NAME</code></td>
</tr>
<tr>
<td style="text-align: left">PostgreSQL</td>
<td style="text-align: left"><code class="highlighter-rouge">postgresql://SERVER_IP/DB_NAME</code></td>
</tr>
<tr>
<td style="text-align: left">PostgreSQL</td>
<td style="text-align: left"><code class="highlighter-rouge">postgresql://scott:tiger@SERVER_IP/DB_NAME</code></td>
</tr>
</tbody>
</table>
<h2><a class="title-link" name="installation-notes" href="#installation-notes"></a> Installation notes</h2>
<p>Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details which should help you to get it working.</p>
<h3><a class="title-link" name="mysql" href="#mysql"></a> MySQL</h3>
<p>For MySQL you may have to install a few dependencies. You can choose between <code class="highlighter-rouge">pymysql</code> and <code class="highlighter-rouge">mysqlclient</code>:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get install libmysqlclient-dev
<span class="gp">$ </span>pip3 install mysqlclient
</code></pre>
</div>
<p>If you are in a virtual environment, don’t forget to activate it before installing the pymysql package.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>pi@homeassistant:~ <span class="nv">$ </span>sudo -i
<span class="gp">root@homeassistant:~# </span>su homeassistant
<span class="gp">homeassistant@homeassistant:/root$ </span><span class="nb">cd</span> /srv/homeassistant/homeassistant_venv/
<span class="gp">homeassistant@homeassistant:/srv/homeassistant/homeassistant_venv$ </span><span class="nb">source </span>bin/activate
<span class="o">(</span>homeassistant_venv<span class="o">)</span> homeassistant@homeassistant:/srv/homeassistant/homeassistant_venv<span class="nv">$ </span>pip3 install mysqlclient
</code></pre>
</div>
<h3><a class="title-link" name="postgresql" href="#postgresql"></a> PostgreSQL</h3>
<p>For PostgreSQL you may have to install a few dependencies:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get install postgresql-server-dev-X.Y
<span class="gp">$ </span>pip3 install psycopg2
</code></pre>
</div>
</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/recorder.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='section'>
Introduced in release: pre 0.7
</div>
<div class='section'>
<h1 class="title delta">Category History</h1>
<ul class='divided'>
<li>
<a href='/components/datadog/'>Datadog</a>
</li>
<li>
<a href='/components/dweet/'>Dweet.io</a>
</li>
<li>
<a href='/components/emoncms_history/'>Emoncms history</a>
</li>
<li>
<a href='/components/graphite/'>Graphite</a>
</li>
<li>
<a href='/components/history/'>History</a>
</li>
<li>
<a href='/components/influxdb/'>InfluxDB</a>
</li>
<li>
<a href='/components/logbook/'>Logbook</a>
</li>
<li>
<a href='/components/logentries/'>Logentries</a>
</li>
<li>
Recorder
</li>
<li>
<a href='/components/splunk/'>Splunk</a>
</li>
<li>
<a href='/components/statsd/'>StatsD</a>
</li>
<li>
<a href='/components/thingspeak/'>ThingSpeak</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>
</body>
</html>
Reference in a new issue View git blame Copy permalink