# covenant project
## Quickstart
Using covenant in Docker
`docker-compose up -d`
See [docker-compose.yml](docker-compose.yml)
## Installation
pip install covenant
## Running
### Running daemon
`covenant -c <conffile> -p <pidfile> --logfile <logfile>`
### Running foreground
`covenant -f -c <conffile> -p <pidfile> --logfile <logfile>`
### Examples:
curl http://localhost:9118/metrics/apache1
curl http://localhost:9118/metrics/nginx1
curl http://localhost:9118/metrics/rabbitmq1
curl http://localhost:9118/metrics/redis1
curl http://localhost:9118/probe/secure-layer1?target=https://example.com
curl http://localhost:9118/probe/sshd-pidfile-exists?target=/var/run/sshd.pid
Raw data
{
"_id": null,
"home_page": "https://github.com/decryptus/covenant",
"name": "covenant",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"maintainer_email": "",
"keywords": "",
"author": "Adrien Delle Cave",
"author_email": "pypi@doowan.net",
"download_url": "",
"platform": null,
"description": "# covenant project\n\n## Quickstart\n\nUsing covenant in Docker\n\n`docker-compose up -d`\n\nSee [docker-compose.yml](docker-compose.yml)\n\n## Installation\n\npip install covenant\n\n## Running\n\n### Running daemon\n\n`covenant -c <conffile> -p <pidfile> --logfile <logfile>`\n\n### Running foreground\n\n`covenant -f -c <conffile> -p <pidfile> --logfile <logfile>`\n\n### Examples:\n\ncurl http://localhost:9118/metrics/apache1\n\ncurl http://localhost:9118/metrics/nginx1\n\ncurl http://localhost:9118/metrics/rabbitmq1\n\ncurl http://localhost:9118/metrics/redis1\n\ncurl http://localhost:9118/probe/secure-layer1?target=https://example.com\n\ncurl http://localhost:9118/probe/sshd-pidfile-exists?target=/var/run/sshd.pid\n\n\n",
"bugtrack_url": null,
"license": "License GPL-3",
"summary": "covenant",
"version": "0.0.65",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e19917abdc93e94ed844bf3985bd243829b9187fdd0c8d2a5a32b6d2de0f1f5",
"md5": "35fb18cf0f4564077480f678ca0237ae",
"sha256": "9ca8614531282c78912e5cc4ac854929f0d5d9ecffc8a402bc805dee29d81ead"
},
"downloads": -1,
"filename": "covenant-0.0.65-py2-none-any.whl",
"has_sig": false,
"md5_digest": "35fb18cf0f4564077480f678ca0237ae",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 50245,
"upload_time": "2023-02-02T05:20:43",
"upload_time_iso_8601": "2023-02-02T05:20:43.120278Z",
"url": "https://files.pythonhosted.org/packages/9e/19/917abdc93e94ed844bf3985bd243829b9187fdd0c8d2a5a32b6d2de0f1f5/covenant-0.0.65-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fcd713b0cd850fa92d6a5fa62818c76b99ef9302aff32dc9852e983d0cecb2d5",
"md5": "4f0a68ebf9a24546d37e02e7d3b5443c",
"sha256": "9891e6d3a7f93fd16c964377bc12db5279471da7a9334e4c879886b0ecbfe3c1"
},
"downloads": -1,
"filename": "covenant-0.0.65-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f0a68ebf9a24546d37e02e7d3b5443c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 50243,
"upload_time": "2023-02-02T05:20:46",
"upload_time_iso_8601": "2023-02-02T05:20:46.308723Z",
"url": "https://files.pythonhosted.org/packages/fc/d7/13b0cd850fa92d6a5fa62818c76b99ef9302aff32dc9852e983d0cecb2d5/covenant-0.0.65-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-02 05:20:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "decryptus",
"github_project": "covenant",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "covenant"
}