Skip to content

VictoriaMetrics Add-on for Home Assistant OS is the perfect solution for long term data storage of your smart home sensor data and visualization with Grafana.

License

Notifications You must be signed in to change notification settings

VictoriaMetrics-Community/homeassistant-addon-victoriametrics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Home Assistant Add-on VictoriaMetrics Time Series Database

If you are looking for an efficient and easy to use way for long term storage of your Home Assistant data - just use VictoriaMetrics.

This add-on makes it easy to run a VictoriaMetrics Time Series Database on Home Assistant OS on ARM64 systems like Raspberry Pi 4 or AMD64.

Replacement for InfluxDB and Prometheus

VictoriaMetrics Time Series Database is 100% compatible with the Prometheus and InfluxDB line protocol. So Homeassistant is able to connect to VictoriaMetrics with the InfluxDB integration. In Grafana you can use the Prometheus or InfluxDB data source to use your data in your VictoriaMetrics database.

Much better long term storage

VictoriaMetrics offers an ultra efficient compression for data storage, is highly optimized for time series data and has low RAM usage. So this is the perfect solution for long term storage of high amounts of data like all sensor values of your smart home.

There are many reasons to switch to VictoriaMetrics. Compared to other products VictoriaMetrics offers:

  • better compression
  • better performance
  • lower RAM usage
  • fully open source
  • outperfomes other time series databases
  • ease of use

VictoriaMetrics on GitHub

VictoriaMetrics wins InfluxDB and Timescale in all the queries by a margin of up to 20x. It especially excels at heavy queries, which scan many millions of datapoints across thousands of distinct timeseries. More info here

This add-on continues the work of Andreas Habel whose hassio-victoriametrics add-on was not updated since 2021. I developed this mainly for my purpose running VictoriaMetrics on my Raspberry Pi 4 running Home Assistant Operating System. The direction of InfluxDB 2.0 was not what I wanted in combination with Grafana so VictoriaMetrics Time Series Database was the best choice.

Installation and configuration

  1. Add the reposity. (Quick link: Open your Home Assistant instance and show the Supervisor add-on store. )

  2. Install the add-on:

    • Find, and install the VictoriaMetrics add-on
  3. Configure VictoriaMetrics

    Read the addon documentation which can also be found on the Documentation tab of the VictoriaMetrics addon in the Home Assistant settings.

  4. Start the VictoriaMetrics add-on

  5. Add the influxdb integration to your Home Assistant configuration

    Instructions for adding and configuring the influxdb integration are in the addon documentation which can also be found on the Documentation tab of the VictoriaMetrics addon configuration.

    Don't forget to restart Home Assistant!

Well done! You can install and configure Grafana or similar to check data is being logged.

InfluxDB data migration

Many Home Assistant users may have legacy data in InfluxDB that they wish to migrate to VictoriaMetrics. There is a generic command line tool packaged with VictoriaMetrics that has documenation for InfluxDB v1.x although has no specific support for Home Assistant data. For users of InfluxDB v2.x, there is customised migration tool that can be found at https://github.com/maxlyth/influxv2tovm.