Skip to main content

Performance monitoring CLI tool for Apple Silicon

Project description

macpm

PyPI - Downloads (https://pypi.org/project/macpm/#files) or: pip install macpm

enhanced MAC Performance monitoring CLI tool for Apple Silicon

pip install macpm

What is macpm

forked form https://github.com/tlkh/asitop

  1. fixed the problem that "E-CPU Usage" and "P-CPU Usage" always 100%
  2. add "Disk IO" and "Network IO" info
  3. adjust the hard coded max power in CPU/GPU/ANE
  4. change the way to call powermetrics, no temp files in /tmp
  5. press ESC or q to quit
  6. press LEFT or RIGHT to switch color, press 1 : default view, 2 : show_core view
  7. fix M1 has no "down_ratio" tag problem, fix p-core cpu usage

A Python-based nvtop-inspired command line tool for Apple Silicon (aka M1) Macs.

  • Utilization info:
    • CPU (E-cluster and P-cluster), GPU
    • Frequency and utilization
    • ANE utilization (measured by power)
  • Memory info:
    • RAM and swap, size and usage
    • (Apple removed memory bandwidth from powermetrics)
  • Power info:
    • CPU power, GPU power (Apple removed package power from powermetrics)
    • Chart for CPU/GPU power
    • Peak power, rolling average display

macpm uses the built-in powermetrics utility on macOS, which allows access to a variety of hardware performance counters. Note that it requires sudo to run due to powermetrics needing root access to run. macpm is lightweight and has minimal performance impact.

macpm only works on Apple Silicon Macs on macOS Monterey!

Installation and Usage

macpm is a Python-based command line tool. You need pip to download and install macpm. macOS already comes with Python, to install pip, you can follow an online guide. After you install macpm via pip, you can use it via the Terminal.

# to enter password before start
# this mode is recommended!
sudo macpm

# it will prompt password on start
macpm

# advanced options
macpm [-h] [--interval INTERVAL] [--color COLOR] [--avg AVG]
optional arguments:
  -h, --help           show this help message and exit
  --interval INTERVAL  Display interval and sampling interval for powermetrics (seconds)
  --color COLOR        Choose display color (0~8)
  --avg AVG            Interval for averaged values (seconds)

How it works

powermetrics is used to measure the following:

  • CPU/GPU utilization via active residency
  • CPU/GPU frequency
  • Package/CPU/GPU/ANE energy consumption
  • CPU/GPU/Media Total memory bandwidth via the DCS (DRAM Command Scheduler)

psutil is used to measure the following:

  • memory and swap usage

sysctl is used to measure the following:

  • CPU name
  • CPU core counts

system_profiler is used to measure the following:

  • GPU core count

Some information is guesstimate and hardcoded as there doesn't seem to be a official source for it on the system:

  • CPU/GPU TDP
  • CPU/GPU maximum memory bandwidth
  • ANE max power
  • Media engine max bandwidth

Why

Because I didn't find something like this online. Also, just curious about stuff.

Disclaimers

I did this randomly don't blame me if it fried your new MacBook or something.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

macpm-0.23.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

macpm-0.23-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file macpm-0.23.tar.gz.

File metadata

  • Download URL: macpm-0.23.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.6

File hashes

Hashes for macpm-0.23.tar.gz
Algorithm Hash digest
SHA256 69814752070f700d4f31b9aff9d8a10b0185bb067b8954a7b2a02b373199c4d8
MD5 599d8047cce62fe2aaf830eb1697d8c8
BLAKE2b-256 503aac83ae1ddf6c876f71525b4ec9618edb014048c2d9fb69e96071d882808a

See more details on using hashes here.

File details

Details for the file macpm-0.23-py3-none-any.whl.

File metadata

  • Download URL: macpm-0.23-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.6

File hashes

Hashes for macpm-0.23-py3-none-any.whl
Algorithm Hash digest
SHA256 9c9fd19de9a6eece6836be335c24e0c22564fb8e14593ae4396f26988f2582e3
MD5 b9fafcf2df0485bc627e0fede8870b3e
BLAKE2b-256 bf22e17c72691343e54c273deffde45fa091548202fb45b6f1e33237976790f8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page