| Name | monico JSON |
| Version |
0.1.dev1
JSON |
| download |
| home_page | |
| Summary | Monico is a simple command-line utility for efficiently monitoring and analyzing the availability of websites. |
| upload_time | 2023-12-14 23:30:34 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) [year] [fullname] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
monitoring
uptime
networking
web
http
status-check
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Monico [](https://codecov.io/gh/Scorpil/monico)
<p align="center">
<img alt="Monico Logo" src="https://github.com/Scorpil/monico/blob/main/monico-logo.svg" width="200"/>
</p>
## Introduction
Monico is a simple command-line utility for efficiently monitoring and analyzing the availability of websites.
Monico CLI is built with a focus on ease of use, flexibility, and reliability. It allows configuring website monitoring to collect essential data such as response times, status codes, and content checks, storing all information in a structured format for easy retrieval and analysis.
## Features
- **Easy Configuration**: Set up monitors for websites with a simple CLI.
- **Flexible Monitoring**: Define custom intervals and content checks for each monitor.
- **Data Insights**: Review monitoring data directly from CLI.
- **Secure and Reliable**: Built with security and reliability in mind, ensuring your monitoring is always up and running.
## Setup and Configuration
### Prerequisites
You need Python 3.11 to run `monico`. Additionally, make sure you have PostgreSQL libraries installed on your system. For Mac:
```
brew install libpq
```
For Ubuntu linux:
```
sudo apt-get install libpq-dev
```
### Installation
`monico` is distributed as a standard python package. Installing it in your system is as simple as:
```
git clone <repo-url> monic
cd monico/
pip install .
```
_Note_: Installing `psycopg2` fails on Apple Silicon inside of venv. If you stumble upon this issue, it's easy enough to fix by pointing clang linker to the openssl:
```
export LDFLAGS="-L/opt/homebrew/opt/openssl/lib"
export CPPFLAGS="-I/opt/homebrew/opt/openssl/include"
```
More here: https://stackoverflow.com/questions/26288042/error-installing-psycopg2-library-not-found-for-lssl
### Configuration
Verify that `monico` is installed:
```
$ monico version
0.1.dev0
```
_Note:_ it's also possible to use monico through Python module syntax e.g:
```
$ python -m monico version
0.1.dev0
```
Monico is configured through config file `.monico.toml` in user home directory or using environment variables. Supported configuration options:
- `postgres_uri` (or environment variable `MONICO_POSTGRES_URI`): **required**, connection string to connect to database
- `log_level` (or environment variable `LOG_LEVEL`): optional, controls logging verbicity. Valid values are `DEBUG`, `INFO`, `WARNING`, `ERROR` and `CRITICAL`. Default is `WARNING`.
**Create the configuration file before continuing setup:**
Example `~/.monico.toml`
```
postgres_uri="postgres://user:pwd@host:5432/monico"
log_level="INFO"
```
When configuration is created, run `monico setup` to initialize the database. In future, to re-initialize the database use `monico setup --force` (careful, this will destroy all pre-existing data!).
## Simple Execution
Open two terminals. In the first one run
```
monico run
```
In the second one, create the monitor, for example:
```
monico create --id scorpil --endpoint "https://scorpil.com" --name "Scorpil's Blog" --interval 5 --body-regexp "The Long Road to [A-Za-z0-9/]+"
```
Now it's possible to watch the monitor execution results with `status` command:
```
monico status --id scorpil --live
```
To see the full list of available CLI commands run
```
$ monico --help
Usage: monico [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
create Creates a new monitor
delete Deletes a monitor.
list Lists configured monitors.
run Starts both manager and worker processes concurrently.
run-manager Starts the manager process.
run-worker Starts the worker process.
setup Initializes the database
status Displays status of a monitor
version Prints the version
```
You can also print help for every command:
```
$ monico create --help
Usage: monico create [OPTIONS]
Creates a new monitor
Options:
--id TEXT ID of the monitor
--name TEXT Name of the monitor
--endpoint TEXT URL to monitor
--interval INTEGER Monitoring interval in seconds
--body-regexp TEXT Regular expression to match in the response body
--help Show this message and exit.
```
## Advanced execution
### Separate workers
`monico` consists of two major parts:
- **Manager** process is only responsible for scheduling tasks (probes). Manager is lightweight so performance-wise it is enough to run a single manager instance at a time. However, it's ok to run multiple manager instances concurrently for redundancy.
- **Worker** process performs HTTP requests and records results. It is possible to run multiple instances of worker for improved scalability and availability guarantees.
`monico run` runs both processes concurrently, but it's possible to run them seperately with `monico run-manager` and `monico run-worker` respectively. It's possible to run multiple instances of each process for scalability and reliability.
Complete app state is stored in database, so it's possible to e.g. run manager/workers processes on a server and control them from a local environment just by configuring `monico` to use the same database.
### Running in Docker
It's possible to run `monico` in Docker by building an image as follows:
```
docker build . -t monico
```
Then running monico as follows:
```
docker run -tie MONICO_POSTGRES_URI="<your-postgres-uri>" monico <arguments>
```
For example:
```
docker run -tie MONICO_POSTGRES_URI="postgres://user:pwd@host:5432/monico" monico status --id my-monitor --live
```
## Testing
To execute tests, you need to install development dependencies:
```
pip install '.[dev]'
```
Now you can run unit tests with
```
make test-unit
```
For integration tests you also need to export environment variable `MONICO_TEST_POSTGRES_URI`` (note the `_TEST_` part), e.g:
```
export MONICO_TEST_POSTGRES_URI="postgres://user:pwd@host:5432/monico"
```
To run integrations tests:
```
make test-integration
```
To run all tests and calculate code-coverage percentage:
```
make test
```
# Architecture
There are a few core concepts Monico uses:
- **Monitor** is a core Monico entity representing a specific website monitoring task. It encapsulates all the details and settings required to periodically check a website's availability and performance, such as endpoint url, check frequency, regex pattern for data lookup etc. When a monitor is active, Monico periodically sends requests (i.e. _probes_) to the specified URL at the defined frequency. It then captures key data from the response, such as response time and HTTP status code. If a regex pattern is provided, Monico also checks the response content against this pattern.
- **Task** is a scheduled item of work, i.e. check that is to be executed.
- **Probe** is an individual instance of a monitoring check performed by Monico. Each probe is an action initiated by a Monitor to assess the current state of a specified website.
- **Manager** is an internal scheduling component in Monico responsible for orchestrating the execution of _Probes_ according to their defined frequencies. It does this be creating tasks for workers to pick up.
- **Worker** is a component that is responsible for performing monitoring checks (_Probes_) and recording the execution results. Multiple worker singles are allowed to run concurrently to enable scaling.
# TODO
- Test coverage is at 88% and could be improved. The main culprit here is just time constraints.
- Tests around CLI commands require database connection right now. This can be eliminated by reorganising the code in a minor way and mocking a few places.
- Locking batch size should be configurable
Raw data
{
"_id": null,
"home_page": "",
"name": "monico",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "monitoring,uptime,networking,web,http,status-check",
"author": "",
"author_email": "Andrew Savchyn <dev@scorpil.com>",
"download_url": "https://files.pythonhosted.org/packages/f5/3a/f67a85ac7731cd687f6e8a915a6d16e6fb5bcd599c3023d5658030ff596a/monico-0.1.dev1.tar.gz",
"platform": null,
"description": "# Monico [](https://codecov.io/gh/Scorpil/monico)\n\n<p align=\"center\">\n <img alt=\"Monico Logo\" src=\"https://github.com/Scorpil/monico/blob/main/monico-logo.svg\" width=\"200\"/>\n</p>\n\n## Introduction\n\nMonico is a simple command-line utility for efficiently monitoring and analyzing the availability of websites.\n\nMonico CLI is built with a focus on ease of use, flexibility, and reliability. It allows configuring website monitoring to collect essential data such as response times, status codes, and content checks, storing all information in a structured format for easy retrieval and analysis.\n\n## Features\n\n- **Easy Configuration**: Set up monitors for websites with a simple CLI.\n- **Flexible Monitoring**: Define custom intervals and content checks for each monitor.\n- **Data Insights**: Review monitoring data directly from CLI.\n- **Secure and Reliable**: Built with security and reliability in mind, ensuring your monitoring is always up and running.\n\n## Setup and Configuration\n\n### Prerequisites\nYou need Python 3.11 to run `monico`. Additionally, make sure you have PostgreSQL libraries installed on your system. For Mac:\n```\nbrew install libpq\n```\n\nFor Ubuntu linux:\n```\nsudo apt-get install libpq-dev\n```\n\n### Installation\n\n`monico` is distributed as a standard python package. Installing it in your system is as simple as:\n\n```\ngit clone <repo-url> monic\ncd monico/\npip install .\n```\n\n_Note_: Installing `psycopg2` fails on Apple Silicon inside of venv. If you stumble upon this issue, it's easy enough to fix by pointing clang linker to the openssl:\n\n```\nexport LDFLAGS=\"-L/opt/homebrew/opt/openssl/lib\"\nexport CPPFLAGS=\"-I/opt/homebrew/opt/openssl/include\"\n```\n\nMore here: https://stackoverflow.com/questions/26288042/error-installing-psycopg2-library-not-found-for-lssl\n\n### Configuration\n\nVerify that `monico` is installed:\n```\n$ monico version\n0.1.dev0\n```\n\n_Note:_ it's also possible to use monico through Python module syntax e.g:\n```\n$ python -m monico version\n0.1.dev0\n```\n\nMonico is configured through config file `.monico.toml` in user home directory or using environment variables. Supported configuration options:\n\n- `postgres_uri` (or environment variable `MONICO_POSTGRES_URI`): **required**, connection string to connect to database\n- `log_level` (or environment variable `LOG_LEVEL`): optional, controls logging verbicity. Valid values are `DEBUG`, `INFO`, `WARNING`, `ERROR` and `CRITICAL`. Default is `WARNING`.\n\n**Create the configuration file before continuing setup:**\n\nExample `~/.monico.toml`\n```\npostgres_uri=\"postgres://user:pwd@host:5432/monico\"\nlog_level=\"INFO\"\n```\n\nWhen configuration is created, run `monico setup` to initialize the database. In future, to re-initialize the database use `monico setup --force` (careful, this will destroy all pre-existing data!).\n\n## Simple Execution\n\nOpen two terminals. In the first one run\n```\nmonico run\n```\n\nIn the second one, create the monitor, for example:\n```\nmonico create --id scorpil --endpoint \"https://scorpil.com\" --name \"Scorpil's Blog\" --interval 5 --body-regexp \"The Long Road to [A-Za-z0-9/]+\"\n```\n\nNow it's possible to watch the monitor execution results with `status` command:\n```\nmonico status --id scorpil --live\n```\n\nTo see the full list of available CLI commands run\n```\n$ monico --help\nUsage: monico [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n create Creates a new monitor\n delete Deletes a monitor.\n list Lists configured monitors.\n run Starts both manager and worker processes concurrently.\n run-manager Starts the manager process.\n run-worker Starts the worker process.\n setup Initializes the database\n status Displays status of a monitor\n version Prints the version\n```\n\nYou can also print help for every command:\n```\n$ monico create --help\nUsage: monico create [OPTIONS]\n\n Creates a new monitor\n\nOptions:\n --id TEXT ID of the monitor\n --name TEXT Name of the monitor\n --endpoint TEXT URL to monitor\n --interval INTEGER Monitoring interval in seconds\n --body-regexp TEXT Regular expression to match in the response body\n --help Show this message and exit.\n```\n\n## Advanced execution\n\n### Separate workers\n`monico` consists of two major parts:\n- **Manager** process is only responsible for scheduling tasks (probes). Manager is lightweight so performance-wise it is enough to run a single manager instance at a time. However, it's ok to run multiple manager instances concurrently for redundancy.\n- **Worker** process performs HTTP requests and records results. It is possible to run multiple instances of worker for improved scalability and availability guarantees.\n\n`monico run` runs both processes concurrently, but it's possible to run them seperately with `monico run-manager` and `monico run-worker` respectively. It's possible to run multiple instances of each process for scalability and reliability.\n\nComplete app state is stored in database, so it's possible to e.g. run manager/workers processes on a server and control them from a local environment just by configuring `monico` to use the same database.\n\n### Running in Docker\n\nIt's possible to run `monico` in Docker by building an image as follows:\n\n```\ndocker build . -t monico\n```\n\nThen running monico as follows:\n\n```\ndocker run -tie MONICO_POSTGRES_URI=\"<your-postgres-uri>\" monico <arguments>\n```\n\nFor example:\n```\ndocker run -tie MONICO_POSTGRES_URI=\"postgres://user:pwd@host:5432/monico\" monico status --id my-monitor --live\n```\n\n## Testing\n\nTo execute tests, you need to install development dependencies:\n```\npip install '.[dev]'\n```\n\nNow you can run unit tests with\n```\nmake test-unit\n```\n\nFor integration tests you also need to export environment variable `MONICO_TEST_POSTGRES_URI`` (note the `_TEST_` part), e.g:\n```\nexport MONICO_TEST_POSTGRES_URI=\"postgres://user:pwd@host:5432/monico\"\n```\n\nTo run integrations tests:\n```\nmake test-integration\n```\n\nTo run all tests and calculate code-coverage percentage:\n```\nmake test\n```\n\n# Architecture\n\nThere are a few core concepts Monico uses:\n\n- **Monitor** is a core Monico entity representing a specific website monitoring task. It encapsulates all the details and settings required to periodically check a website's availability and performance, such as endpoint url, check frequency, regex pattern for data lookup etc. When a monitor is active, Monico periodically sends requests (i.e. _probes_) to the specified URL at the defined frequency. It then captures key data from the response, such as response time and HTTP status code. If a regex pattern is provided, Monico also checks the response content against this pattern.\n- **Task** is a scheduled item of work, i.e. check that is to be executed.\n- **Probe** is an individual instance of a monitoring check performed by Monico. Each probe is an action initiated by a Monitor to assess the current state of a specified website.\n- **Manager** is an internal scheduling component in Monico responsible for orchestrating the execution of _Probes_ according to their defined frequencies. It does this be creating tasks for workers to pick up.\n- **Worker** is a component that is responsible for performing monitoring checks (_Probes_) and recording the execution results. Multiple worker singles are allowed to run concurrently to enable scaling.\n\n\n\n# TODO\n\n- Test coverage is at 88% and could be improved. The main culprit here is just time constraints.\n- Tests around CLI commands require database connection right now. This can be eliminated by reorganising the code in a minor way and mocking a few places.\n- Locking batch size should be configurable\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [year] [fullname] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Monico is a simple command-line utility for efficiently monitoring and analyzing the availability of websites.",
"version": "0.1.dev1",
"project_urls": null,
"split_keywords": [
"monitoring",
"uptime",
"networking",
"web",
"http",
"status-check"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbd22fcea76ad2fd7f52b74f7dd6636976784fe2f712a6251eef8c8aabff589a",
"md5": "49cc3a807dc1841c772312d860aabad1",
"sha256": "82bb21335be5e80b075447db3bab0c7fdc1d6a0db1651b0cee760d7f89b7148a"
},
"downloads": -1,
"filename": "monico-0.1.dev1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "49cc3a807dc1841c772312d860aabad1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 28093,
"upload_time": "2023-12-14T23:30:33",
"upload_time_iso_8601": "2023-12-14T23:30:33.127773Z",
"url": "https://files.pythonhosted.org/packages/cb/d2/2fcea76ad2fd7f52b74f7dd6636976784fe2f712a6251eef8c8aabff589a/monico-0.1.dev1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f53af67a85ac7731cd687f6e8a915a6d16e6fb5bcd599c3023d5658030ff596a",
"md5": "19a8fae3a6b1f868a7bdd089215a5874",
"sha256": "87f3d4ddfb4b2eaa82bffeadb497a983d0e005dc7cc3232c327c40a82055ab39"
},
"downloads": -1,
"filename": "monico-0.1.dev1.tar.gz",
"has_sig": false,
"md5_digest": "19a8fae3a6b1f868a7bdd089215a5874",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 23395,
"upload_time": "2023-12-14T23:30:34",
"upload_time_iso_8601": "2023-12-14T23:30:34.747221Z",
"url": "https://files.pythonhosted.org/packages/f5/3a/f67a85ac7731cd687f6e8a915a6d16e6fb5bcd599c3023d5658030ff596a/monico-0.1.dev1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-14 23:30:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "monico"
}
