GitHub Actions Workflow Telemetry Integration：从边界到验证行
在受控应用程序边界使用 GitHub Actions Workflow Telemetry Integration，保持事件契约较小，并在构建聚合视图之前验证已知结果。
- 1
选择结果
CI 工作流程可靠性
- 2
定义合同
workflow_name、job_name、run_id、run_attempt、状态、duration_ms、存储库和版本
- 3
埋点边界
使用 if:always() 运行该步骤，以便失败的作业生成终端记录，并使用 continue-on-error: true 如果可观测性交付不得更改工作流结论。
- 4
核实证据
Exercise a known fixture, then inspect github_workflow_completed for one correctly typed terminal row.
开始之前
先决条件和界限
- 存储为 GitHub 操作密钥的写入范围 Telemetry 密钥
- 最后一步由always() 保护，并配置为在遥测传输失败时不覆盖工作流程结果
- GitHub 提供的变量的白名单，不包括事件负载、令牌、参与者数据、提交消息和拉取请求内容
交货设置
安装并初始化服务器端
使用带有显式连接和请求超时的 cURL 示例。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
GitHub Actions Workflow Telemetry Integration事件
# Use in a final GitHub Actions step with:
# if: ${{ always() }}
# continue-on-error: true
# env:
# TELEMETRY_API_KEY: ${{ secrets.TELEMETRY_WRITE_KEY }}
# JOB_STATUS: ${{ job.status }}
jq -n --arg workflow_name "$GITHUB_WORKFLOW" --arg job_name "$GITHUB_JOB" --arg run_id "$GITHUB_RUN_ID" --arg run_attempt "$GITHUB_RUN_ATTEMPT" --arg status "$JOB_STATUS" --arg repository "$GITHUB_REPOSITORY" --arg release "$GITHUB_SHA" '{
table: "github_workflow_completed",
data: {
workflow_name: $workflow_name,
job_name: $job_name,
run_id: $run_id,
run_attempt: ($run_attempt | tonumber),
status: $status,
repository: $repository,
release: $release
}
}' |
curl --fail-with-body --connect-timeout 2 --max-time 5 --request POST "https://api.telemetry.sh/log" --header "Authorization: ${TELEMETRY_API_KEY}" --header "Content-Type: application/json" --data-binary @-活动合约
workflow_name、job_name、run_id、run_attempt、状态、duration_ms、存储库和版本
trigger_type、runner_environment、计划、retry_recovered 和批准后受控 error_type
没有 GITHUB_TOKEN、秘密上下文、github.event 有效负载、环境转储、提交消息、不受信任的分叉提供的分支或任意步骤输出
实施检查点
检查站 1
使用 if:always() 运行该步骤，以便失败的作业生成终端记录，并使用 continue-on-error: true 如果可观测性交付不得更改工作流结论。
检查站 2
GitHub 警告上下文可能包含敏感信息，并且某些上下文值应被视为不受信任的输入。仅将记录的允许列表展开到 shell 环境变量中。
检查站 3
使用 GITHUB_RUN_ID 作为逻辑运行标识符，并使用 GITHUB_RUN_ATTEMPT 来区分重新运行。从受控开始时间戳测量持续时间，而不是从不相关的事件推断持续时间。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同，请替换后备表名称。
GitHub Actions Workflow Telemetry Integration 验证查询
SELECT *
FROM github_workflow_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前，请检查事件合同、数据安全指南和上游主要文档。
生产边界
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外，还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID，所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件架构起点
此工作流程的事件契约
在将查询或代码片段适应生产之前，请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 告警
将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。
相关 SQL 查询示例
用 SQL 回答下一个问题
针对此工作流程中的结构化字段运行查询，检查示例结果，并将有用的答案转换为仪表板或警报。
按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成