From: Thomas Widhalm <thomas.widhalm@icinga.com>
Date: Fri, 29 Mar 2019 15:50:33 +0000 (+0100)
Subject: Add command `icingacli-elasticsearch` to ITL
X-Git-Tag: v2.11.0-rc1~175^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=refs%2Fpull%2F7064%2Fhead;p=icinga2

Add command `icingacli-elasticsearch` to ITL

fixes #7063
---

diff --git a/doc/10-icinga-template-library.md b/doc/10-icinga-template-library.md
index 4b7f13acc..bc76849d3 100644
--- a/doc/10-icinga-template-library.md
+++ b/doc/10-icinga-template-library.md
@@ -2718,6 +2718,24 @@ Name                                      | Description
 icingacli_director_check                  | **Optional.** Run only a specific test suite.
 icingacli_director_db                     | **Optional.** Use a specific Icinga Web DB resource.
 
+#### Elasticsearch <a id="plugin-contrib-icingacli-elasticsearch"></a>
+
+This subcommand is provided by the [elasticsearch_module](https://github.com/Icinga/icingaweb2-module-elasticsearch) and executed as `icingacli elasticsearch check`.
+
+* The value of `icingacli_elasticsearch_instance` is the same like in the configuration of the module.
+* The value of `icingacli_elasticsearch_filter` are filters for events in Icinga Web 2 syntax. e.g. `"beat.hostname=www.example.com" AND severity=critical`
+* The thresholds are just numerical values. They get checked against how many events match the filter within the given timeframe.
+* The value of `icingacli_elasticsearch_index` is an index pattern. e.g. `logstash*`
+
+Name                                      | Description
+------------------------------------------|-----------------------------------------------------------------------------------------
+icingacli_elasticsearch_instance          | **Required.** The Elasticsearch to connect to
+icingacli_elasticsearch_index             | **Required.** Index pattern to use when searching
+icingacli_elasticsearch_critical          | **Required.** Critical threshold
+icingacli_elasticsearch_warning           | **Required.** Warning threshold
+icingacli_elasticsearch_filter            | **Required.** Filter for events
+icingacli_elasticsearch_from              | **Optional.** Negative value of time to search from now (Default: -5m)
+
 ### IPMI Devices <a id="plugin-contrib-ipmi"></a>
 
 This category includes all plugins for IPMI devices.
diff --git a/itl/plugins-contrib.d/icingacli.conf b/itl/plugins-contrib.d/icingacli.conf
index 1d27ab2ca..39dc0497f 100644
--- a/itl/plugins-contrib.d/icingacli.conf
+++ b/itl/plugins-contrib.d/icingacli.conf
@@ -68,3 +68,37 @@ object CheckCommand "icingacli-director" {
         }
 }
 
+object CheckCommand "icingacli-elasticsearch" {
+        import "icingacli"
+
+        command += [ "elasticsearch", "check" ]
+
+        arguments = {
+                "--instance" = {
+                        value = "$icingacli_elasticsearch_instance$"
+                        description = "Elasticsearch instance to connect to"
+                }
+                "--crit" = {
+                        value = "$icingacli_elasticsearch_critical$"
+                        description = "Critical threshold"
+                }
+                "--warn" = {
+                        value = "$icingacli_elasticsearch_warning$"
+                        description = "Warning threshold"
+                }
+                "--index" = {
+                        value = "$icingacli_elasticsearch_index$"
+                        description = "Index pattern to use when searching"
+                }
+                "--filter" = {
+                        value = "$icingacli_elasticsearch_filter$"
+                        description = "Filter for events"
+                }
+                "--from" = {
+                        value = "$icingacli_elasticsearch_from$"
+                        description = "Negative value of time to search from now"
+                }
+        }
+
+}
+