{ "info": { "author": "Christian Haudum", "author_email": "christian.haudum@crate.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "=====\ncstat\n=====\n\n*A visual stat tool for CrateDB clusters.*\n\n``cstat`` is ispired by the awesome interactive process monitoring tool htop_.\n``cstat`` should be a similar tool to iostat_, but for monitoring CrateDB_\nclusters.\n\n.. image:: screenshot.png\n :scale: 100%\n :alt: Screenshot of cstat in action\n\nRequirements\n============\n\n``cstat`` requires **Python >= 3.6** and can connect to **CrateDB >= 2.3**.\n\nInstallation\n============\n\n``cstat`` is available from Pypi_ so you can install it using pip_.\n\n::\n\n pip install cstat\n\nIf you want to get the latest features and fixes, you can also install it\ndirectly from Github_.\n\n::\n\n pip install git+https://github.com/chaudum/crate-top.git@master\n\nUsage\n=====\n\nAfter installation you can monitor CrateDB running on localhost with default\nconfiguration by invoking the following command::\n\n >>> cstat --user crate\n\nA full list of command line arguments are listed when invoking ``cstat`` with\nthe ``--help`` argument::\n\n >>> cstat --help\n usage: cstat [-h] [--host HOST] [--port PORT] [--interval INTERVAL]\n [--user USER] [--version]\n\n A visual stat tool for CrateDB clusters\n\n optional arguments:\n -h, --help show this help message and exit\n --host HOST, --crate-host HOST\n CrateDB host to connect to\n --port PORT, --psql-port PORT\n PSQL port of CrateDB host\n --interval INTERVAL, --refresh-interval INTERVAL\n amount of time in seconds between each update\n --user USER, --db-user USER\n database user\n --version show program's version number and exit\n\nBy default ``cstat`` connects to ``localhost`` on port ``5432`` if not\notherwise specified.\n\nKeyboard Shortcuts\n==================\n\n- ``0`` ... toggle cluster info\n- ``1`` ... show utilization for CPU, process, memory, heap and disk\n- ``2`` ... show I/O statistics for network and disk\n- ``3`` ... show aggregated query duration based on jobs_log_\n- ``x`` ... toggle nodes/aggregation view\n- ``f3`` ... enable/disable job logging (this also sets the ``stats.jobs_log``\n cluster setting)\n\nKnown Issues\n============\n\n- Small terminal sizes will raise CanvasErrors because of content overflow.\n\nTodo\n====\n\n- [x] display disk usage\n- [x] display disk i/o\n- [x] display network i/o\n- [x] display node names in detail views\n- [x] use asyncio to perform http requests\n- [x] coloring of i/o stats\n- [ ] responsive i/o widget\n\n\n.. _htop: http://hisham.hm/htop/\n.. _iostat: http://linux.die.net/man/1/iostat\n.. _CrateDB: https://crate.io\n.. _aiopg: https://github.com/aio-libs/aiopg\n.. _Pypi: https://pypi.org/project/cstat/\n.. _pip: https://pypi.org/project/pip/\n.. _Github: https://github.com/chaudum/crate-top\n.. _jobs_log: https://crate.io/docs/reference/en/latest/configuration.html#collecting-stats\n\n\n===================\nChangelog for cstat\n===================\n\nUnreleased\n==========\n\n0.3.0\n=====\n\nReleased on **2018/06/01** with the following changes:\n\n- Make cstat compatible with CrateDB version 2.3.0 and greater.\n\n - Updated process CPU usage calculation to work with CrateDB 2.3 and newer.\n\n - Updated disk usage and disk i/o calculation to work with CrateDB 2.3 and\n newer.\n\n- Added ``-V`` (prompt for username) argument.\n\n- Added ``--password`` and ``-W`` (prompt for password) arguments.\n\n0.2.0\n=====\n\nReleased on **2017/11/14** with the following changes:\n\n- Implemented asynchronous database access using aiopg_ which uses the Postgres\n Wire Protocol instead of the official CrateDB Python client which uses the\n HTTP protocol.\n\n- Added ``median``, ``percentile 95``, and ``percentile 99`` to query stats\n table view.\n\n- Added ``--user``/``--db-user`` command line argument to support user\n authentication for clusters which run CrateDB 2.0 or greater.\n\n- Changed the toggle key for enabling/disabling query stats from ``F1`` to\n ``F3``, because in the Terminator_ terminal the ``F1`` key is reserved for\n \"help\".\n\n- Pre-calculate used and idle CPU in SQL statement to avoid rounding issues\n that can cause an display overflow in CPU widget.\n\n.. _aiopg: https://github.com/aio-libs/aiopg\n.. _Terminator: https://launchpad.net/terminator\n\n0.1.0\n=====\n\nInitial release on **2017/03/30**:\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/chaudum/crate-top", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "cstat", "package_url": "https://pypi.org/project/cstat/", "platform": "any", "project_url": "https://pypi.org/project/cstat/", "project_urls": { "Homepage": "https://github.com/chaudum/crate-top" }, "release_url": "https://pypi.org/project/cstat/3.0.0/", "requires_dist": [ "appdirs", "aiopg", "colorama", "urwid", "pudb; extra == 'develop'" ], "requires_python": "", "summary": "A visual stat tool for CrateDB clusters", "version": "3.0.0" }, "last_serial": 3919872, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "2007a8a18a3df9d615c4a8cfe1e31fa9", "sha256": "8f22164e373d606019c65e42be683cf2602cf788dacadb8ea5774cb45710f65c" }, "downloads": -1, "filename": "cstat-0.1.0.tar.gz", "has_sig": false, "md5_digest": "2007a8a18a3df9d615c4a8cfe1e31fa9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 64847, "upload_time": "2017-03-30T11:44:12", "url": "https://files.pythonhosted.org/packages/69/a1/997a6f10742e9c0afff917b6a3df13ba77d8f02aa9d7a1af9013144898e4/cstat-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "5b50a82aacac4238d761d9f632b95d29", "sha256": "d544d5472ce9f5e144d88a12d2cfc96f31caaa9066e75cb9df655ae147eeea14" }, "downloads": -1, "filename": "cstat-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5b50a82aacac4238d761d9f632b95d29", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18725, "upload_time": "2017-11-14T08:32:17", "url": "https://files.pythonhosted.org/packages/b7/51/df23a91c976fe4b14821fd1c67b8bcec8d4f222d0f34c3bd93811eece76c/cstat-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dcac216719c91b1fb51ddf607cc83810", "sha256": "cf6e7775c8d9ef86d1ab01fb7714aaeb5d909184af32513c47b46f85c70760d5" }, "downloads": -1, "filename": "cstat-0.2.0.tar.gz", "has_sig": false, "md5_digest": "dcac216719c91b1fb51ddf607cc83810", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 60813, "upload_time": "2017-11-14T08:32:19", "url": "https://files.pythonhosted.org/packages/b3/a5/c99666d037f348d50334d9905962fa94a75702999a36144fbe43fd49c5ef/cstat-0.2.0.tar.gz" } ], "3.0.0": [ { "comment_text": "", "digests": { "md5": "d87a81ef96b6f7774bbc41aedc5fa06d", "sha256": "a9a52be9465c54abc3f505def253a5fbe055f2e1d2f8ed12b97008f2c0fa426b" }, "downloads": -1, "filename": "cstat-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d87a81ef96b6f7774bbc41aedc5fa06d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 19373, "upload_time": "2018-06-01T08:09:36", "url": "https://files.pythonhosted.org/packages/aa/81/b08067e78d3b4cc8a4bd20dc6e7c0e608803441afee053415415c225eb47/cstat-3.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0e49409412cf455bac6d6bdaa29a1598", "sha256": "73121d9e5e20c43e70740a435da0c208b1adebeb10eb3ec6e3a87167e99cf09f" }, "downloads": -1, "filename": "cstat-3.0.0.tar.gz", "has_sig": false, "md5_digest": "0e49409412cf455bac6d6bdaa29a1598", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 61370, "upload_time": "2018-06-01T08:09:39", "url": "https://files.pythonhosted.org/packages/26/27/1b04cc76a3fea5bc2c689420f4712add445614dda786c748e1cca4e82d3c/cstat-3.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d87a81ef96b6f7774bbc41aedc5fa06d", "sha256": "a9a52be9465c54abc3f505def253a5fbe055f2e1d2f8ed12b97008f2c0fa426b" }, "downloads": -1, "filename": "cstat-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d87a81ef96b6f7774bbc41aedc5fa06d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 19373, "upload_time": "2018-06-01T08:09:36", "url": "https://files.pythonhosted.org/packages/aa/81/b08067e78d3b4cc8a4bd20dc6e7c0e608803441afee053415415c225eb47/cstat-3.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0e49409412cf455bac6d6bdaa29a1598", "sha256": "73121d9e5e20c43e70740a435da0c208b1adebeb10eb3ec6e3a87167e99cf09f" }, "downloads": -1, "filename": "cstat-3.0.0.tar.gz", "has_sig": false, "md5_digest": "0e49409412cf455bac6d6bdaa29a1598", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 61370, "upload_time": "2018-06-01T08:09:39", "url": "https://files.pythonhosted.org/packages/26/27/1b04cc76a3fea5bc2c689420f4712add445614dda786c748e1cca4e82d3c/cstat-3.0.0.tar.gz" } ] }