https://github.com/rak00n/probe
Small infrastructure monitoring solution with Telegram integration
https://github.com/rak00n/probe
infrastructure monitoring notifications probe raid relay status telegram telegram-bot
Last synced: about 2 months ago
JSON representation
Small infrastructure monitoring solution with Telegram integration
- Host: GitHub
- URL: https://github.com/rak00n/probe
- Owner: Rak00n
- Created: 2023-08-30T18:59:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-31T08:01:58.000Z (over 2 years ago)
- Last Synced: 2024-01-29T09:49:48.746Z (about 2 years ago)
- Topics: infrastructure, monitoring, notifications, probe, raid, relay, status, telegram, telegram-bot
- Language: Go
- Homepage:
- Size: 7.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# probe
Small infrastructure monitoring solution with Telegram integration
### Features
- Windows and Linux agents
- Free Space on device tracking (see example configs)
- Linux RAID health monitoring (real reason for the app)
- Telegram Notifications
- Chaining probes for isolated infrastructure. ( isolatedProbe1 -> isolatedProbe2:49854 -> isolatedProbe3:49854 -> on-lineProbe:49854 -> Telegram)
- AES-encryption for notification transfer
#### Telegram Notifications
Telegram Bot Token is required. It must be set in configuration file. You can get your token with [Telegram Help Page](https://core.telegram.org/bots/tutorial "Telegram Help Page")
#### Configuration file
Configuration file is in JSON format.
- UUID - Unique ID. Any alphanumeric characters. It is not used in current version of the app but will be part of high-level logic in future releases.
- Host - Your machine name. This value will be displayed in Telegram notifications.
- Secret - Any alphanumeric characters. It is used to encrypt data transfered between several probes.
- RelayTo - "telegram" - send notifications via Telegram (requires internet accessibility). "probe" - send notifications to another **probe**
- ListenAddress - host:port to listen for incomming notifications from other probes and relaying them according to **RelayTo**. Complex chains are supported.
- TelegramBotKey - BOT secret key. It is required to send notifications via Telegram. You can get your token with [Telegram Help Page](https://core.telegram.org/bots/tutorial "Telegram Help Page")
- TelegramUserID - Your Telegram User ID. You can get it via third-party services on the Internet or by starting the probe with "TelegramUserID":"000000000" and sending "/getmyid" command into the bot.
- Jobs - Scheduled tasks. Each task must be described as embedded JSON. See example configuration files.
### Build
Windows Probe
`$ GOOS=windows go build -o probe.exe`
Linux Probe
`$ GOOS=linux go build -o probe`