sinai 0.1.6

Your friendly neighbourhood monitoring library. Record metrics about whatever you are interested in (e.g. application state, data integrity).

sinai

This is a library for developing monitoring applications that encourages rapid development and clean, pragmatic design.

What your application monitors is up to you. It could be online data sources, the state of a business application, data integrity, anything you want.

For a high-level overview, please read Creating a monitoring application with sinai

Usage

To develop a monitoring application with sinai, you install it and import it like any other Python library.

See the interactive tutorials for how to use it.

See a simple usage example.

Install

There are no required dependencies, but optional dependencies are required for the relevant features:

• requests to use API sources and stores, and the Slack store
• pymongo to use MongoDB sources and stores
• boto3 to use the CloudWatch store

To install via pip:

pip install sinai

To install via setup tools:

$ git clone [e-mail]:SinAI-monitoring/sinai.git
$ cd sinai
$ python setup.py install

Contributing

To develop sinai itself, use the following commands to create a development environment. These assume you have pipenv installed.

$ git clone [e-mail]:SinAI-monitoring/sinai.git
$ cd sinai
$ pipenv install --dev
$ pipenv shell
$ pre-commit install

Check the pre-commit hooks are working with:

$ pre-commit run -a

Run the unit tests with:

$ pytest