Adding upstream version 1.3.0.upstream/1.3.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 50 insertions, 0 deletions

diff --git a/doc/03-CustomVars.md b/doc/03-CustomVars.md
new file mode 100644
index 0000000..cfd4b74
--- /dev/null
+++ b/doc/03-CustomVars.md
@@ -0,0 +1,50 @@
+Custom Variables
+================
+
+The monitoring integration of this module can use custom variables from the
+Icinga context to control display and filtering of the integration.
+
+Also see [Configuration](02-Configuration.md) on how to configure the features.
+
+Custom variables control:
+
+* If the EventDB integration and actions are shown for a host or service
+* How the linked results should be filtered
+
+## Examples
+
+For Icinga 2:
+
+```icinga2
+object Host "test" {
+  import "generic-host"
+  
+  address = "127.0.0.1"
+  
+  vars.edb = "1"
+  vars.edb_filter = "priority!=7&priority!=5&priority!=6&ack=0"
+  // ...
+}
+```
+
+For Icinga 1.x:
+
+```nagios
+define host {
+  use         generic-host
+  host_name   test
+  
+  address 127.0.0.1
+  
+  _edb        1
+  _edb_filter priority!=7&priority!=5&priority!=6&ack=0
+}
+```
+
+**Note:** A filter by `host_name` will always be added, unless you have `host_name` as part of your filter.
+
+## Legacy filters
+
+The module also supports legacy JSON filters from the icinga-web 1.x EventDB module.
+
+Please see the `examples` directory of this module for some supported filters.