proxtop

Proxmox resource monitor

Proxtop lists the top resource consumers of your Proxmox VM platform.

It will list columns of the top users of these resources:

cpu
diskread
diskwrite
netin
netout

IMPORTANT CHANGES IN proxtop 0.3.0:

Shows only one of AVERAGE, MEDIAN, MAX now. See the -g option.
The –partial-match option has been removed in favor of globbing (e.g. *server-name*).
The default output is now MEDIAN.

IMPORTANT CHANGES IN proxtop 0.2.0:

The default port is now 443. This was tested with Proxmox 4.0-57. If you want the old default port 8006 back, you may append “:8006” to the hostname.
The VM container type is now used in the REST path: i.e. /qemu/ (or lxc) instead of /openvz/.

Installation

Via pip:

$ pip install proxtop

Via git:

$ pip install proxmoxer  # tested with 0.1.7 and 0.2.0
$ pip install requests   # tested with 2.2.1 and 2.5.3
$ git clone https://github.com/ossobv/proxtop.git
$ cd proxtop
$ python setup.py install

Example

$ ./proxtop -t day proxmox.example.com:8006 monitor@pve
Password:<enter password>
SORTED BY: diskread, avg
------------------
#0:    3.1 MiB/s  pve10 (acme-bugs-bunny)
#1:    1.3 MiB/s  pve07 (customerX-private)
#2:  992.3 KiB/s  pve10 (acme-road-runner)
...
SORTED BY: cpu, max
------------------
#0:     91 %      pve07 (customerX-private)
#1:     89 %      pve10 (acme-bugs-bunny)
#2:     66 %      pve10 (acme-elmer-fudd)

See the help for more options:

usage: proxtop [-h] [-T TOP] [-t TIMEFRAME] [-g AGGREGATION]
               [--only-storage ONLY_STORAGE]
               hostname username [only_vms [only_vms ...]]

proxtop lists the top resource consumers on your Proxmox VM platform.

positional arguments:
  hostname              Use this API hostname (e.g. proxmox.example.com[:443])
  username              Use this API username (e.g. monitor@pve)
  only_vms              Limit results to these VM names (globbing is allowed)

optional arguments:
  -h, --help            show this help message and exit
  -T TOP, --top TOP     Limit results to TOP VMs
  -t TIMEFRAME, --timeframe TIMEFRAME
                        Timeframe, can be one of: hour* | day | week | month |
                        year
  -g AGGREGATION, --aggregation AGGREGATION
                        RRD aggregation, can be one of: AVERAGE | MAX |
                        MEDIAN*
  --only-storage ONLY_STORAGE
                        Filter VMs by storage glob (e.g. "nfs03*")

Default values may be placed in ~/.proxtoprc. Lines should look like:
hostname=HOSTNAME, username=USERNAME, password=PASSWORD

License

proxtop is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 or any later version.

Future

Possible future enhancements:

Explain how server-side AGGREGATION affects the values (or perhaps remove the AVG/MAX subtypes and show only one, based on -g).
Add alternate modes of output?
Limit results to only one item (cpu, diskread, …)?

Metadata

Release files for proxtop 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for proxtop 0.4.0
File	Size	Uploaded	Provenance
proxtop-0.4.0.tar.gz	20.9 kB	Oct 24, 2022	Without provenance	Details

Release files / proxtop-0.4.0.tar.gz

Download URL	proxtop-0.4.0.tar.gz
Size	20.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`adce529504c8b8cc4eb0f421bbd0179897e265a5b28b1e237f5e7c4fe526615e`
BLAKE2b-256 checksum How to use checksums	`6a4c4c82d7e07ec5e43d68e0a1818cf61e2e227cd0dd5de0051d11a1fe5f2dfc`
Upload date	Oct 24, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.10.6`

Security for proxtop 0.4.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.