Thanks for downloading emuMonitor.

emuMonitor is a tool for "palladium" , "zebu" and "protium" usage information data-collection, data-analysis and data-display.

The tool use flow is as below:

For palladium:

installation -> configuration -> sampling -> monitoring

For zebu:

installation -> configuration -> monitoring

For protium:

installation -> configuration -> sampling -> monitoring

INSTALLATION:

To install it, make sure you have Python 3.8.8 installed, you can also install Anaconda3-2021.05 to solve packge dependency. Then run below command to install it: Come into install directory, then execute below command.

python3 install.py

CONFIGURATION:

After installing the tool, come into <EMU_MONITOR_INSTALL_PATH>/config directory, then update file config.py for your own configuration. Refer to the emuMonitor_user_manual.pdf in the doc directory for configuration references.

SAMPLING:

Use bin/psample sample current palladium usage information first, then pmonitor can show palladium current/history/utilization information. Below is the suggested crontab setting on sampling data.

On Palladium Z1 compile host. SHELL=/bin/csh PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:<BSUB_PATH> 0 */2 * * * <EMU_MONITOR_INSTALL_PATH>/bin/psample -H Z1

On Palladium Z2 compile host. SHELL=/bin/csh PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:<BSUB_PATH> 0 */2 * * * <EMU_MONITOR_INSTALL_PATH>/bin/psample -H Z2

On Protium X1 compile host. SHELL=/bin/csh PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:<BSUB_PATH> 0 */2 * * * <EMU_MONITOR_INSTALL_PATH>/bin/protium_sample -H X1

On Protium X2 compile host. SHELL=/bin/csh PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:<BSUB_PATH> 0 */2 * * * <EMU_MONITOR_INSTALL_PATH>/bin/protium_sample -H X2

Suggested sampling frequency is 2 hours.

MONITORING:

Execute below command to start palladium monitor function. <EMU_MONITOR_INSTALL_PATH>/bin/palladium_monitor

Execute below command to start zebu monitor function. <EMU_MONITOR_INSTALL_PATH>/bin/zebu_monitor

Execute below command to start protium monitor function. <EMU_MONITOR_INSTALL_PATH>/bin/protium_monitor

LICENSE:

This tool use "GNU GENERAL PUBLIC LICENSE (Version 3)" license. For more details please see file "LICENSE".

DOC:

For more documents please see files under "docs".

AUTHOR:

liyanqing.1987 zhangjingwen.silvia makun.226

OTHERS:

Please contact below email if any issue or question: liyanqing.1987@bytedance.com zhangjingwen.silvia@bytedance.com makun.226@bytedance.com