From 9403f55785ab8da81565ddbe4c73f12a335dab5e Mon Sep 17 00:00:00 2001 From: krusty Date: Tue, 17 May 2022 21:11:04 +0200 Subject: [PATCH] README.md: adding bullet desc, minor refactor --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11db72d..8d483dc 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,40 @@ # savla-dish (golang1.17) -tiny monitoring one-shot service, clusterable (peer-to-peer idea TBD) and fast (quick load and exec time, 5s timeout per socket) + + __tiny__ monitoring one-shot service + + __clusterable__ (peer-to-peer idea **TBD**), remote configuration of independent 'dish network' (`-source=$REMOTE_JSON_API_URL`) + + __fast__ (quick load and exec time, 5s timeout per socket -- hardcoded), instant messaging connectors + +``` +$ go get github.com/savla-dev/savla-dish + +$ savla-dish -h +Usage of go/bin/savla-dish: + -source string + a string, path to/URL JSON socket list (default "demo_sockets.json") + -telegram + a bool, Telegram provider usage toggle + -telegramBotToken string + a string, Telegram bot private token + -telegramChatID string + a string/signet int, Telegram chat/channel ID + -verbose + a bool, console stdout logging toggle +``` ## use-cases the idea of a tiny one-shot service comes with the need of a quick monitoring service implementation over HTTP/S and generic TCP endpoints (more like 'sockets' = hosts and their ports) +### socket list + the list of sockets can be provided via a local JSON-formated file, or via remote REST/RESTful JSON-returning API (JSON structure has to be of the same structure anyway; see `demo_sockets.json`) +### alerting + as the alerting system (in case of socket test timeout threshold hit, or an unexpected HTTP response code) we provide a simple embedded `messenger` with Telegram IM implementation example (see `messenger/messenger.go`); since the Telegram bot token and the potential Telegram chat ID are considered as the **secrets**, we do recommend including these to the custom, local, binary executable instead of passing them into the CLI shell (security breach as secrets can then leak in process list) +## examples + ``` # get the actual git version go get github.com/savla-dev/savla-dish