Skip to main content

A Discord bot that observes a local machine, issues warnings and can be queries from Discord chat.

Project description

GitHub release GitHub code size in bytes MHTML License PyPI supported Python versions Code style: black

A simple python Discord bot that observes a local machine and sends notifications on resource exhaustion. It allows additionally to query the machine status via Discord.

It registers the following command:

  • dbot-observe - a blocking script, that runs periodic system checks and notifies about shortages (may require extra dependencies to be installed for more information)

Requirements

  • Python >= 3.6 (see badges above)
  • discord.py
  • psutil (for cpu/ram/disk information querying)
  • Extra:
    • gpu: GPUtil
    • plot: matplotlib, for generating plots

Installation

python3 -m pip install discord-system-observer-bot

Optionally, install it locally with --user.

For GPU infos, you have to install extra dependencies: gpu (nvidia-smi information):

python3 -m pip install discord-system-observer-bot[gpu]

Configuration

Configuration is done by placing a .dbot.conf file in one of the following directories:

  • $HOME/.dbot.conf
  • $HOME/dbot.conf
  • ./.dbot.conf
  • ./dbot.conf
  • /etc/dbot.conf

Alternatively a configuration file can be provided via -c/--config CLI options.

The configuration file should be a standard INI file. A template can be found in the templates folder. All configurations are placed under the discord-bot section.

Example:

[discord-bot]
# the bot token (used for login)
token = abc
# the numeric id of a channel, can be found when activating the developer options in appearances
channel = 123

Usage

dbot-observe is the main entry-point.

Print help and available options:

dbot-observe -h

Output:

usage: dbot-observe [-h] [-c CONFIG] [-d] [-n NAME]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Config file
  -d, --debug           Enable debug logging
  -n NAME, --name NAME  Local machine name (id)

Starting the observer bot (without actually starting the background observation, just waiting for a Discord message to start/stop etc.):

dbot-observe

You are always able to specify the configuration file like this:

dbot-observe -c /path/to/dbot.conf [...]

To display debugging information (api calls, log messages etc.):

dbot-observe -d [...]

You may also run the bot with the python module notation. But it will only run the same entry-point like dbot-observe.

python -m discord_system_observer_bot [...]

System Observer Bot

The dbot-observe command runs a looping Discord task that checks every 5 min some predefined system conditions, and sends a notification if a badness value is over a threshold. This badness value serves to either immediatly notify a channel if a system resource is exhausted or after some repeated limit exceedances.

The code (checks and limits) can be found in discord_system_observer_bot.sysinfo. The current limits are some less-than educated guesses, and are subject to change. Dynamic configuration is currently not an main issue, so users may need to clone the repo, change values and install the python package from source:

git clone https://github.com/Querela/discord-system-observer-bot.git
cd discord-system-observer-bot/
# [do the modifications in discord_system_observer_bot/sysinfo.py]
python3 -m pip install --user --upgrade --editable .[gpu,plot]

The system information gathering may require the extra dependencies to be installed, like gpu for GPU information, or plot for series charts.

I suggest that you provide a different Discord channel for those notifications and create an extra .dbot-observer.conf configuration file that can then be used like this:

dbot-observe [-d] -c ~/.dbot-observer.conf

Embedded in other scripts

Sending messages is rather straightforward. More complex examples can be found in the CLI entrypoints, see file discord_system_observer_bot.cli. Below are some rather basic examples (extracted from the CLI code).

Basic setup (logging + config loading):

from discord_system_observer_bot.cli import setup_logging, load_config

# logging (rather basic, if needed)
setup_logging(True)

# load configuration file (provide filename or None)
configs = load_config(filename=None)

Sending a message:

from discord_system_observer_bot.bot import run_observer

# bot token and channel_id (loaded from configs or hard-coded)
bot_token, channel_id = configs["token"], configs["channel"]
# start the observer running (blocks forever)
run_observer(bot_token, channel_id, message)

Bot Creation etc.

See information provided by:

Short description

You have to own a Discord server! Or know someone with administrator/moderation(?) privileges.

  1. Visit and login to the Discord developer page.
  2. Create a new application. The given name is also the visible name of the bot. (default, can be changed later?)
  3. Create a bot (on the Bot page). You should disable the Public Bot option.
    • The bot login token (credentials) can be found on the Bot page.
  4. Change to the OAuth2 page and check
    • Scopes: Bot
    • Bot Permissions: Send Messages, Attach Files (in the Text Permissions column)
  5. Copy the URL in the Scopes section and paste it in a new browser tab.
    • Now you can choose one (?) of your own Discord servers to add the bot to. (For this you need server administration permissions, or be the owner..?)

To get the channel id, send the following message on your server \#channelname, or enable developer options. You may want to visit the following pages for more information:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for discord-system-observer-bot, version 0.0.5
Filename, size File type Python version Upload date Hashes
Filename, size discord_system_observer_bot-0.0.5-py3-none-any.whl (20.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size discord-system-observer-bot-0.0.5.tar.gz (17.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page