nix-output-monitor

通过将 nix-build 输出通过 nix-output-monitor (简称 nom) 管道传输,可以在构建过程中获取额外信息。

在构建运行时,nom 会在构建日志底部绘制类似这样的内容:

(注意:为减少混乱,nom 只显示构建或下载时间超过 1 秒的计时器。)

状态

这是一个实验性的有趣项目,已被证明对很多人有用。它的目的是用 Haskell 写一些有趣且有用的东西。欢迎提供反馈、问题或 PR。我不承诺长期维护此项目,但看起来我短期内不会停止。

目前,nom 已经相当完善,支持 nix v1 命令(如 nix-build)和 nix v2 命令(如 nix build)。

欢迎在 https://github.com/maralorn/nix-output-monitor 提交 issue 和 pull request。

从 2.1.0 版本开始,nom 使用 SemVer。版本控制适用于可执行文件的行为。 cabal 项目中的库组件不保证稳定性。

支持

如果您的问题在本 README 中未得到解答,可以在 matrix 上的 #nix-output-monitor:maralorn.de 中提问,或在 github 上开一个 issue。

安装

nixpkgs: nom 已包含在 nixpkgs 中。只需以常规方式安装 pkgs.nix-output-monitor。您可能想从 nixos-unstable 安装以获取最新版本。
cabal: 安装 cabal-install 并在检出的仓库中运行 cabal install。
nix: 或使用 nix build 或 nix-env,或在 nixos 配置中包含此仓库的 flake 输出。

运行

简易方式

警告: 对于 nix 2.10 以下版本,使用 nix build 等新式命令时,显示的构建树可能不完整。

从 2.0 版本开始,nom 二进制文件可作为 nix 的替代品,输出更加丰富多彩,但仅适用于以下命令:

nom build <args>: 行为类似 nix build <args>。
nom shell <args>: 行为类似 nix shell <args>。
nom develop <args>: 行为类似 nix develop <args>。

后两个命令通过两次调用 nix shell 或 nix develop 来工作,第一次使用覆盖的 --run exit 并监控输出,第二次将输出传递给用户。这会通过翻倍评估时间产生性能开销。

此外,通过相应的提供的符号链接调用时,nom 也可替代以下命令:
nom-build <args>: 行为类似 nix-build <args>。
nom-shell <args>: 行为类似 nix-shell <args>。

所有别名内部都使用基于 JSON 的方法(见下一节),并传播错误代码。如果您想要 nom 支持其他 nix 命令,请开一个 issue。

灵活方式

基于 JSON

nix-build --log-format internal-json -v |& nom --json

警告: 别忘了重定向 stderr。这就是 & 的作用。

人类可读日志解析

强烈建议始终附加 --log-format internal-json -v (或使用上述别名)并用 --json 调用 nom。这会给您提供更多信息丰富的输出。

如果您处于无法使用基于 JSON 的 nix 输出的情况,您仍可以使用

nix-build |& nom

警告: 别忘了重定向 stderr。这就是 & 的作用。

这有个优点,也可以用于其他命令如 nixos-rebuild 或 home-manager,在这些命令中传入 --log-format internal-json -v 标志并不容易。nom 会传递它读取的所有内容,如果它不理解的话。这使得它非常适合附加到输出不仅仅是 nix 输出的脚本上。

保留彩色文本

在 JSON 模式下,彩色文本将按预期工作。

在人类可读日志模式下,您可以使用 expect 包中的 unbuffer 命令来保留重定向文本的颜色。

unbuffer nix-build |& nom

说明

图例

Nom 尝试通过符号和颜色传达信息

⏵, 黄色: 正在运行的构建
✔, 绿色: 已完成的构建
⏳︎︎︎, 蓝色: 计划的构建
⚠, 红色: 失败的构建
↓ ⏵, 黄色: 正在运行的下载
↑ ⏵, 黄色: 正在运行的上传
↓ ✔, 绿色: 已完成的下载
↑ ✔, 绿色: 已完成的上传
↓ ⏳︎︎︎, 蓝色: 等待中的下载
∅: 此衍生物过去构建的移动平均值
⏱︎: 运行时间
∑: 所有包和主机的摘要

如果您无法看到所有图标,可能需要另一种终端字体。我推荐 pkgs.nerdfonts 中的任何字体,例如 "JetBrainsMono Nerd Font"。此外,不同的终端可能有不同的效果。我推荐: pkgs.foot。

如何阅读依赖图

nom 树中的每个条目代表一个衍生物。
节点的子节点是直接依赖项。
nom 会尝试向您展示依赖树中最相关的部分,大致以填充终端的三分之一为目标
构建在树中不会打印两次,只会在最低层的依赖项中显示。
nom 会尽最大努力打印所有正在运行或失败的构建、下载和上传,但不会打印节点的每个直接子节点。
使用上面的颜色来阅读摘要

运行示例

远程构建示例:

大量下载的示例:

实现

目前 nom 使用四个信息源:

解析的 nix-build 输出(JSON 或人类可读)
它检查构建结果是否存在于 nix-store 中(仅在人类可读模式下)
它查询 .drv 文件以获取有关 out 输出路径的信息。
它在 $XDG_CACHE_HOME/nix-output-monitor/build-reports.csv 中缓存构建时间。

限制

这可能会以意料之外和意料之中的方式失败。
幸运的是,我认为这个程序除了扰乱您的终端外不会造成任何其他损害。
远程构建有时会显示为正在运行,即使它们实际上仍在等待上传或下载。这是 nix 报告的方式。
终端清除和重新打印是脆弱的。可能会在您的终端或终端宽度上失败。但到目前为止,我已经投入了一些努力使其可用。
这个程序还做了一些假设,比如您的 nix-store 位于 "/nix/store"。

对于人类可读日志解析模式:

nix-output-monitor 从解析 nix-build 输出中获取大部分信息。对于我没想到的用例,解析器可能过于严格或过于宽松。那么显示的数字将会不准确!
nix-build 在下载或上传完成时不显示信息,因此我们目前无法区分已开始和已完成的下载。
对于已完成构建的检测,我们假设每个衍生物都有一个名为 "out" 的输出。