discord-watchdog

A relatively simple Discord bot that notifies users when an internet resource becomes accessible or inaccessible.

It uses:

• poise as its bot framework
• surge-ping for ICMP pings

The watchdog pings the selected resource at regular intervals. If the resource becomes available after an outage, the bot notifies a specified Discord role.

Originally created to monitor the BYOND Hub during persistent DDoS attacks, the bot is configured to:

• Ping users when the resource comes back online
• Only send a silent notification (no ping) when the resource goes down

Customize messages in Config.toml if you want to change this behaviour.

Screenshots

Config

Configuration is managed via Config.toml in the bot's executable directory. See Config.example.toml for reference syntax.

Important

You must set the master_server setting and replace [server_configs.1159410563235822656] with [server_configs.*your_master_server_id*] (where *your_master_server_id* is the ID you set earlier). (Image).

If you configure everything correctly, your server will be automatically registered as the Master Server.

• Commands marked with [M ONLY] can only be run on the Master Server.
• If you set max_servers to a value greater than 1, others can add your bot to their servers.
  • After adding it, they must use /server register to register their server.
  • They should then configure /config role and /config channel (optionally, /config message).

You can:

• Check where your bot is installed using /server show.
• Unregister individual servers or all servers with /server remove.

Warning

After the first launch, the bot creates Data.toml to store runtime configuration. Subsequent starts will ignore Config.toml unless you either:

1. Delete Data.toml, or
2. Run the config reset command

Commands

All slash commands except info require MANAGE_CHANNELS (empirical choice) permissions:

Command	Description
config reset	[M ONLY] Restores configuration to Config.toml defaults (or hardcoded defaults if absent)
config name	[M ONLY] Changes the monitored resource's name
config address	[M ONLY] Updates the monitored resource's address
config interval	[M ONLY] Adjusts the delay between ping attempts
config timeout	[M ONLY] Changes the ping attempt timeout duration
config attempts	[M ONLY] Changes amount of attempts, neccessary to change resource's status
config channel	Changes the notification channel
config role	Modifies the role pinged when the resource changes status
config message	Modifies messages, which are sent by bot on status change. Use %%RESOURCE%% and %%ROLE%% template variables
debug logs	[M ONLY] Sends ephemeral debug.log
debug data	[M ONLY] Sends ephemeral Data.toml
info	Displays information about the bot
server register	Registers current server
server show	[M ONLY] Shows all registered servers
server remove	[M ONLY] Unregisters individual server or all servers
server limit	[M ONLY] Changes maximum amount of registered servers

Installation

From Releases

1. Download the latest release archive from GitHub.
2. Extract the files to your preferred location.
3. Create an application on the Discord Developer Portal. Customize the name, description, etc., if necessary (Image).
4. Create a bot for this application and get your bot's Token. It may be displayed already, or you may need to press the Reset Token button (Image).
5. Select the Manage Messages and Send Messages permissions for your bot (Image).
6. Set your Token as DISCORD_TOKEN in .env. Consider setting INTERACTIVE in .env to 0, if you are running this bot on a server.
7. Customize Config.toml as needed.
8. Add your bot to your Discord server.
9. Run the executable.

From Source

1. Clone the repository from GitHub.
2. Ensure you have Cargo and Rust installed.
3. Build the source code using cargo build --release.
4. Move the executable from ./target/release to your desired location.
5. Create an application on the Discord Developer Portal. Customize the name, description, etc., if necessary (Image).
6. Create a bot for this application and get your bot's Token. It may be displayed already, or you may need to press the Reset Token button (Image).
7. Select the Manage Messages and Send Messages permissions for your bot (Image).
8. Copy Config.example.toml to the same location, rename it to Config.toml, and customize it as needed.
9. Copy .env.example to the same location, rename it to .env. Set your Token as DISCORD_TOKEN in .env. Consider setting INTERACTIVE in .env to 0, if you are running this bot on a server.
10. Add your bot to your Discord server.
11. Run the executable.

Tip

All logs are written to both standard output and ./debug.log. For more detailed ping request information, set TRACING = 1 in your .env file to log every ping attempt. Careful: These logs can grow large quickly!

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Not affiliated with BYOND or Discord. All trademarks belong to their respective owners.