366 lines
22 KiB
HTML
366 lines
22 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>InfluxDB - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Record events in InfluxDB.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/influxdb/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="InfluxDB">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/influxdb/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Record events in InfluxDB.">
|
||
<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="InfluxDB">
|
||
<meta name="twitter:description" content="Record events in InfluxDB.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" 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">
|
||
InfluxDB
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">influxdb</code> component makes it possible to transfer all state changes to an external <a href="https://influxdb.com/">InfluxDB</a> database. For more details, <a href="/blog/2015/12/07/influxdb-and-grafana/">see the blog post on InfluxDB</a>.</p>
|
||
<h2><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h2>
|
||
<p>The default InfluxDB configuration doesn’t enforce authentication. If you have installed InfluxDB on the same host where Home Assistant is running and haven’t made any configuration changes, 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">influxdb</span><span class="pi">:</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>You will still need to create a database named <code class="highlighter-rouge">home_assistant</code> via InfluxDB’s web interface or command line. For instructions how to create a database check the <a href="https://docs.influxdata.com/influxdb/latest/introduction/getting_started/#creating-a-database">InfluxDB documentation</a> relevant to the version you have installed.</p>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Optional</em>): IP address of your database host, e.g. 192.168.1.10. Defaults to <code class="highlighter-rouge">localhost</code>.</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): Port to use. Defaults to 8086.</li>
|
||
<li><strong>username</strong> (<em>Optional</em>): The username of the database user. The user needs read/write privileges on the database.</li>
|
||
<li><strong>password</strong> (<em>Optional</em>): The password for the database user account.</li>
|
||
<li><strong>database</strong> (<em>Optional</em>): Name of the database to use. Defaults to <code class="highlighter-rouge">home_assistant</code>. The database must already exist.</li>
|
||
<li><strong>ssl</strong> (<em>Optional</em>): Use https instead of http to connect. Defaults to false.</li>
|
||
<li><strong>verify_ssl</strong> (<em>Optional</em>): Verify SSL certificate for https request. Defaults to false.</li>
|
||
<li><strong>default_measurement</strong> (<em>Optional</em>): Measurement name to use when an entity doesn’t have a unit. Defaults to entity id.</li>
|
||
<li><strong>override_measurement</strong> (<em>Optional</em>): Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.</li>
|
||
<li><strong>component_config</strong>, <strong>component_config_domain</strong>, <strong>component_config_glob</strong> (<em>Optional</em>): These attributes contains component-specific override values. See <a href="https://home-assistant.io/getting-started/customizing-devices/">Customizing devices and services</a> for format.
|
||
<ul>
|
||
<li><strong>override_measurement</strong> (<em>Optional</em>): Measurement name to use for this component, takes precedence over the global ‘override_measurement’ and component-specific ‘unit_of_measurement’ attribute.</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>exclude</strong> (<em>Optional</em>): Configure which components should be excluded from recording to InfluxDB.
|
||
<ul>
|
||
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be excluded from recording to InfluxDB.</li>
|
||
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be excluded from recording to InfluxDB.</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>include</strong> (<em>Optional</em>): Configure which components should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. Values set by the <strong>blacklist</strong> option will prevail.
|
||
<ul>
|
||
<li><strong>entities</strong> (<em>Optional</em>): The list of entity ids to be included from recordings to InfluxDB.</li>
|
||
<li><strong>domains</strong> (<em>Optional</em>): The list of domains to be included from recordings to InfluxDB.</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>tags</strong> (<em>Optional</em>): Tags to mark the data.</li>
|
||
<li><strong>tags_attributes</strong> (<em>Optional</em>): The list of attribute names which should be reported as tags and not fields to InfluxDB. For example, if set to <code class="highlighter-rouge">friendly_name</code>, it will be possible to group by entities’ friendly names as well, in addition to their ids.</li>
|
||
</ul>
|
||
<h2><a class="title-link" name="data-migration" href="#data-migration"></a> Data migration</h2>
|
||
<p>Starting with 0.36 the InfluxDB component has a new schema to store values in the InfluxDB databases.</p>
|
||
<ul>
|
||
<li>There will no longer be any tags/fields named <code class="highlighter-rouge">time</code>.</li>
|
||
<li>All numeric fields (int/float/bool) will be stored as float inside InfluxDB database.</li>
|
||
<li>All string fields corresponding to state attributes will be renamed as <code class="highlighter-rouge">FIELDNAME_str</code>, where <code class="highlighter-rouge">FIELDNAME</code> is the state attribute, to avoid type conflicts.</li>
|
||
<li>All string fields corresponding to a state will be renamed as <code class="highlighter-rouge">state</code> (former value).</li>
|
||
<li>Fields named <code class="highlighter-rouge">value</code> will always be stored as float.</li>
|
||
<li>Fields named <code class="highlighter-rouge">state</code> will always be stored as string.</li>
|
||
</ul>
|
||
<h3><a class="title-link" name="migration-script" href="#migration-script"></a> Migration script</h3>
|
||
<p>If you need to migrate your database, you may require to run the <code class="highlighter-rouge">influxdb_migrator</code> script. Run the script after upgrade to 0.36 but before the first regular start of <code class="highlighter-rouge">hass</code> version 0.36.</p>
|
||
<p>These are the steps the script will perform:</p>
|
||
<ol>
|
||
<li>Create a new database (called <code class="highlighter-rouge">DBNAME__old</code>) to store old data.</li>
|
||
<li>Copy data from <code class="highlighter-rouge">DBNAME</code> database to <code class="highlighter-rouge">DBNAME__old</code> database.</li>
|
||
<li>Empty <code class="highlighter-rouge">DBNAME</code> database (using <code class="highlighter-rouge">drop</code> then <code class="highlighter-rouge">create</code>). <code class="highlighter-rouge">DBNAME</code> database is now considered as the new database.</li>
|
||
<li>For each measurement of <code class="highlighter-rouge">DBNAME__old</code> database:</li>
|
||
<li>Read all points from the current measurement (in groups of 1000 points by default) and convert them.</li>
|
||
<li>Send group of points to <code class="highlighter-rouge">DBNAME</code> database.</li>
|
||
<li>Delete the <code class="highlighter-rouge">DBNAME__old</code> database if needed.</li>
|
||
</ol>
|
||
<p>Example to run the script:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script influxdb_migrator <span class="se">\</span>
|
||
-H IP_INFLUXDB_HOST -u INFLUXDB_USERNAME -p INFLUXDB_PASSWORD <span class="se">\</span>
|
||
-d INFLUXDB_DB_NAME
|
||
</code></pre>
|
||
</div>
|
||
<p>Script arguments:</p>
|
||
<div class="highlighter-rouge"><pre class="highlight"><code>required arguments:
|
||
-d dbname, --dbname dbname InfluxDB database name
|
||
|
||
optional arguments:
|
||
-h, --help show this help message and exit
|
||
-H host, --host host InfluxDB host address
|
||
-P port, --port port InfluxDB host port
|
||
-u username, --username username
|
||
InfluxDB username
|
||
-p password, --password password
|
||
InfluxDB password
|
||
-s step, --step step How many points to migrate at the same time
|
||
-o override_measurement, --override-measurement override_measurement
|
||
Store all your points in the same measurement
|
||
-D, --delete Delete old database
|
||
</code></pre>
|
||
</div>
|
||
<ul>
|
||
<li>If you run the script with only the <code class="highlighter-rouge">-h</code> option, you will get a help printout with a short explanation of the different options.</li>
|
||
<li>The host option defaults to <code class="highlighter-rouge">'127.0.0.1'</code>.</li>
|
||
<li>The port option defaults to <code class="highlighter-rouge">8086</code>.</li>
|
||
<li>You should be able to omit username and password if InfluxDB authentication is disabled, which it is by default.</li>
|
||
<li>The step option defaults to <code class="highlighter-rouge">1000</code>.</li>
|
||
</ul>
|
||
<h2><a class="title-link" name="data-import-script" href="#data-import-script"></a> Data import script</h2>
|
||
<p>If you want to import all the recorded data from your recorder database you can use the data import script.
|
||
It will read all your state_change events from the database and add them as data-points to the InfluxDB.
|
||
You can specify the source database either by pointing the <code class="highlighter-rouge">--config</code> option to the config directory which includes the default SQLite database or by giving a sqlalchemy connection URI with <code class="highlighter-rouge">--uri</code>.
|
||
The writing to InfluxDB is done in batches that can be changed with <code class="highlighter-rouge">--step</code>.</p>
|
||
<p>You can control, which data is imported by using the command line options <code class="highlighter-rouge">--exclude_entities</code> and <code class="highlighter-rouge">--exclude_domains</code>.
|
||
Both get a comma separated list of either entity-ids or domain names that are excluded from the import.</p>
|
||
<p>To test what gets imported you can use the <code class="highlighter-rouge">--simulate</code> option, which disables the actual write to the InfluxDB instance.
|
||
This only writes the statistics how much points would be imported from which entity.</p>
|
||
<p>Example to run the script:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script influxdb_import --config CONFIG_DIR <span class="se">\</span>
|
||
-H IP_INFLUXDB_HOST -u INFLUXDB_USERNAME -p INFLUXDB_PASSWORD <span class="se">\</span>
|
||
--dbname INFLUXDB_DB_NAME --exclude_domains automation,configurator
|
||
</code></pre>
|
||
</div>
|
||
<p>Script arguments:</p>
|
||
<div class="highlighter-rouge"><pre class="highlight"><code>required arguments:
|
||
-d dbname, --dbname dbname
|
||
InfluxDB database name
|
||
|
||
optional arguments:
|
||
-h, --help show this help message and exit
|
||
-c path_to_config_dir, --config path_to_config_dir
|
||
Directory that contains the Home Assistant
|
||
configuration
|
||
--uri URI Connect to URI and import (if other than default
|
||
sqlite) eg: mysql://localhost/homeassistant
|
||
|
||
-H host, --host host InfluxDB host address
|
||
-P port, --port port InfluxDB host port
|
||
-u username, --username username
|
||
InfluxDB username
|
||
-p password, --password password
|
||
InfluxDB password
|
||
-s step, --step step How many points to import at the same time
|
||
-t tags, --tags tags Comma separated list of tags (key:value) for all
|
||
points
|
||
-D default_measurement, --default-measurement default_measurement
|
||
Store all your points in the same measurement
|
||
-o override_measurement, --override-measurement override_measurement
|
||
Store all your points in the same measurement
|
||
-e exclude_entities, --exclude_entities exclude_entities
|
||
Comma separated list of excluded entities
|
||
-E exclude_domains, --exclude_domains exclude_domains
|
||
Comma separated list of excluded domains
|
||
-S, --simulate Do not write points but simulate preprocessing
|
||
and print statistics
|
||
</code></pre>
|
||
</div>
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
<h3><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h3>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">influxdb</span><span class="pi">:</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.190</span>
|
||
<span class="s">port</span><span class="pi">:</span> <span class="s">20000</span>
|
||
<span class="s">database</span><span class="pi">:</span> <span class="s">DB_TO_STORE_EVENTS</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">MY_USERNAME</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">MY_PASSWORD</span>
|
||
<span class="s">ssl</span><span class="pi">:</span> <span class="s">true</span>
|
||
<span class="s">verify_ssl</span><span class="pi">:</span> <span class="s">true</span>
|
||
<span class="s">default_measurement</span><span class="pi">:</span> <span class="s">state</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">entity.id1</span>
|
||
<span class="pi">-</span> <span class="s">entity.id2</span>
|
||
<span class="s">domains</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">automation</span>
|
||
<span class="s">include</span><span class="pi">:</span>
|
||
<span class="s">entities</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">entity.id3</span>
|
||
<span class="pi">-</span> <span class="s">entity.id4</span>
|
||
<span class="s">tags</span><span class="pi">:</span>
|
||
<span class="s">instance</span><span class="pi">:</span> <span class="s">prod</span>
|
||
<span class="s">source</span><span class="pi">:</span> <span class="s">hass</span>
|
||
</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/influxdb.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/influxdb.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.9
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/sensor.influxdb/'>
|
||
InfluxDB Sensor
|
||
</a></li>
|
||
</ul>
|
||
</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/history_graph/'>History Graph</a>
|
||
</li>
|
||
<li>
|
||
InfluxDB
|
||
</li>
|
||
<li>
|
||
<a href='/components/logbook/'>Logbook</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/logentries/'>Logentries</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/prometheus/'>Prometheus</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/recorder/'>Recorder</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/shiftr/'>Shiftr.io</a>
|
||
</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>
|
||
<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>
|