Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

A minimal monitoring tool

Project description

# minitor

A minimal monitoring system

## What does it do?

Minitor accepts a YAML configuration file with a set of commands to run and a set of alerts to execute when those commands fail. It is designed to be as simple as possible and relies on other command line tools to do checks and issue alerts.

## But why?

I’m running a few small services and found Sensu, Consul, Nagios, etc. to all be far too complicated for my usecase.

## So how do I use it?

### Running

Install and execute with:

` pip install minitor minitor `

If locally developing you can use:

` make run `

It will read the contents of config.yml and begin its loop. You could also run it directly and provide a new config file via the –config argument.

### Configuring

In this repo, you can explore the sample-config.yml file for an example, but the general structure is as follows. It should be noted that environment variable interpolation happens on load of the YAML file. Also, when alerts are executed, they will be passed through Python’s format function with arguments for some attributes of the Monitor. Currently this is limited to {monitor_name}.

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 minitor, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size minitor-0.1.2-py3-none-any.whl (6.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size minitor-0.1.2.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page