InfluxDB


The influxdb integration makes it possible to transfer all state changes to an external InfluxDB database. See the official installation documentation for how to set up an InfluxDB database, or there is a community add-on available.

Additionally, you can now make use of an InfluxDB 2.0 installation with this integration. See the official installation instructions for how to set up an InfluxDB 2.0 database. Or you can sign up for their cloud service and connect Home Assistant to that. Note that the configuration is significantly different for a 2.xx installation, the documentation below will note when fields or defaults apply to only a 1.xx installation or a 2.xx installation.

There is currently support for the following device types within Home Assistant:

The influxdb database integration runs parallel to the Home Assistant database. It does not replace it.

Configuration

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 configuration.yaml file:

# Example configuration.yaml entry
influxdb:

You will still need to create a database named home_assistant via InfluxDB’s command-line interface. For instructions on how to create a database check the InfluxDB documentation relevant to the version you have installed.

Configuration Variables

api_version string

API version to use. Valid values are 1 or 2.

ssl boolean (Optional, default: false)

Use HTTPS instead of HTTP to connect. 2.xx - Defaults to true for 2.xx, false otherwise false.

host string (Optional, default: localhost)

IP address or domain of your database host, e.g., 192.168.1.10. 2.xx - Defaults to ‘us-west-2-1.aws.cloud2.influxdata.com’ for 2.xx, not ‘localhost’.

port integer (Optional, default: 8086)

Port to use. 2.xx - No default port for 2.xx, otherwise 8086.

path string (Optional)

Path to use if your InfuxDB is running behind an reverse proxy.

username string (Inclusive)

1.xx only - The username of the database user. The user needs read/write privileges on the database.

password string (Inclusive)

1.xx only - The password for the database user account. Needed with username configuration variable.

database string (Optional, default: home_assistant)

1.xx only - Name of the database to use. The database must already exist.

verify_ssl boolean (Optional, default: true)

1.xx only - Verify SSL certificate for HTTPS request. For 2.xx SSL verification is required, library provides no way to disable it.

token string (Inclusive)

2.xx only - Auth token with WRITE access to your chosen Organization and Bucket. Needed with organization configuration variable.

organization string (Inclusive)

2.xx only - Organization ID to write to. To obtain this, open the UI of your 2.xx installation, the URL at the top will have it after /orgs. For example, in InfluxDB Cloud it looks like this: https://us-west-2-1.aws.cloud2.influxdata.com/orgs/{OrganizationID}. Needed with token configuration variable.

bucket string (Optional, default: Home Assistant)

2.xx only - Name of the bucket (not the generated bucket ID) within your Organization to write to.

max_retries integer (Optional, default: 0)

Set this to allow the integration to retry if there was a network error when transmitting data.

precision string (Optional, default: ns)

Set this to specify the time precision sent to influxdb. Setting a coarser precision allows InfluxDb to compress your data better. If not set, defaults to ns.

measurement_attr string (Optional, default: unit_of_measurement)

State object attribute(s) to use as measurement name. Possible values: unit_of_measurement, domain__device_class or entity_id.

default_measurement string (Optional)

Measurement name to use when the measurement_attr state attribute does not exist, e.g. when an entity doesn’t have a unit.

Default:

uses the entity id of the entity

override_measurement string (Optional)

Measurement name to use instead of measurement_attr or default measurement. This will store all data points in a single measurement.

exclude list (Optional)

Configure which integrations should be excluded from recording to InfluxDB. (Configure Filter)

entities string | list (Optional)

The list of entity ids to be excluded from recording to InfluxDB.

entity_globs string | list (Optional)

Exclude all entities matching a listed pattern.

domains string | list (Optional)

The list of domains to be excluded from recording to InfluxDB.

include list (Optional)

Configure which integrations should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. (Configure Filter)

entities string | list (Optional)

The list of entity ids to be included in recording to InfluxDB.

entity_globs string | list (Optional)

Include all entities matching a listed pattern.

domains string | list (Optional)

The list of domains to be included in recording to InfluxDB.

tags string | list

Tags to mark the data.

tags_attributes string | list (Optional, default: 0)

The list of attribute names which should be reported as tags and not fields to InfluxDB. For example, if set to friendly_name, it will be possible to group by entities’ friendly names as well, in addition to their ids.

ignore_attributes string | list (Optional)

The list of attribute names to ignore when reporting to InfluxDB. This can be used to filter out attributes that either don’t change or don’t matter to you in order to reduce the amount of data stored in InfluxDB.

component_config string (Optional)

This attribute contains component-specific override values. See Customizing devices and services for format.

override_measurement string (Optional)

Measurement name to use instead of a unit or default measurement. This will store all data points in a single measurement.

ignore_attributes string | list (Optional)

The list of attribute names to ignore when reporting to InfluxDB. Will be merged with the default ignore_attributes list when processing a state change event for a particular entity.

component_config_domain string (Optional)

This attribute contains domain-specific integration override values. See Customizing devices and services for format.

override_measurement string (Optional)

Measurement name to use instead of a unit or default measurement. This will store all data points in a single measurement.

ignore_attributes string | list (Optional)

The list of attribute names to ignore when reporting to InfluxDB. Will be merged with the default ignore_attributes list when processing a state change event for a particular entity.

component_config_glob string (Optional)

This attribute contains component-specific override values. See Customizing devices and services for format.

override_measurement string (Optional)

Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.

ignore_attributes string | list (Optional)

The list of attribute names to ignore when reporting to InfluxDB. Will be merged with the default ignore_attributes list when processing a state change event for a particular entity.

Configure Filter

By default, no entity will be excluded. To limit which entities are being exposed to InfluxDB, you can use the include and exclude parameters.

# Example filter to include specified domains and exclude specified entities
influxdb:
  include:
    domains:
      - alarm_control_panel
      - light
    entity_globs:
      - binary_sensor.*_occupancy
  exclude:
    entities:
      - light.kitchen_light

Filters are applied as follows:

  1. No includes or excludes - pass all entities
  2. Includes, no excludes - only include specified entities
  3. Excludes, no includes - only exclude specified entities
  4. Both includes and excludes:
    • Include domain and/or glob patterns specified
      • If domain is included, and entity not excluded or match exclude glob pattern, pass
      • If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
      • If domain is not included, glob pattern does not match, and entity not included, fail
    • Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
      • If domain is excluded and entity not included, fail
      • If entity matches exclude glob pattern and entity not included, fail
      • If entity does not match any exclude criteria (domain, glob pattern or listed), pass
    • Neither include or exclude specifies domains or glob patterns
      • If entity is included, pass (as #2 above)
      • If entity include and exclude, the entity exclude is ignored

Examples

Full configuration for 1.xx installations

influxdb:
  host: 192.168.1.190
  port: 20000
  database: DB_TO_STORE_EVENTS
  username: MY_USERNAME
  password: MY_PASSWORD
  ssl: true
  verify_ssl: true
  max_retries: 3
  default_measurement: state
  exclude:
    entities:
       - entity.id1
       - entity.id2
    domains:
       - automation
  include:
    entities:
       - entity.id3
       - entity.id4
  tags:
    instance: prod
    source: hass

Full configuration for 2.xx installations

influxdb:
  api_version: 2
  ssl: false
  host: localhost
  port: 9999
  token: GENERATED_AUTH_TOKEN
  organization: RANDOM_16_DIGIT_HEX_ID
  bucket: BUCKET_NAME
  tags:
    source: HA
  tags_attributes:
    - friendly_name
  default_measurement: units
  exclude:
    entities:
      - zone.home
    domains:
      - persistent_notification
      - person
  include:
    domains:
      - sensor
      - binary_sensor
      - sun
    entities:
      - weather.home

Sensor

The influxdb sensor allows you to use values from an InfluxDB database to populate a sensor state. This can be used to present statistics as Home Assistant sensors, if used with the influxdb history component. It can also be used with an external data source.

You must configure the influxdb history component in order to create influxdb sensors. If you just want to create sensors for an external InfluxDB database and you don’t want Home Assistant to write any data to it you can exclude all entities like this:

influxdb:
  exclude:
    entity_globs: "*"

Configuration

To configure this sensor, you need to define the sensor connection variables and a list of queries to your configuration.yaml file. A sensor will be created for each query:

# Example configuration.yaml entry
sensor:
  - platform: influxdb
    queries:
      - name: mean value of foo
        where: '"name" = ''foo'''
        measurement: '"°C"'

Note that 2.xx installations of InfluxDB only support queries in their Flux language. While this language was available in 1.xx installations, it was not the default and not used in the API so you may not be aware of it. You can learn more about it from their documentation or by using the query builder in the UI.

You will need to construct your queries in this language in sensors for 2.xx installations, it looks like this:

# Example configuration.yaml entry
sensor: 
  - platform: influxdb
    api_version: 2
    organization: RANDOM_16_DIGIT_HEX_ID
    token: GENERATED_AUTH_TOKEN
    queries_flux: 
      - group_function: mean
        imports: 
          - strings
        name: "Mean humidity reported from past day"
        query: >
          filter(fn: (r) => r._field == "value" and r.domain == "sensor" and strings.containsStr(v: r.entity_id, substr: "humidity"))
          |> keep(columns: ["_value"])
        range_start: "-1d"

Configuration Variables

api_version string

API version to use. Valid values are 1 or 2.

ssl boolean (Optional, default: false)

Use HTTPS instead of HTTP to connect. 2.xx - Defaults to true for 2.xx, otherwise false.

host string (Optional, default: localhost)

IP address or domain of your database host, e.g., 192.168.1.10. 2.xx - Defaults to ‘us-west-2-1.aws.cloud2.influxdata.com’ for 2.xx, not ‘localhost’.

port integer (Optional, default: 8086)

Port to use. 2.xx - No default port for 2.xx, otherwise 8086.

path string (Optional)

Path to use if your InfuxDB is running behind a reverse proxy.

username string (Inclusive)

1.xx only - The username of the database user. The user needs read/write privileges on the database.

password string (Inclusive)

1.xx only - The password for the database user account. Needed with username configuration variable.

database string (Optional, default: home_assistant)

1.xx only - Name of the database to use. The database must already exist. Sets the default database for sensors, individual sensors can also read from a different database.

verify_ssl boolean (Optional, default: true)

1.xx only - Verify SSL certificate for HTTPS request. For 2.xx SSL verification is required, library provides no way to disable it.

token string (Inclusive)

2.xx only - Auth token with READ access to your chosen Organization and Bucket. Needed with organization configuration variable.

organization string (Inclusive)

2.xx only - Organization ID to read from. To obtain this, open the UI of your 2.xx installation, the URL at the top will have it after /orgs. For example, in InfluxDB Cloud it looks like this: https://us-west-2-1.aws.cloud2.influxdata.com/orgs/{OrganizationID}. Needed with token configuration variable.

bucket string (Optional, default: Home Assistant)

2.xx only - Name of the bucket (not the generated bucket ID) within your Organization to read from. This sets the default bucket for sensors, individual sensors can also read from a different bucket.

queries list Required

1.xx only - List of InfluxQL queries.

name string Required

The name of the sensor.

unit_of_measurement string (Optional)

Defines the units of measurement of the sensor, if any.

measurement string Required

Defines the measurement name in InfluxDB (the FROM clause of the query).

where template Required

Defines the data selection clause (the where clause of the query). This supports templates.

value_template template (Optional)

Defines a template to extract a value from the payload.

database string (Optional, default: home_assistant)

Name of the database to use.

group_function string (Optional, default: mean)

The group function to be used.

field string Required, default: value

The field name to select.

queries_flux list Required

2.xx only - List of Flux queries.

name string Required

The name of the sensor.

unit_of_measurement string (Optional)

Defines the units of measurement of the sensor, if any.

range_start string (Optional, default: -15m)

Duration or time value to start range from. All Flux queries require a range filter, one is automatically added to the beginning of your Flux query in the form of range(start: {range_start}, stop: {range_stop}).

range_stop string (Optional, default: now())

Duration or time value to stop range at. See range_start above for how this is used in query.

query template Required

One or more flux filters used to get to the data you want. These should limit resultset to one table, or any beyond the first will be ignored. Your query should not begin or end with a pipe (|>). This supports templates.

group_function string (Optional)

The group function to be used. If provided, this will add a filter to the end of your query like this {group_function}(column: "_value"). Note that unlike the 1.xx queries, this does not default to mean. You can omit if you wish to use your own aggregator, which takes additional/different parameters or want to act on a different column. If omitted, then a filter of limit(n: 1) will be added to the end instead to restrict to one result per table.

value_template template (Optional)

Defines a template to extract a value from the payload. Note that value will be set to the value of the _value field in your query output.

bucket string (Optional, default: Home Assistant)

Name of the bucket within your Organization to read from.

imports string | list (Optional)

Libraries to import in order to execute your query. Ex. strings, date, experimental/query, etc.

Examples

Full configuration for 1.xx installations

The example configuration entry below create two request to your local InfluxDB instance, one to the database db1, the other to db2:

  • select last(value) as value from "°C" where "name" = "foo"
  • select min(tmp) as value from "%" where "entity_id" = ''salon'' and time > now() - 1h
sensor:
  platform: influxdb
  host: localhost

username: home-assistant
  password: password
  queries:
    - name: last value of foo
      unit_of_measurement: °C
      value_template: '{{ value | round(1) }}'
      group_function: last
      where: '"name" = ''foo'''
      measurement: '"°C"'
      field: value
      database: db1
    - name: Min for last hour
      unit_of_measurement: '%'
      value_template: '{{ value | round(1) }}'
      group_function: min
      where: '"entity_id" = ''salon'' and time > now() - 1h'
      measurement: '"%"'
      field: tmp
      database: db2

Full configuration for 2.xx installations

sensor:
  - platform: influxdb
    api_version: 2
    token: GENERATED_AUTH_TOKEN
    organization: RANDOM_16_DIGIT_HEX_ID
    bucket: BUCKET_NAME
    queries_flux:
      - range_start: "-1d"
        name: "How long have I been here"
        query: >
          filter(fn: (r) => r._domain == "person" and r._entity_id == "me" and r._value != " {{ states('person.me') }} ")
          |> map(fn: (r) => ({ _value: r._time }))
        value_template: " {{ relative_time(strptime(value, '%Y-%m-%d %H:%M:%S %Z')) }} "
      - range_start: "-1d"
        name: "Cost of my house today across all power sensor"
        query: >
          filter(fn: (r) => r.domain == "sensor" and r._field == "value" and regexp.matchRegexpString(r: /_power$/, v: r.entity_id))
          |> keep(columns: ["_value", "_time"])
          |> sort(columns: ["_time"], desc: false)
          |> integral(unit: 5s, column: "_value")
        imports: regexp
        value_template: " {{ value|float / 24.0 / 1000.0 * states('sensor.current_cost_per_kwh')|float }} "
      - range_start: "-1d"
        bucket: Glances Bucket
        name: "Average CPU temp today"
        query: "filter(fn: (r) => r._field == \"value\" and r.entity_id == \"glances_cpu_temperature\")"
        group_function: mean

Note that when working with Flux queries, the resultset is broken into tables, you can see how this works in the Data Explorer of the UI. If you are operating on data created by the InfluxDB history component, this means by default, you will have a table for each entity and each attribute of each entity (other then unit_of_measurement and any others you promoted to tags).

This is a lot more tables compared to 1.xx queries, where you essentially had one table per unit_of_measurement across all entities. You can still create aggregate metrics across multiple sensors though. As you can see in the example above, a good way to do this is with the keep or drop filters. When you remove key columns Influx merges tables, allowing you to make many tables that share a schema for _value into one.