跳至內容

Elixir 建構洞察

Tuist 嘅 Hex 套件可以將建構分析數據傳送到 Tuist。建構時間、檔案之間嘅依賴關係圖,以及兩者隨時間嘅變化,提供你優化建構圖所需嘅資訊,並充分利用編譯環境中可用嘅所有核心。

要求

報告你嘅建構#

共享設定會安裝編譯整合。繼續使用你慣用嘅指令:

bash
mix compile

整合涵蓋 mix compile 以及其他任務觸發嘅每次編譯,例如 mix test 或 mix phx.server。如果編譯發現無嘢需要做,就不會報告,因此儀表板只會列出實際執行工作嘅建構。

報告參與者聲明#

只有當你明確設定標籤時,Mix 建構同測試報告請求才會包含可選嘅 x-tuist-actor-id 標頭。將 TUIST_ACTOR_ID 設定為組織範圍內嘅標籤,或者將 actor_id: "developer-label" 加入項目嘅 tuist 設定。解析優先順序為:環境變數,然後係運行時 :actor_id 選項,最後係項目設定。預設情況下不會發送標籤,而且套件不會偵測作業系統用戶名。固定嘅項目標籤適用於所有使用該設定嘅人。空白或無效嘅覆寫會省略聲明而唔會回退;這不會移除基於憑證嘅已驗證身份。如果自訂代理伺服器拒絕不熟悉嘅標頭,請使用 TUIST_ACTOR_ID="" 選擇退出。

識別碼必須係 1–128 字節嘅非空格可打印 ASCII。無效嘅覆寫會被省略而唔會回退。已驗證嘅個人憑證具有優先權;其他客戶端報告嘅識別碼會顯示為 未驗證,永遠不會授權訪問,亦都不會自動連結到用戶。任何可以查看項目報告嘅人都可以看到這些識別碼,包括項目公開時嘅公眾檢視者,並且它們會包含在數據匯出中,所以不要包含機密資料。舊伺服器會忽略可選標頭,而新伺服器會接受沒有該標頭嘅舊客戶端。沒有識別碼嘅新共享令牌報告會顯示 未知,而唔係發布組織;歷史報告會保留其先前嘅歸屬。預設情況下,建構同測試報告需要身份驗證。自託管安裝可以按照下面描述嘅方式明確啟用免憑證報告。

私人網絡上嘅免憑證報告#

當營運者在實例上設定 TUIST_NETWORK_TRUSTED_INSIGHTS_ACCESS=true 並按照 自託管指南 中所述重新啟動後,設定你嘅目標。SDK 會自動偵測當缺少憑證時,實例是否允許免憑證報告。實例設定涵蓋所有支援嘅項目,並且儀表板上沒有切換開關:

elixir
tuist: [
url: "https://tuist.internal.example",
project: "account/project"
]

mix tuist.compile 同 mix tuist.test 會在憑證確實缺失且偵測確認伺服器允許時,發布結構化報告而無需登入。不需要客戶端標誌或項目選擇加入。現有憑證(包括提供嘅 CI OIDC 身份)會被使用或拒絕,永遠不會被忽略以降級為未簽名報告。只包含空白字符嘅 TUIST_TOKEN 係錯誤。空白嘅 TUIST_TOKEN 可以回退到有效嘅儲存憑證或提供嘅 OIDC,而过時嘅儲存憑證可以回退到提供嘅 OIDC;兩條路徑都保持身份驗證狀態,永遠不會啟用未簽名報告。無法使用嘅憑證會被保留,並且在沒有成功嘅身份驗證回退時失敗。在升級免憑證客戶端之前,先將每個伺服器副本升級到支援偵測嘅版本;沒有偵測功能嘅舊伺服器、已禁用嘅實例以及偵測失敗仍然需要身份驗證。

未簽名運行係遙測數據,唔係可信嘅不穩定性、隔離、覆蓋率或選擇性執行證據。分片規劃、建構存檔以及覆蓋率/工件端點仍然需要憑證。獨立設定 TUIST_ACTOR_ID="" 以省略已設定嘅參與者聲明;已驗證嘅憑證身份不受影響。

追蹤內容#

對於每次建構,套件會收集:

  • 其持續時間、是否成功,以及運行時嘅 Elixir、Erlang/OTP 同 Mix 環境
  • 每個警告同錯誤,連同其檔案同行號
  • 每個檔案編譯所需嘅時間,以及它定義嘅模組
  • 每個檔案依賴嘅檔案,以及係編譯時定係僅在運行時需要它們
  • 除咗編譯檔案之外,建構還做咗乜嘢,例如類型檢查、寫入磁盤以及其他 Mix 編譯器
  • 建構期間機器嘅處理器、記憶體、網絡同磁盤使用情況
  • 分支同提交,以及在持續集成中嘅提供者同運行

找出拖慢建構速度嘅原因#

從儀表板上嘅 建構 → 建構運行 打開一個建構。建構、它們嘅診斷計數以及它們嘅依賴緩存摘要亦可通過 tuist build mix list 同 tuist build mix show、GET /api/projects/{account_handle}/{project_handle}/mix/builds,以及 list_mix_builds 同 get_mix_build MCP 工具 獲得。

概覽 標籤頁列出建構編譯嘅檔案。你可以按模組將它們分組、搜索它們,並按以下方式排序:

  • 編譯持續時間,以找出本身較慢嘅檔案。
  • 編譯時依賴者,即在此檔案編譯完成之前無法編譯嘅檔案數量。一個有許多依賴者嘅慢速檔案會阻礙建構嘅其餘部分,更改它會重新編譯所有依賴者。
  • 編譯時依賴項,即此檔案等待嘅檔案數量。

Phoenix 應用程式嘅 Mix 建構概覽

時間線 標籤頁顯示同一建構隨時間嘅變化:哪些檔案並行編譯,建構在哪裡進行類型檢查同寫入磁盤,以及機器在每個時刻嘅狀態。只有一條條形嘅區間表示建構無法使用其擁有嘅核心。

Phoenix 應用程式完整 Mix 建構嘅時間線

警告 同 錯誤 標籤頁列出建構嘅診斷信息。

自訂元數據#

將標籤同鍵值數據附加到 Mix 建構,以區分來自不同團隊、硬件或工作流程嘅運行。兩者都會出現在每個建構嘅詳細頁面。

使用環境變數設定元數據:

bash
export TUIST_TAGS="nightly,release"
export TUIST_VALUES="ticket=TUIST-123,runner=linux-arm64"

你亦都可以在 mix.exs 中設定元數據:

elixir
tuist: [
project: "account/project",
tags: ["nightly", "release"],
values: %{"ticket" => "TUIST-123", "runner" => "linux-arm64"}
]

兩處設定嘅標籤會合併。如果同一個鍵喺兩處都有設定,環境變數中嘅值優先。

標籤只能包含字母、數字、連字號同下劃線。一個建構最多可以有 50 個標籤,每個標籤最多 50 個字符。一個建構最多可以有 20 個鍵值對條目,每個鍵最多 50 個字符,每個值最多 500 個字符。呢啲係與 Xcode 建構元數據相同嘅服務器端限制。套件喺發送報告之前會跳過無效標籤以及過大或空嘅元數據條目,所以無效配置唔會阻止剩餘嘅建構洞察報告被存儲。對於唔符合標籤約束嘅值,請使用鍵值元數據。

自訂元數據附加到建構,而唔係測試運行。

項目成員可以喺儀表板上看到自訂元數據。唔好將佢用於憑證、訪問令牌或其他敏感數據。Tuist 會保留 Mix 建構數據(包括此元數據)90 日。詳情請參閱 數據保留政策。

疑難排解#

報告永遠唔會改變你嘅建構結果:如果報告無法發送,建構會照常完成,並且唔會打印任何內容。要查看報告未發送嘅原因,請設定 TUIST_DEBUG=1:

bash
TUIST_DEBUG=1 mix compile --force