Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cfmtech/monitor-server-api
Monitor-server-api helps you to collect, historicize and exploit the data from your tests written with pytest and monitored with pytest-monitor.
https://github.com/cfmtech/monitor-server-api
cpu-monitoring integration-testing memory-monitoring python qatools quality rest-api
Last synced: 13 days ago
JSON representation
Monitor-server-api helps you to collect, historicize and exploit the data from your tests written with pytest and monitored with pytest-monitor.
- Host: GitHub
- URL: https://github.com/cfmtech/monitor-server-api
- Owner: CFMTech
- License: mit
- Created: 2021-06-04T13:35:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-08-21T14:33:44.000Z (about 2 years ago)
- Last Synced: 2024-10-06T17:18:09.508Z (about 1 month ago)
- Topics: cpu-monitoring, integration-testing, memory-monitoring, python, qatools, quality, rest-api
- Language: Python
- Homepage:
- Size: 148 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# monitor-server-api
[](https://circleci.com/gh/CFMTech/monitor-server-api)
[](https://monitor-server-api.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/monitor-server-api/1.0.0/)
[](https://anaconda.org/conda-forge/monitor-server-api)
[](https://anaconda.org/conda-forge/monitor-server-api)
## Features
For short, monitor-server-api helps you to collect, historicize and exploit the data from your tests
written with pytest and monitored with pytest-monitor.
* Centralize your tests results
* bring support for *pytest-xdist* and *pytest-parallel*
* Easy data querying through specific queries
* Integrated library for in-script queries
## Usage
The server can be launched easily with any WSGI Framework.
The following lines can be used for a start:
```bash
bash $> # Use it with sqlite (not recomended for production)
bash $> export DATABASE_PATH=/path/to/sqlite/db
bash $> uwsgi --http 0.0.0.0:8050 --workers 8 --process 8 --master
--harakiri 60 --harakiri-verbose --need-app -w monitor_server_api.uwsgi
--callable WSGI_SERVER --env DATABASE_PATH=${DATABASE_PATH} --env ENV=prod
```
If you prefer using conda
```bash
bash $> conda activate
bash $> # Setup the server to listen on port 8080, 8 workers, 60s max per request and using sqlite
bash $> launch-monitor-server.sh -p 8080 -t 60 -w 8 -u sqlite:////path/to/db
```
You can validate that the server runs correctly by going to the root page of the server.
## Documentation
> A full documentation with use cases and example is [available](https://monitor-server-api.readthedocs.io/en/latest/?badge=latest).
## Installation
Review the following installation instructions along with basic setup instructions.
You can install *monitor-server-api* via *conda* (through the `conda-forge` channel):
$ conda install monitor-server-api -c https://conda.anaconda.org/conda-forge
Another possibility is to install *monitor-server-api* via `pip`_ from `PyPI`:
$ pip install monitor-server-api
## Requirements
### Monitor-Server-Api
To run, the monitor-server-api requires a valid Python 3.6+ interpreter. The following requirements
are needed:
* *flask-restx* (officially supported) OR *flask-restplus* (tested)
* *flask-sqlalchemy*
Testing requires *pytest-flask* and *pytest-cov* (along with *pytest* obviously).
### Monitorlib
The monitorlib also requires a valid Python 3.6+ along with :
* requests
* pandas
## Contributing
Contributions are very welcome. Tests are run with *[pytest](https://docs.pytest.org/en/latest/)*.
Before submitting a pull request, please ensure that:
- both internal tests and examples are passing.
- internal tests have been written if necessary.
- if your contribution provides a new feature, make sure to provide an
example and update the documentation accordingly.
### Issues
If you encounter any problem, please file an issue along with a detailed
description.
See [contributing file](CONTRIBUTING.md) for more information.
## License
*monitor-server-api* is free, open-source software
This code is distributed under the  license.
## Author
The main author of `monitor-server-api` is Jean-Sébastien Dieu, ]]who can be reached at [email protected].
See [AUTHORS file](AUTHORS) for more contributors.