Splunk


The splunk integration makes it possible to log all state changes to an external Splunk database using Splunk’s HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk app. Since the HEC feature is new to Splunk, you will need to use at least version 6.3.

Configuration

To use the splunk integration in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
splunk:
  token: YOUR_SPLUNK_TOKEN

Configuration Variables

token

(string)(Required)

The HTTP Event Collector Token already created in your Splunk instance.

host

(string)(Optional)

IP address or host name of your Splunk host, e.g., 192.168.1.10.

Default value:

localhost

port

(integer)(Optional)

Port to use.

Default value:

8080

ssl

(boolean)(Optional)

Use HTTPS instead of HTTP to connect.

Default value:

false

verify_ssl

(boolean)(Optional)

Allows you do disable checking of the SSL certificate.

Default value:

false

name

(string)(Optional)

This parameter allows you to specify a friendly name to send to Splunk as the host, instead of using the name of the HEC.

Default value:

HASS

filter

(map)(Optional)

Filters for entities to be included/excluded from Splunk. Default is to include all entities.

include_domains

(list)(Optional)

Domains to be included.

include_entities

(list)(Optional)

Entities to be included.

exclude_domains

(list)(Optional)

Domains to be excluded.

exclude_entities

(list)(Optional)

Entities to be excluded.