# ExaCheck - ExaBGP Service Health Checker
[ExaCheck](https://github.com/exacheck/exacheck) works in conjunction with [ExaBGP](https://github.com/Exa-Networks/exabgp) to health check services and announce BGP routes depending on the state of the service.
For additional information, deployment instructions and configuration examples please check the [ExaCheck website](https://exacheck.net).
## Why ExaCheck
ExaBGP is packaged with its own health checking script ([see here](https://github.com/Exa-Networks/exabgp/blob/main/src/exabgp/application/healthcheck.py)) however it has some limitations which make it not suitable for my requirements. The built in health check works fine for smaller environments where each service may be running its own instance of ExaBGP (so each instance of ExaBGP runs one or only a few processes) however for larger environments where health checks are centralised it becomes unmanageable.
Some features from the built in ExaBGP health checking script are **not** available as they are not relevant to the use case for me:
- Management of IP address binding; the main use case of ExaCheck is for centralised health checks where the service resides on another server/container/VM
### Features
- Live configuration reloads (adding/modifying/removing services)
- Health checks implemented in pure python where possible; no need to write scripts or use chains of commands to validate output
- Detailed logging available
- Configuration validation (if using live configuration reloads, configuration is validated before application)
- Out of the box sane defaults where possible
- JSON schema of configuration (see [schema.json][ExaCheck Configuration Schema] for the current schema)
## Known Issues
If installing Exacheck with Python 3.12 or higher, ExaBGP is not included as a requirement and you must install ExaBGP from source. If using ExaBGP from PyPi using Python 3.12 you will get the following error when running ExaBGP:
```bash
ModuleNotFoundError: No module named 'exabgp.vendoring.six.moves'
```
To work around the problem, install ExaBGP from source:
```bash
python3 -m pip --no-cache-dir install "git+https://github.com/Exa-Networks/exabgp.git@4.2"
```
If you are using the Docker container you do not need to do anything.
[ExaCheck Configuration Schema]: https://github.com/exacheck/exacheck/blob/main/schema.json
Raw data
{
"_id": null,
"home_page": "https://exacheck.net",
"name": "exacheck",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "bgp, exabgp, healthcheck, monitoring, network, networking, networks, routes, routing",
"author": "Chris",
"author_email": "info@exacheck.net",
"download_url": "https://files.pythonhosted.org/packages/92/25/f6ac96423a1b91a67e3c50df2ed49168d798acbb1ed4f9688aba0b569fe3/exacheck-0.1.1.tar.gz",
"platform": null,
"description": "# ExaCheck - ExaBGP Service Health Checker\n\n[ExaCheck](https://github.com/exacheck/exacheck) works in conjunction with [ExaBGP](https://github.com/Exa-Networks/exabgp) to health check services and announce BGP routes depending on the state of the service.\n\nFor additional information, deployment instructions and configuration examples please check the [ExaCheck website](https://exacheck.net).\n\n## Why ExaCheck\n\nExaBGP is packaged with its own health checking script ([see here](https://github.com/Exa-Networks/exabgp/blob/main/src/exabgp/application/healthcheck.py)) however it has some limitations which make it not suitable for my requirements. The built in health check works fine for smaller environments where each service may be running its own instance of ExaBGP (so each instance of ExaBGP runs one or only a few processes) however for larger environments where health checks are centralised it becomes unmanageable.\n\nSome features from the built in ExaBGP health checking script are **not** available as they are not relevant to the use case for me:\n\n- Management of IP address binding; the main use case of ExaCheck is for centralised health checks where the service resides on another server/container/VM\n\n### Features\n\n- Live configuration reloads (adding/modifying/removing services)\n- Health checks implemented in pure python where possible; no need to write scripts or use chains of commands to validate output\n- Detailed logging available\n- Configuration validation (if using live configuration reloads, configuration is validated before application)\n- Out of the box sane defaults where possible\n- JSON schema of configuration (see [schema.json][ExaCheck Configuration Schema] for the current schema)\n\n## Known Issues\n\nIf installing Exacheck with Python 3.12 or higher, ExaBGP is not included as a requirement and you must install ExaBGP from source. If using ExaBGP from PyPi using Python 3.12 you will get the following error when running ExaBGP:\n\n```bash\nModuleNotFoundError: No module named 'exabgp.vendoring.six.moves'\n```\n\nTo work around the problem, install ExaBGP from source:\n\n```bash\npython3 -m pip --no-cache-dir install \"git+https://github.com/Exa-Networks/exabgp.git@4.2\"\n```\n\nIf you are using the Docker container you do not need to do anything.\n\n[ExaCheck Configuration Schema]: https://github.com/exacheck/exacheck/blob/main/schema.json\n",
"bugtrack_url": null,
"license": null,
"summary": "ExaCheck - ExaBGP Health Checker",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://exacheck.net/development/changelog/",
"Configuration": "https://exacheck.net/configuration/",
"Docker Deployment": "https://exacheck.net/deployment/docker/",
"Documentation": "https://exacheck.net/deployment/",
"Homepage": "https://exacheck.net",
"Repository": "https://github.com/exacheck/exacheck"
},
"split_keywords": [
"bgp",
" exabgp",
" healthcheck",
" monitoring",
" network",
" networking",
" networks",
" routes",
" routing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f23529aca72f7465c9d7aa4cd19dcfcd2a7afa3bba96c92089fa99204c9f4e57",
"md5": "fd80e41c7505254e1e44d4592ac1a790",
"sha256": "8bab22cfad67b4b569a3a46a08ca905129d84fadf4412f5e2cabb25956ac61fc"
},
"downloads": -1,
"filename": "exacheck-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd80e41c7505254e1e44d4592ac1a790",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 67857,
"upload_time": "2024-04-18T14:49:32",
"upload_time_iso_8601": "2024-04-18T14:49:32.946965Z",
"url": "https://files.pythonhosted.org/packages/f2/35/29aca72f7465c9d7aa4cd19dcfcd2a7afa3bba96c92089fa99204c9f4e57/exacheck-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9225f6ac96423a1b91a67e3c50df2ed49168d798acbb1ed4f9688aba0b569fe3",
"md5": "fdfc0549871fa08dc4ced26f9a95512f",
"sha256": "acb1dcfe5b7960eea98ca66a71d8eed5e8df79c76e77adcea0bc258b687d3c1c"
},
"downloads": -1,
"filename": "exacheck-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "fdfc0549871fa08dc4ced26f9a95512f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 46888,
"upload_time": "2024-04-18T14:49:35",
"upload_time_iso_8601": "2024-04-18T14:49:35.799583Z",
"url": "https://files.pythonhosted.org/packages/92/25/f6ac96423a1b91a67e3c50df2ed49168d798acbb1ed4f9688aba0b569fe3/exacheck-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 14:49:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "exacheck",
"github_project": "exacheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "exacheck"
}
JSON
