Webgrind Docker镜像文档

镜像概述

Webgrind是一个基于PHP开发的Xdebug分析Web前端工具，实现了kcachegrind的部分核心功能。它具有安装快速、跨平台的特点，能够帮助开发者通过Web界面直观地分析Xdebug生成的性能分析数据，适用于快速优化PHP应用性能。

!Webgrind界面示例（点击查看大图）

核心功能和特性

• 简单跨平台安装：无需复杂配置，秒级完成部署，支持各类操作系统
• 函数时间跟踪：可按函数自身执行时间（self cost）或包含子函数调用的总时间（inclusive cost）统计
• 函数类型区分：清晰展示时间消耗在内部函数（PHP内置）还是用户自定义函数
• 调用关系分析：查看任意函数的调用来源及被其调用的函数列表
• 调用图生成：集成gprof2dot.py工具，可生成可视化的函数调用关系图

使用场景

适用于需要快速分析PHP应用性能瓶颈的开发者，尤其是在缺乏复杂性能分析工具安装条件时。可帮助开发者：

• 定位执行时间过长的函数
• 分析函数调用链中的性能损耗点
• 区分内部函数与业务代码的性能占比
• 通过可视化调用图直观理解代码执行流程

使用方法

常规安装

1. 下载Webgrind源码包
2. 将解压后的文件放置到Web服务器可访问的路径下
3. 在浏览器中访问Webgrind页面，开始分析Xdebug生成的性能数据

对于PHP 5.4及以上版本，可使用PHP内置服务器运行：

bash
# 若使用Composer
composer serve

# 若不使用Composer
php -S 0.0.0.0:8080 index.php

预编译优化（可选）

为提升预处理速度，可授予bin子目录写权限，或手动编译：

• Linux / macOS：在解压目录执行make（需GCC或Clang）
• Windows：在解压目录执行nmake -f NMakeFile（需Visual Studio 2015及以上）

Docker使用

通过Docker镜像可快速启动Webgrind，无需配置Web服务器：

bash
docker run --rm -v /path/to/xdebug/files:/tmp -p 80:80 jokkedk/webgrind:latest

• /path/to/xdebug/files：本地存放Xdebug生成的分析文件的路径，需替换为实际路径
• -p 80:80：将容器的80端口映射到主机80端口，可根据需要修改主机端口（如-p 8080:80）

启动后，在浏览器访问http://localhost即可使用Webgrind。使用完毕后，按CTRL/Strg + C停止容器。

若需使用内置文件查看器，可将相关文件挂载到容器的/host目录：

bash
docker run --rm -v /path/to/xdebug/files:/tmp -v /path/to/app/files:/host -p 80:80 jokkedk/webgrind:latest

维护与贡献

• 原始作者：Joakim Nygård、Jacob Oettinger
• 特别感谢：Xdebug开发者Derick Rethans
• 当前维护者：Micah Ng（GitHub: alpha0010）

欢迎提交改进建议和新功能需求，项目仍在持续发展中。