VictoriaMetrics for Home Assistant (app)

About

VictoriaMetrics is an app that runs a time series database for long term Home Assistant metrics. It speaks the Prometheus query language and API, and it also accepts the InfluxDB line protocol, so Home Assistant can either be scraped or push data into it. It sits next to the recorder instead of replacing it, which lets the history be kept for longer without burdening the recorder. Retention time is a setting, and data can be queried from the built-in web interface, which opens in the sidebar, or from Grafana. It reaches Home Assistant through the Supervisor, so no access token is needed. It requires Home Assistant OS and supports aarch64 and amd64.

Automatic summary of the docs and configuration of hassio-addons/repository. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Opens in the sidebar Its own page opens inside Home Assistant.
Actively maintained Its author released or pushed a change in the last six months.

Setting it up

Add its app repository under Settings, Apps, then install and start it.

From the docs

VictoriaMetrics is a fast, cost effective and scalable time series database. It speaks the Prometheus query language and API, but stores the same data in a fraction of the space and happily runs on the kind of hardware Home Assistant tends to live on.
Home Assistant's own recorder is built to answer "what is happening now". It is not built to answer "how has this changed over the past three years", and keeping enough history around to do so makes it slower at the job it is actually for. This app gives those long term numbers a home of their own: point it at Home Assistant, pick how long to keep things, and query the result from its built-in web interface or from Grafana.

From the docs of hassio-addons/repository, MIT License. Shortened.

Permissions

Home Assistant APICan read and control Home Assistant.
Sign-in checksCan check Home Assistant usernames and passwords.

Configuration

Log levelControls the level of log output by the app and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Each level automatically includes the messages of a more severe level.
Collect Home Assistant metricsScrape the metrics Home Assistant exposes itself. This needs the Prometheus integration to be enabled, by adding prometheus: to your configuration.yaml.
Scrape intervalHow often metrics are collected from every target, for example 60s or 5m. Shorter intervals give more detail and use more disk space.
Additional scrape configurationThe name of a YAML file in this app's configuration directory holding extra Prometheus scrape_configs jobs, for targets other than Home Assistant itself.
Retention periodHow long metrics are kept before they are deleted automatically. Use a number with a suffix: s, h, d, w, M (month, capital M) or y. For example 1y, 18M or 90d.
Deduplication intervalKeep only the last sample per time series per interval, for example 60s. Useful when the same metrics arrive from more than one source. Leave empty to store every sample.
Stream aggregation configurationThe name of a YAML file in this app's configuration directory holding stream aggregation rules, which summarize metrics as they arrive, for example into five minute averages.
Keep aggregated inputStore the raw samples that match a stream aggregation rule as well, instead of only the aggregated result.
Minimum free disk spaceNew metrics are no longer accepted once free disk space drops below this amount, which stops the database from filling up your machine. For example 1GB.
Latency offsetHow long freshly arrived metrics are held back from queries, so a half finished scrape cannot show up as a dip. Lower it to 1s when data is pushed here rather than scraped, and you want the newest values to show up right away.
Memory limitThe percentage of system memory the caches may occupy. Lower it when this app has to share a small machine, raise it when queries over long time ranges are slow.
SSLEnables/Disables encrypted SSL (HTTPS) for direct access to the app. This setting has no effect on the Ingress service.
Certificate fileThe certificate file to use for SSL. The file must be stored in the /ssl/ directory.
Private key fileThe private key file to use for SSL. The file must be stored in the /ssl/ directory.
Disable authenticationTurns off the Home Assistant login check on the direct port, leaving your metrics open to anybody who can reach it. Do not enable this.