Skip to main content

cannLog: CANN simulation log parser and web viewer

Project description

cannLog

用于浏览和解析 cannsim 仿真日志的本地 Web 可视化工具。后端给定日志目录启动,前端在浏览器中动态查看日志、访存数据和指令关联关系。

安装

从 PyPI 安装:

pip install cannLog

从源码安装:

pip install .

开发模式安装:

pip install -e .

安装后主命令是 cannLog

cannLog /path/to/log_dir --host localhost --port 18000

也保留了兼容别名:cann-log-parsercann-log-viewer

也可以继续使用模块入口:

python -m cann_log_parser.server /path/to/log_dir --host localhost --port 18000
python -m app.server /path/to/log_dir --host localhost --port 18000

打开:http://localhost:18000

默认 host 是 localhost,默认端口是 18000。如果不传 --port18000 被占用,会自动尝试后续端口;如果显式传了 --port,端口被占用时会直接提示并退出。

远程机器上运行时:

  • 如果使用 VS Code Remote,可以在 Ports/端口 面板中转发服务提示的端口,然后点浏览器图标打开。
  • 如果没有 VS Code 端口转发功能,在本地终端建立 SSH 隧道:
ssh -N -L 18000:127.0.0.1:18000 <user>@<ip>

然后在本地浏览器打开:http://localhost:18000。如果服务自动切换到了其它端口,把命令里的 18000 换成实际提示的端口。

已支持的日志类型

  • 指令日志:*.instr_log.dump*.instr_popped_log.dump
  • 访存日志:*.rd_log.dump*.wr_log.dump
  • PV 访存日志:*rvec_pv.dump,按指令 ID 合并 Rd/Wr 数据块并支持解码
  • CCU/队列事件:*.ccu_log.dump*issque.dump*.OOO.dump
  • PMU/summary:*.perf_pmu.log*.perf_pmu_per_vf.log*summary_log

功能

  • 给定日志目录启动本地 Web 服务
  • 前端动态加载文件树和事件页,大日志分页读取
  • 访存日志按指令 ID 合并展示;同一指令拆开的多个数据块会作为同一事件的多个 block 展示
  • 支持 hex32uint8/int8uint16/int16/float16/bfloat16uint32/int32/float32uint64/int64/float64 解码
  • instructionId 跨文件查询关联访存事件,并可跳转定位到具体事件
  • 支持分类、Core、Unit、文件名过滤
  • 支持多日志页签、右键菜单、新窗口打开、重载日志

使用示例

cannLog /mnt/workspace/log/cann-sim/log_ca --host 0.0.0.0 --port 18000

打开:http://localhost:18000

API

  • GET /api/overview
  • GET /api/files
  • GET /api/file?path=...&page=1&pageSize=50
  • GET /api/stats?path=...
  • GET /api/instruction-memory?instructionId=4309
  • GET /api/decode-memory?path=core0.veccore0.ub.wr_log.dump&eventIndex=0&dtype=float32
  • POST /api/reload

打包发布到 PyPI

安装构建和上传工具:

python -m pip install build twine

构建源码包和 wheel:

python -m build

检查包元数据:

python -m twine check dist/*

上传到 TestPyPI:

python -m twine upload --repository testpypi dist/*

上传到正式 PyPI:

python -m twine upload dist/*

发布前建议:

  • 确认 pyproject.toml 中的 name = "cannLog" 没有被 PyPI 占用
  • 为每次发布递增 version
  • 许可证已在 LICENSEpyproject.toml 中声明为 MIT

实现说明

  • 后端仅使用 Python 标准库,无运行时依赖
  • 前端为原生 HTML/CSS/JS,无需构建
  • 静态资源已作为 package data 打进 wheel,pip 安装后可直接运行

许可证

本项目使用 MIT License,详见 LICENSE

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

cannlog-0.1.1.tar.gz (33.8 kB view details)

Uploaded Source

Built Distribution

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

cannlog-0.1.1-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

Details for the file cannlog-0.1.1.tar.gz.

File metadata

  • Download URL: cannlog-0.1.1.tar.gz
  • Upload date:
  • Size: 33.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for cannlog-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7b8d596e12eddfe7167cbc4be5fa5535f56b711408da8c27c7c3cc2b5b18cfb8
MD5 bc5b295fde8ad674ca23d7fc99a7e534
BLAKE2b-256 cfcfb11bfa3baf78888cdbe8c92e0025ace203605a867123a3ad8fb33b1870df

See more details on using hashes here.

File details

Details for the file cannlog-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cannlog-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 34.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for cannlog-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6d3bb5e3864896f2a82501035d51d5fbd4cf2d4180c13bcb2a0e2e3a72170c1f
MD5 0af28370f6bf7dfeec7c336a34779032
BLAKE2b-256 e0be35245d4903872cae52d3136126fc2a127eacf37fbb76481e5517dbcbf981

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