🔥 Fikkie
The easiest tool for lightweight monitoring over SSH, compatible with all your favorite messengers!
Quick links
Introduction
Why use fikkie?
- Fikkie is easy to set up
- Fikkie is lightweight
- Fikkie is flexible and could be used to monitor any service
- Fikkie notifies you using your favorite messaging service (e.g. e-mail, Discord or Telegram)
You just need one single YAML file to configure fikkie, so simply specify which commands should be run on which servers and what output is expected, and fikkie will let you know when something's wrong.
Installation
Install fikkie using pip and initialize fikkie:
pip install fikkie
fikkie init
Or use Docker!
docker run \
--mount type=bind,source=${PWD}/config.yaml,target=/root/.fikkie/config.yaml \
nootr/fikkie
Config example
The fikkie configuration file is placed at ~/.fikkie/config.yaml by default
and could look something like this:
servers:
primary.foo.com:
- description: 'MariaDB status'
command: 'sudo systemctl status mariadb | grep "Active: active" -c'
expected: '1'
- description: 'HTTP code foo.com'
command: 'curl -s -o /dev/null -w "%{http_code}" foo.com'
expected: '200'
notifiers:
- type: telegram
token: '1234:abcd'
chat_id: 1234
Contributing
Contributions to fikkie are more than welcome! :heart:
Please visit the contribution guidelines for more info. Also, the Developer's guide might be useful if you want to contribute code.
1 maintainer
Release files for fikkie 0.5.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fikkie-0.5.4.tar.gz | 11.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fikkie-0.5.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.9 kB
Release files / fikkie-0.5.4.tar.gz
| Download URL | fikkie-0.5.4.tar.gz |
|---|---|
| Size | 11.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
80ba260256eceaf88a72d9b65da9a5dfc097a268c39f44232cf75607e5f872e4
|
|
BLAKE2b-256 checksum How to use checksums |
92d34870bf3ec402ac5817fc7531e969c95d7ac5dd8ef73f95a77c7c2d61c43d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Release files / fikkie-0.5.4-py3-none-any.whl
| Download URL | fikkie-0.5.4-py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
604e03c2261d3be687f6ecaebd8fe94afe29c5c64755396c57dc9ecc17615634
|
|
BLAKE2b-256 checksum How to use checksums |
45515316eb5aff852f752b728b7a75692e8bca40c29474e25c0ac1462848157e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
