DISKU - disk usage monitor utility

This is a server/client based utility to monitor disk usage

Requirements

Server Requirements

• python 3.5+
• pip
• python3 -m pip install -r requirements.txt (you may need to use sudo -H)

Client Requirements

• python 3.5+

Server Configuration

Alarm Config

Here's a example:

alarm_conditions = USED > 95%%, FREE < 5G

It will trigger alarm if used / total > 0.95 or free < 5 * (1024**3)

Alarm Conditions Syntax

Please notice that we use %% because of the feature from configparser package

digit_wo_zero ::= "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
digit         ::= "0" | digit_wo_zero;
integer       ::= digit | digit_wo_zero { digit };
percent_char  ::= "%%";
percentage    ::= digit percent_char | digit_wo_zero digit percent_char | "100" percent_char;
size_suffix   ::= "K" | "M" | "G" | "T" | "P";
size          ::= integer size_suffix | integer;
comparator    ::= ">" | ">=" | "==" | "<=" | "<";
variable      ::= "USED" | "FREE" | "RATE";
value         ::= percentage | size;
space         ::= " " | "\t";
spaces        ::= space | { space };
any_spaces    ::= "" | spaces;
condition     ::= variable any_spaces comparator any_spaces value;
conditions    ::= condition | condition { any_spaces "," any_spaces condition };

Environment Variables

• DISKU_CONFIG_FILE - Path to config file to be loaded
• DISKU_LOG_FILE - Path to logfile, empty for standard output
• DISKU_LOG_LEVEL - One of (DEBUG, INFO, WARN, ERROR, FATAL), default is ERROR

Agent Configuration

Environment Variables

• DISKU_LOG_FILE - Path to logfile, empty for standard output
• DISKU_LOG_LEVEL - One of (DEBUG, INFO, WARN, ERROR, FATAL), default is ERROR

Deployment

Here's a guide to install disku server on an Ubuntu machine: (should work on Debian-based distros)

# 1. Clone this project
git clone https://github.com/Inndy/disku.git
cd disku

# 2. Install python3, python3-pip, nginx, uwsgi, uwsgi-plugin-python3
sudo apt-get install python3 python3-pip nginx uwsgi uwsgi-plugin-python3

# 3. Install dependency
sudo -H python3 -m pip install -r requirements.txt

# 4. Config disku, uwsgi and nginx
cp config.ini.template config.ini

# Feel free to use your favorite text editor, or use the default one.
# In case that your system default editor is vi/vim, press one-hundred times
# Ctrl-C and type :q! to escape from vim

editor config.ini
sudo ./deploy/gen-uwsgi-config.py -u $USER -g $GROUP -o /etc/uwsgi/apps-available/disku.ini
sudo ln -s /etc/uwsgi/apps-{available,enabled}/disku.ini
sudo cp ./deploy/nginx-uwsgi-disku.conf /etc/nginx/sites-available/disku.conf
sudo ln -s /etc/nginx/sites-{available,enabled}/disku.conf

# 5. Reload server config
sudo systemctl reload uwsgi
sudo nginx -s reload

TODO

• Detailed deployment instructions
• Version number
• Support float point value in size
• More flexiability for webhook
• Make a DSL or python plugin architecture for advanced customized conditions
• More alarm channel provider
• Unit test
• Publish to PYPI
• Maybe it will works on older versions of python, should we test it on python 3.4?

License

This project is released under MIT License