Your friendly neighbourhood monitoring library. Record metrics about whatever you are interested in (e.g. application state, data integrity).
Project description
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.
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 storepymongo
to use MongoDB sources and storesboto3
to use the CloudWatch store
To install via pip:
pip install sinai
To install via setup tools:
$ git clone git@github.com: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 git@github.com: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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sinai-0.0.24-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e68bb0282719414cace4dd2f814d7501bf5c5b06a38e5a31aea2848eec1f77a |
|
MD5 | 6ee57eeb067a50dee0f6ba0d8d219827 |
|
BLAKE2b-256 | f45fcdc2e0ef7069881306a39874cb0bb8af28fa16015bcbe6df770e3eeab470 |