| Name | dockerclustermon JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | A CLI tool for a live view of your docker containers running on a remote server. |
| upload_time | 2024-11-22 19:54:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
docker
docker compose
monitoring
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Docker Cluster Monitor - A TUI utility to monitor your docker containers
A TUI tool for a live view of your docker containers running on a remote server. Here's a graphic of it running (refreshes every 5 seconds or so automatically):
Notice that it uses color to communicate outlier values. For example, low CPU is green, middle-of-the-road CPU is cyan, and heavy CPU usage is red. Similarly for memory. The memory limit column reflects the deploy>memory limit in Docker Compose for that container and the percentage reported is for the imposed memory limit rather than the machine physical memory limits.
## Usage
To use the tool, it has one command, `dockerstatus` with a shorter alias `ds`. If you are running a set of Docker containers (say via Docker Compose) on server `my-docker-host`, then just run:
```bash
dockerstatus my-docker-host
```
You can optionally pass the username if you're not logging in as `root`. Here is the full help text (thank you Typer):
```bash
Usage: dockerstatus [OPTIONS] HOST [USERNAME]
╭─ Arguments ───────────────────────────────────────────────────────────╮
│ * host TEXT The server DNS name or IP address (e.g. 91.7.5.1│
│ or google.com). [default: None] [required] │
│ username [USERNAME] The username of the ssh user for interacting │
│ with the server. [default: root] │
╰───────────────────────────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────╯
```
## Installation
This package is available on PyPI as dockerclustermon. However, it is ideally used as a CLI tool
and not imported into programs. As such, using **uv** or **pipx** will be most useful. Take your pick:
### uv
```bash
uv tool install dockerclustermon
```
Of course this requires that you have
[uv installed](https://docs.astral.sh/uv/getting-started/installation/)
and in the path.
### pipx
```bash
pipx install dockerclustermon
```
And this requires that you have [pipx installed](https://pipx.pypa.io/stable/installation/)
and in the path.
Compatibility
-------------
Docker Cluster Monitor has been tested against Ubunutu Linux. It should work on any system that
supports SSH and has the Docker CLI tools installed. Note that it does **not** work on the local
machine at the moment. PRs are welcome. ;)
Raw data
{
"_id": null,
"home_page": null,
"name": "dockerclustermon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Docker, Docker Compose, Monitoring",
"author": null,
"author_email": "Michael Kennedy <michael@talkpython.fm>",
"download_url": "https://files.pythonhosted.org/packages/93/b8/2ba61c0ba8438e3afdd8cd399248ab042e309401b46393eee54e93eaebfc/dockerclustermon-0.2.2.tar.gz",
"platform": null,
"description": "# Docker Cluster Monitor - A TUI utility to monitor your docker containers\n\nA TUI tool for a live view of your docker containers running on a remote server. Here's a graphic of it running (refreshes every 5 seconds or so automatically):\n\n\n\nNotice that it uses color to communicate outlier values. For example, low CPU is green, middle-of-the-road CPU is cyan, and heavy CPU usage is red. Similarly for memory. The memory limit column reflects the deploy>memory limit in Docker Compose for that container and the percentage reported is for the imposed memory limit rather than the machine physical memory limits.\n\n## Usage\n\nTo use the tool, it has one command, `dockerstatus` with a shorter alias `ds`. If you are running a set of Docker containers (say via Docker Compose) on server `my-docker-host`, then just run:\n\n```bash\ndockerstatus my-docker-host\n```\n\nYou can optionally pass the username if you're not logging in as `root`. Here is the full help text (thank you Typer):\n\n```bash\n Usage: dockerstatus [OPTIONS] HOST [USERNAME] \n\u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * host TEXT The server DNS name or IP address (e.g. 91.7.5.1\u2502 \n\u2502 or google.com). [default: None] [required] \u2502\n\u2502 username [USERNAME] The username of the ssh user for interacting \u2502\n\u2502 with the server. [default: root] \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n## Installation\n\nThis package is available on PyPI as dockerclustermon. However, it is ideally used as a CLI tool \nand not imported into programs. As such, using **uv** or **pipx** will be most useful. Take your pick:\n\n### uv\n\n```bash\nuv tool install dockerclustermon\n```\n\nOf course this requires that you have \n[uv installed](https://docs.astral.sh/uv/getting-started/installation/) \nand in the path.\n\n### pipx\n\n```bash\npipx install dockerclustermon\n```\n\nAnd this requires that you have [pipx installed](https://pipx.pypa.io/stable/installation/) \nand in the path.\n\n\nCompatibility\n-------------\n\nDocker Cluster Monitor has been tested against Ubunutu Linux. It should work on any system that \nsupports SSH and has the Docker CLI tools installed. Note that it does **not** work on the local \nmachine at the moment. PRs are welcome. ;)",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI tool for a live view of your docker containers running on a remote server.",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/mikeckennedy/dockerclustermon"
},
"split_keywords": [
"docker",
" docker compose",
" monitoring"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "013771fbce27e68696ac95d5224d6114f576399cbe155f756e387556398770ab",
"md5": "6fefe08cd8f41e9789614bc5e39bab98",
"sha256": "eab1eb5aecafa43047dc3bb6122094c401424eb3e40d70dd21eac4d912d1cc53"
},
"downloads": -1,
"filename": "dockerclustermon-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fefe08cd8f41e9789614bc5e39bab98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7273,
"upload_time": "2024-11-22T19:54:32",
"upload_time_iso_8601": "2024-11-22T19:54:32.388223Z",
"url": "https://files.pythonhosted.org/packages/01/37/71fbce27e68696ac95d5224d6114f576399cbe155f756e387556398770ab/dockerclustermon-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "93b82ba61c0ba8438e3afdd8cd399248ab042e309401b46393eee54e93eaebfc",
"md5": "d62205452697932e6fef22db7bfdb9ae",
"sha256": "dcc9be1d1acee1999144fc6625a2f0c870279aaff9bf155afc21674bed051777"
},
"downloads": -1,
"filename": "dockerclustermon-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "d62205452697932e6fef22db7bfdb9ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7828,
"upload_time": "2024-11-22T19:54:33",
"upload_time_iso_8601": "2024-11-22T19:54:33.901435Z",
"url": "https://files.pythonhosted.org/packages/93/b8/2ba61c0ba8438e3afdd8cd399248ab042e309401b46393eee54e93eaebfc/dockerclustermon-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 19:54:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mikeckennedy",
"github_project": "dockerclustermon",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dockerclustermon"
}
