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 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合