From b9b69b501125d60f02ce82c39398add2485f3a2c Mon Sep 17 00:00:00 2001 From: Alex Sleeis Date: Wed, 10 Jul 2019 15:58:33 -0700 Subject: [PATCH 1/3] Adding documentation for Splunk Component entity filter support. --- source/_components/splunk.markdown | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index a5b1ed956ff4..c9e70d41382f 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -8,16 +8,15 @@ comments: false sharing: true footer: true logo: splunk.png -ha_category: - - "History" +ha_category: "History" ha_release: 0.13 --- -The `splunk` integration makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. +The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. -## Configuration +## {% linkable_title Configuration %} -To use the `splunk` integration in your installation, add the following to your `configuration.yaml` file: +To use the `splunk` component in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -55,4 +54,25 @@ name: required: false default: HASS type: string +filter: + description: Filters for entities to be included/excluded from Splunk. Default is to include all entities. + required: false + type: map + keys: + include_domains: + description: Domains to be included. + required: false + type: list + include_entities: + description: Entities to be included. + required: false + type: list + exclude_domains: + description: Domains to be excluded. + required: false + type: list + exclude_entities: + description: Entities to be excluded. + required: false + type: list {% endconfiguration %} From ae802fc21106116fc62c1c7b6467aa75f22a5f01 Mon Sep 17 00:00:00 2001 From: Alex S Date: Fri, 12 Jul 2019 21:35:01 -0700 Subject: [PATCH 2/3] Applying recommended cleanup suggestion Co-Authored-By: Klaas Schoute --- source/_components/splunk.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index c9e70d41382f..623d3ef393d7 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: splunk.png -ha_category: "History" +ha_category: + - History ha_release: 0.13 --- From 9f34d0c8d87398982b63e52b5af6036e2d962ad5 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 13 Jul 2019 15:15:04 +0200 Subject: [PATCH 3/3] :pencil2: Tweaks --- source/_components/splunk.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index 623d3ef393d7..7dfbadd44ef7 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.13 --- -The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. +The `splunk` integration makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. -## {% linkable_title Configuration %} +## Configuration -To use the `splunk` component in your installation, add the following to your `configuration.yaml` file: +To use the `splunk` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry