# monitorViewer **Repository Path**: ByteDance/monitorViewer ## Basic Information - **Project Name**: monitorViewer - **Description**: No description available - **Primary Language**: Unknown - **License**: GPL-3.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-11-19 - **Last Updated**: 2025-06-13 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README **Version:** V1.0 ## What's monitorViewer? monitorViewer includes a python framework for customing monitoring scripts and a set of information dashboards. Users can easily customize their monitoring items based on monitorViewer. * Below is a demo of GUI dashboard. ![GUI_demo](data/demo/gui_alarm_demo.png) * Below is a demo web dashboard. ![web_demo](data/demo/web_demo.png) ## Python dependency Need python3.12.7 Install python library dependency with command pip install -r requirements.txt ## Install Copy install package into install directory. Execute below command under install directory. python3 install.py ## Configuration Come into /config directory, - Update "config.py" for monitorViewer basic configuration. ## Generate scripts - Suggest to generate custom monitoring script into scripts//. - Use python class "SaveLog" to save log and send alarm, the class is on common/common_monitor.py. - Startup scripts with crontab or Jenkins. ## View monitor items - Execute $MONITOR_VIEWER_INSTALL_PATH/bin/monitor_viewer to run view custom monitoring items (heartbeat/log/alarm). ## Start web - Execute $MONITOR_VIEWER_INSTALL_PATH/web/run.sh to start web. ## Doc More details please see ["docs/monitorViewer_user_manual.pdf"](./docs/monitorViewer_user_manual.pdf) ## Update history *** |Version |Date |Update content | |:-------|:----------|:------------------------| | V1.0 |(2024.11) |Release original version |