Skip to content

Commit

Permalink
README.md: adding bullet desc, minor refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
krustowski committed May 17, 2022
1 parent 881cd02 commit 9403f55
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 9403f55

Please sign in to comment.