Skip to main content

The simplest tool for lightweight monitoring over SSH, compatible with all your favorite messengers.

Project description

🔥 Fikkie

The easiest tool for lightweight monitoring over SSH, compatible with all your favorite messengers!

CI/CD Coverage Status PyPI license PyPi version Downloads Docker pulls Linux macOS Code style: black Python versions Checked with mypy

Quick links


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.


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 \

Config example

The fikkie configuration file is placed at ~/.fikkie/config.yaml by default and could look something like this:

    - description: 'MariaDB status'
      command: 'sudo systemctl status mariadb | grep "Active: active" -c'
      expected: '1'
    - description: 'HTTP code'
      command: 'curl -s -o /dev/null -w "%{http_code}"'
      expected: '200'

  - type: telegram
    token: '1234:abcd'
    chat_id: 1234


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.

Project details

Download files

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

Source Distribution

fikkie-0.5.2.tar.gz (11.5 kB view hashes)

Uploaded source

Built Distribution

fikkie-0.5.2-py3-none-any.whl (13.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page