Webgrind 技术文档

1. 安装指南

下载与解压

首先，您需要下载 Webgrind 的最新版本。下载完成后，将其解压到您的服务器上一个可通过 Web 服务器访问的路径。

权限设置

为了加速预处理，建议给予 bin 子目录写入权限。具体操作如下：

• 在 Linux 或 Mac OS X 系统中，进入解压后的文件夹执行 make 命令（需要 GCC 或 Clang）。
• 在 Windows 系统中，进入解压后的文件夹执行 nmake -f NMakeFile 命令（需要 Visual Studio 2015 或更高版本）。

使用 Docker

您也可以使用官方的 Docker 镜像来快速查看 xDebug 的分析文件，而无需上传到 Web 服务器或启动本地服务器。使用以下命令来启动 Docker 容器：

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

将 /path/to/xdebug/files 替换为您分析文件的实际路径。启动后，在浏览器中访问 http://localhost。使用完毕后，按 CTRL / Strg + C 可以停止 Docker 容器。

若要使用内置的文件查看器，请将相应的文件挂载到容器的 /host 目录下。

2. 项目的使用说明

Webgrind 是一个基于 PHP 的 Xdebug 分析前端，它能够跟踪函数执行的时间，并区分自身耗时和包含其他函数调用的总耗时。您可以通过浏览器访问 Webgrind，并开始分析您的 PHP 应用程序。

启动分析

• 将 Webgrind 解压后的文件夹通过 Web 服务器访问。
• 在浏览器中输入对应的 URL 访问 Webgrind。
• 开始您的应用，Webgrind 会自动捕获 xdebug 分析数据。

功能亮点

• 跨平台简易安装。
• 跟踪函数的自身耗时和总耗时。
• 区分时间消耗在内部函数还是用户函数。
• 查看函数调用来源和被调用的函数。
• 使用 gprof2dot.py 生成调用图。

3. 项目API使用文档

Webgrind 主要通过 Web 界面进行交互，没有提供传统意义上的 API。不过，您可以利用其分析结果，通过编程方式处理这些数据，例如生成调用图等。

4. 项目安装方式

Webgrind 的安装方式有以下几种：

• 手动下载、解压并设置写入权限，如前所述。
• 使用 PHP 内置服务器，执行 composer serve 或 php -S 0.0.0.0:8080 index.php（若不使用 Composer）。
• 使用 Docker，通过运行上述提供的 Docker 命令。

以上是 Webgrind 的技术文档，希望对您有所帮助。