tracebuild

一个小型二进制文件，用于在 GitHub Actions、Travis CI 等系统上为构建添加功能。它底层使用 OpenTelemetry，这意味着您应该能够将其集成到现有的分布式跟踪或指标系统中。

用法

在您的构建中安装二进制文件

curl -L -o tracebuild https://github.com/frigus02/tracebuild/releases/latest/download/tracebuild-linux-amd64
chmod +x tracebuild

生成 ID 和起始时间

TRACEBUILD_BUILD_ID=$(tracebuild id)
TRACEBUILD_BUILD_START=$(tracebuild now)
TRACEBUILD_STEP_ID=$(tracebuild id)
TRACEBUILD_STEP_START=$(tracebuild now)

将每个命令包装在

tracebuild cmd --build $TRACEBUILD_BUILD_ID [--step $TRACEBUILD_STEP_ID] [--name <name>] [--build-name <build_name>] -- my-cmd --with params

每个步骤之后

tracebuild step --build $TRACEBUILD_BUILD_ID [--step $PARENT_SPAN_ID] --id $TRACEBUILD_STEP_ID --start-time $TRACEBUILD_STEP_START [--name <step_name>] [--build-name <build_name>] [--status <success|failure>]

构建完成后

tracebuild build --id $TRACEBUILD_BUILD_ID --start-time $TRACEBUILD_BUILD_START [--name $TRACEBUILD_BUILD_NAME] [--branch <branch>] [--commit <commit>] [--status <success|failure>]

配置

使用环境变量配置导出器。

跟踪示例

Tracebuild 目前最适合跟踪系统。请查看以下示例：

• OpenTelemetry Collector
• Azure Application Insights（使用 OpenTelemetry Collector）
• Jaeger

指标示例

OpenTelemetry 指标规范仍处于实验阶段，因此 tracebuild 中对指标的支持也处于实验阶段。

当前唯一支持的系统是 Prometheus。这里的挑战在于 tracebuild 只运行很短的时间，这并不适合 Prometheus 的基于拉取的指标聚合。为了使用 tracebuild，您需要启动一个 Prometheus Pushgateway，该网关会缓存 tracebuild 指标，直到 Prometheus 抓取它们。如果您的构建命令运行速度比 Prometheus 抓取间隔快，您可能希望推送网关聚合指标。因此，这里使用的 Prometheus 示例采用了 Weaveworks 的 Prometheus 聚合网关

• Prometheus

Tracebuild 导出以下指标

• tracebuild.cmd.duration（标签：name，build_name，exit_code）
• tracebuild.step.duration（标签：name，build_name，status）
• tracebuild.build.duration（标签：name，branch，status）

持续时间指标以直方图的形式导出给 Prometheus。构建时间可能会有很大的变化。为了仍然提供一种查看构建如何随时间变化的方法，直方图包含了从 5 分钟到 45 分钟的 5 分钟间隔的桶。