iamthefij/minitor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
A minimal monitoring system
40 Commits 3 Branches 4 Tags 302 KiB
Python 74.7%
Makefile 12.4%
Shell 10.2%
Dockerfile 2.7%
f4952b61d1
Go to file
Ian Fijolek f4952b61d1 Update Dockerfile to build the current working copy 
This will allow `latest` to be `master` and allow git tags to dictate
tagged versions on Docker.

Also update readme to describe how it's now building
2018-04-18 09:51:32 -07:00
minitor Add alerting for recovered monitors 2018-04-14 17:27:37 -07:00
tests Add alerting for recovered monitors 2018-04-14 17:27:37 -07:00
.dockerignore Update Dockerfile to build the current working copy 2018-04-18 09:51:32 -07:00
.drone.yml Use new make target for drone 2018-04-13 22:02:46 -07:00
.gitignore Add tox, pre-commit and dummy test. 2018-04-09 10:44:30 -07:00
.pre-commit-config.yaml Add tox, pre-commit and dummy test. 2018-04-09 10:44:30 -07:00
.travis.yml Use new make target for travis 2018-04-13 22:02:46 -07:00
Dockerfile Update Dockerfile to build the current working copy 2018-04-18 09:51:32 -07:00
LICENSE Run pre-commit to clean files 2018-04-09 12:08:42 -07:00
Makefile Update Dockerfile to build the current working copy 2018-04-18 09:51:32 -07:00
README.md Update Dockerfile to build the current working copy 2018-04-18 09:51:32 -07:00
requirements-dev.txt Improve logging such that a test can be written for an alert 2018-04-10 11:06:42 -07:00
requirements.txt Add back requirements.txt to install from setup 2018-02-16 09:55:10 -08:00
sample-config.yml Add exponential backoff 2018-02-17 20:45:37 -08:00
setup.cfg Prepare for pypi 2018-02-16 17:49:33 -08:00
setup.py Bump version to v0.1.3 2018-04-13 21:39:30 -07:00
tox.ini Speed up builds and add pypi step 2018-04-13 22:02:46 -07:00

README.md

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.

Docker

You can pull this repository directly from Docker:

docker pull iamthefij/minitor

The Docker image uses a default config.yml that is copied from sample-config.yml. This won't really do anything for you, so when you run the Docker image, you should supply your own config.yml file:

docker run -v $PWD/config.yml:/app/config.yml iamthefij/minitor

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}.

Contributing

Whether you're looking to submit a patch or just tell me I broke something, you can contribute through the Github mirror and I can merge PRs back to the source repository.

Primary Repo: https://git.iamthefij.com/iamthefij/minitor.git

Github Mirror: https://github.com/IamTheFij/minitor.git