[icinga-checkins] icinga.org: icinga2-api-examples/master: go-icinga2-events: Update README

git at icinga.org git at icinga.org
Tue Oct 18 21:55:45 CEST 2016


Module: icinga2-api-examples
Branch: master
Commit: 2f86453daa389f51952aad49a93a1d1f84578183
URL:    https://git.icinga.org/?p=icinga2-api-examples.git;a=commit;h=2f86453daa389f51952aad49a93a1d1f84578183

Author: Michael Friedrich <michael.friedrich at icinga.com>
Date:   Sat Oct 15 22:37:06 2016 +0200

go-icinga2-events: Update README

---

 go-icinga2-events/README.md |   23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/go-icinga2-events/README.md b/go-icinga2-events/README.md
index c2330d3..ae69ad9 100644
--- a/go-icinga2-events/README.md
+++ b/go-icinga2-events/README.md
@@ -24,17 +24,26 @@ Therefore add a new ApiUser object to your Icinga 2 configuration:
       permissions = [ "events" ]
     }
 
-## Script
+# Configuration
+
+**TODO**: Hardcoded inside the script.
+
+* API URL, Username, Password
+* SSL Verification
 
-Build and run the binary.
+# Run
+
+Build and run the binary. There are currently no external libraries required.
 
     export GOPATH=`pwd`
     go build
     ./go-icinga2-events
 
-# Configuration
-
-**TODO**: Hardcoded inside the script.
+# TODO
 
-* API URL, Username, Password
-* SSL Verification
+* Config file for API credentials
+* Support for multiple types (currently CheckResult hardcoded)
+ * This requires mapping the static structs to the JSON messages
+* Support for definable hooks (e.g. "OnStateChange", "OnFlappingDetected", etc.) for easier demos
+* Support for triggering API actions on specific events (reschedule a check, auto-acknowledge problems based on a specific custom attributes, etc.)
+* Support for querying objects on demand (the event message payload doesn't provide them)



More information about the icinga-checkins mailing list