Bot meant to perform maintenance tasks in a crontab fashion and to report via a Mastodon-like API. The idea is to serve as a framework to keep adding tasks and have this bot as a companion, caring about the system for you.

Current features:

• Collect system metrics and compare them with given thresholds, publishing an alert in case these get grossed.
• Sending the system metrics to another Janitor instance runnining in another host.
• Listening for Janitor metrics across the network.
• Listening for arbitrary messages to be published to the set up Mastodon-like API, behaving as a generic publisher
• Discovering the current external IP and updating the set up Directnic's Dynamic DNS if needed
• Monitor Git repositories and publish their changes

• Python 3.9
• Poetry

Following the official docs, or skip this step if you already have it installed

curl -sSL https://install.python-poetry.org | python3 -

git clone [email protected]:XaviArnaus/janitor.git

cd janitor

From version 0.5.0 onwards, the configuration is split in several files:

• main: General parameters. Includes listener and generic storage parameters
• mastodon: Parameters regarding the main Mastodon API instance configuration for publishing.
• schedules: Scheduler parameters, like which tasks to run and when to do so.
• sysinfo: Parameters about the system metrics collection modules.
• directnic_ddns: Parameters for the Directnic's Dynamic DNS registers updater module.
• git_monitor: Parameters regarding the Git monitor module.

Just bring the configs you need out of the examples, like:

cp config/main.yaml.dist config/main.yaml

nano config/main.yaml

Depending on how you'll want this bot instance to behave, there are some mandatory parameters to set up. The config file is quite well documented. Later on this document there are sections explaining which modules can be set, what are they and how to set them up.

make init

And now the app is ready to run!

These are the current features and how to set them up.

Janitor was initially designed as a bot that collects system metrics periodically, compares the values to a given set of thresholds, and publishes a message to a Mastodon-like API in case they are crossed.

• Read the System metrics collection and alerting page

Janitor can discover the current external IP and monitor for changes, and then update Directnic's Dynaminc DNS registers.

• Read the Directnic's Dynamic DNS Updater page

Janitor can monitor commits or changes in the CHANGELOG files from given Git repositories and alert via a Mastodon-like API about the changes. This is a gret tool to automatically announce code changes and also to monitor external repositories to be on top of updates to fetch.

• Read the Git rempositories monitor page

Once Janitor can perform multiple tasks, makes sense to proxy the periodicity by having a single Scheduler that sets up the diverse tasks. The Scheduler will read the crontab fashion time setup from the configuration file and trigger the defined tasks accordingly.

• Read the Scheduler page

Janitor is also shipped with a CLI tool to execute all the runners and to trigger some tasks.

• Read the CLI tool page