Build Monitor 设置
Build Monitor 允许您以可视化方式查看构建进度。该功能与基于文本的常规输出相比拥有重要优势,例如能够对构建进行分析,从而更加轻松地检测错误、查找瓶颈以及修复当前阻碍构建进度的问题。
打开 Build Monitor
从 Visual Studio IDE 或 Agent Tray Icon 处启动构建时,Build Monitor 会自动打开。Build Monitor 也可以通过以下方式打开:
-
在 Visual Studio IDE 中,选择 Incredibuild 菜单中的“Open Monitor”。
-
双击 Incredibuild 任务栏图标。
-
使用 /OPENMONITOR 命令行控制台(BuildConsole 和 IBConsole)。
显示图标及其含义
图标 | 描述 |
---|---|
Progress display;分布式构建进程的可视化表示。 | |
Output display;显示了整个构建的输出文本,与 Microsoft Visual Studio C++ 构建所生成的内容类似。 | |
Projects display;仅适用于 Microsoft Visual Studio C++ 构建;针对每个所构建的项目/配置,显示来自执行工具的标准输出,包括警告和错误消息。 | |
Summary display;包含有关当前构建的信息和统计数据。 | |
Warning display;显示了作为执行一部分的警告;仅在发生警告时才会出现。 | |
您了解吗?;包含了有关如何充分利用 Incredibuild 的有用提示。 |
构建显示选项
以下部分描述了各种不同的构建显示,要选中其一,需点击 Build Monitor 左侧垂直菜单中的相关图标:
Progress Display
Progress Display,作为 Build Monitor 的主视图,呈现了分布式构建进程的可视化表示。
每个构建文件均由一种彩色条表示,具体颜色取决于文件类型和状态,如下方图表中所述:
颜色 | 文件类型和状态 |
---|---|
紫色 | 当前运行任务 |
蓝绿色 | 已成功终止的本地运行任务(自定义构建步骤、链接操作或浏览信息的创建) |
绿色 | 已成功终止的在本地或远端机器上运行的可分发任务(例如 Visual Studio、cl.exe 中的编译任务)。 |
黄色 | 指用于生成构建警告的文件。 |
红色 | 指构建失败的文件。 |
白 |
一项任务被取消或转移到另一个 helper 上。 |
将鼠标指针悬停于彩色条上方,可显示截至当前位置的已用时间,以及有关该文件的任何其他可用信息。显示内容也可以向各个方向平移(单击并拖动鼠标),也可以放大或缩小(CTRL/SHIFT+鼠标点击)
右键点击进度条,可显示上下文菜单。该菜单提供以下选项:
Go to Output | 跳转到 Project Display 中的相应行,以显示该文件的输出文本。双击进度条,也可以执行此操作。 |
---|---|
Go to Source | 在 MSVC 编辑器中打开源文件。仅在 Microsoft Visual C++ 开发环境中使用监视器时,才会启用此选项。 |
Zoom In / Zoom Out | 更改显示内容的水平比例。如放大,所显示的条栏会加长,为文件名留出更多空间。使用鼠标滚轮或 +/- 键,也可以进行放大或缩小。 |
View Agents Bar | 显示或隐藏左侧 Agent 列表。 |
View Time Bar | 显示或隐藏用于显示时间单位、进度和处理能力的底栏。 |
View System Graphs | 切换显示系统图表,可用于监视系统状态。 |
Select System Graphs.. | 在查看系统图表的同时,显示图表选择窗口。 |
Arrange Agents | 在显示内容中重新排列 Agent 的顺序,以便在最上方显示当前正在参与的 Agent。 |
Auto Arrange | 选中此选项,将启用一种确保当前正在参与的 Agent 始终显示于最上方的操作模式。 |
如果处于详细日志级别,并右键点击条栏,以下两个用于故障诊断的选项即可用:
- Save Detailed Log...–保存日志文件,该文件可发送至 Incredibuild 支持团队以分析已执行进程的执行情况。
- View Process Activity–打开查看器,以显示远端运行进程执行情况的跟踪信息。查看器可显示已执行进程及其子进程的 stdout 输出和 stderr 输出,以及 PID 信息和环境区块。
使用显示内容右上方的按钮,可进行放大/缩小,以显示或隐藏系统图表,以及切换显示 Agent/时间栏。
备注:
- 在 Visual Studio 构建和 Make and Build 工具中双击条栏,当前运行任务的输出将自动打开。
- 在使用 Submission Interface 或 Automatic Interception Interface时,如果双击构建运行中的条栏不起作用,您通常可以使用关键字 IdentifyTaskOutput 来解决此问题。
Output Display
与 Projects Display 的格式类似,Output Display 可显示整个执行的构建输出,或者说,它可以显示由 Incredibuild 运行的所有内容。其输出与 Microsoft Visual C++ 的输出类似,令习惯于这种输出的用户感到更加方便。
使用 Output Display 时,以下功能可用(右键点击显示的上下文菜单和工具栏,也可将以下功能变为可用):
Text Find Tool | 使用 CTRL-F 键盘快捷键执行文本搜索,或使用 F3/SHIFT-F3 查找下个/上个文本。 |
---|---|
Next/Previous Error Message | 使用 F8/CTRL-F8 键盘快捷键在构建输出中的错误消息之间导航。在 MSVC IDE 中使用该功能时,编辑器中相关代码行的源文件也会打开。 |
Next/Previous Warning/Error Message | 使用 F4/SHIFT-F4 键盘快捷键在构建输出中的警告和错误消息之间导航。在 MSVC IDE 中使用该功能时,编辑器中相关代码行的源文件也会打开。 |
Bookmark options | 使用 CTRL-K + K 键盘组合以切换当前行书签。使用 CTRL-K + N(下一书签)和 CTRL-K + P(上一书签)键盘组合,在已定义书签之间跳转。 |
Open Source File | 在 MSVC IDE 中使用该功能时,双击提示消息也会打开编辑器中相关代码行的源文件。 |
Auto Scroll | 选中此功能时,显示内容将自动滚动,始终显示最新构建文件的输出。将光标移动至文本中任何位置,均会使显示内容停止滚动。 |
注意:我们在版本 9.6 中更新了 Build Monitor,目前在 Build Monitor 的 Messages 区域,如果有任何实例,其 Helper 无法执行任务的时间持续超过几秒,就会显示警告(标记为“任务执行未成功。正在重试...”)。先前版本中未显示这些实例,且这些实例并不代表存在新问题。
Projects Display 支持此相同的功能列表。
备注:
- 在 Visual Studio 中,由于 Incredibuild 经常一次性构建多个项目,一些构建输出的缓冲需要执行,以确保不同配置的输出不会混淆。该行为可能会导致 Output Display 中不显示文件,即便文件已经构建完成。要查看所有文件的构建输出,请使用 Projects Display。
Projects Display
Projects Display 仅适用于 Visual Studio 的构建。
Projects Display 的左侧窗格显示了参与当前构建的配置列表。每个配置均会显示相应条栏;在 Visual Studio 2008 及更早版本中,此处为显示配置进度的进度条,其颜色依当前状态而定;在 Visual Studio 2010 及更高版本中,此处为显示配置状态的状态栏。
点击左侧窗格中的配置名称,右侧窗格将显示该配置的构建输出,其格式与 MSVC 的输出窗口类似。与 MSVC 的标准输出显示相比,此显示具有以下增强功能:
- 在 Visual Studio 2008 及更早版本中,多行消息可以展开或折叠,以保持显示的简洁度。默认情况下,仅多行错误消息会展开,所有其他消息在初始状态下均会折叠。此行为可以在 Agent Settings 对话框,Build Monitor>General 页面中进行修改。
- 警告和错误消息分别用黄色或红色图标标记,以便更轻松地定位这些消息。
Projects Display 支持 Output Display 中相同的可用功能列表。
Summary Display
Summary Display 用于显示描述构建进度和状态的各种统计数据,以及当前所使用的处理能力和许可证信息。
Warning Display
Warning Display 用于显示在 Incredibuild 执行构建过程中发生的系统警告。如果您需要隐藏不想看到的警告,或显示当前处于隐藏状态的警告,可以在 Agent Settings->Build Monitor->Warnings 对话框中,取消选中/选中警告复选框,即可实现隐藏/显示。
System Graphs
Progress 视图可用于在构建过程中监视各种不同的系统参数。
要查看 System Graphs:
- 右键点击显示并选择 View system graphs。会打开图表显示,其中将显示当前选定图表。将鼠标光标悬停于图表之上,将显示当前图表在选定时间节点的值。
要对显示哪些系统参数进行控制:
-
右键点击显示并选择 Select system graphs...,将显示一个窗口,您可以在其中控制系统参数及相应的图表颜色。
好用的 Monitor 功能
在 Build Monitor 中,您可以执行以下操作:
-
查看任意项目的输出分发,双击 Projects Display 中的条栏即可。
-
跳转到构建输出中的第一个警告或错误,双击黄色或红色状态栏即可。
-
选择状态栏如何计算在构建过程中跳过的文件(将文件计为已完成或完全忽略),方法是点击状态栏正上方的小型向下箭头图标。
安装独立 Build Monitor Viewer
在典型安装过程中,每个 Agent 均会安装 Build Monitor。然而,您可以在 Build Monitor 中保存构建文件,并在不含 Incredibuild 许可证的机器上查看它们。要实现此功能,在任意机器上安装独立 Build Monitor Viewer 即可(无需许可证)。
现在,您即可在此不含 Incredibuild 许可证的机器上打开已存构建文件。