A distributed, scalable, and fault-tolerant alerting and monitoring system
The monitoring service daemon for Legion - a distributed, scalable, and fault-tolerant alerting and monitoring system
Setup & Usage
The key reference for using
- Be excellent to each other
- Code coverage must be at 100% for all new code, or a good reason must be provided for why a given bit of code is not covered.
- Example of an acceptable reason: "There is a bug in the code coverage tool and it says its missing this, but its not".
- Example of unacceptable reason: "This is just exception handling, its too annoying to cover it".
- The code must pass the following analytics tools. Similar exceptions are allowable as in rule 2.
pylint --disable=C0111,W1203,R0903 --max-line-length=100 ...
flake8 --max-line-length=100 ...
mypy --ignore-missing-imports --follow-imports=skip --strict-optional ...
- All incoming information from users, clients, and configurations should be validated.
- All internal arguments passing should be typechecked whenever possible with
Using poetry install from inside the repo directory:
This will set up a virtualenv which you can always activate with either
poetry shell or run specific commands with
poetry run. All instructions below that are meant to be run in the virtualenv will be prefaced with
Sublime Text 3
curl -sSL https://gitlab.com/-/snippets/2066312/raw/master/poetry.sublime-project.py | poetry run python
All testing should be done with
pytest which is installed with the
To run all the unit tests, execute the following from the repo directory:
This should produce a coverage report in
While developing, you can use
watchexec to monitor the file system for changes and re-run the tests:
(legiond)$ watchexec -r -e py,yaml pytest
To run a specific test file:
(legiond)$ pytest tests/unit/test_cli.py
To run a specific test:
(legiond)$ pytest tests/unit/test_cli.py::test_cli_basics
For more information on testing, see the
pytest.ini file as well as the documentation.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.