Cortex Framework 中的遙測

Cortex Framework 會在部署和同步處理程序中收集匿名使用統計資料。

資料收集目的

  • 功能採用評估：監控架構模組和資料產品的部署頻率，可做為開發優先順序的依據。
  • 整合模式識別：追蹤已連線的來源系統變體 (例如 SAP ECC、SAP S/4HANA)，有助於驗證相容性，並優先維護這些整合項目。

遙測功能預設為啟用。如要停用，請參閱「停用遙測」一節。

收集的資料

框架會收集設定 ID，例如資料集 ID、資料產品執行個體 ID 和存放區 ID。系統不會收集使用者身分屬性，例如姓名、電子郵件或 IP 位址。

  • Google Cloud 雲端專案編號：識別執行 Deployment 的專案，並在 X-Goog-User-Project 標頭中傳輸，以匯總用量。
  • 部署區域或位置：部署目標資源的區域，用於追蹤地理分布情形。
  • 架構版本：使用的 Cortex Framework 程式碼集版本 (例如 7.0.0)。
  • 元件名稱：要執行的頂層架構元件 (例如 platform、data-product 或 foundation)。
  • 工具類型：執行的特定 CLI 指令或公用程式 (例如 deployer 或 knowledge-catalog)
  • 目標變體：已部署模組的來源系統或網域類別 (例如 sap 或 marketing)。
  • 已啟用的模組類型：設定中啟用的個別模組目錄名稱或路徑。
  • Dataform 存放區 ID：目標 Dataform 存放區的使用者設定名稱。
  • BigQuery 資料集 ID：使用者設定的目標 BigQuery 資料集名稱。
  • 資料產品例項 ID：使用者在 Knowledge Catalog 註冊步驟中提供的 ID，用於識別已註冊的資料產品。
  • 執行狀態：部署步驟的成功或失敗狀態 (例如 deployed、post-deploy-success、error、registered 或 updated)。

使用者代理程式標頭結構

遙測參數會使用專屬的 HTTP User-Agent 標頭，動態格式化為下列模式，並插入 Google Cloud API 要求中：

gcp-cortex-eng/framework/<version>/<component>/<tool_type>/<variant>[/<optional_extension>]/<status>

舉例來說，成功部署 SAP ERP 基礎架構時：

gcp-cortex-eng/framework/7.0.0/platform/deployer/sap/cortex/sap/foundations/sap/deployed

資料傳輸

Cortex Framework 採用被動式零酬載中繼資料記錄機制。系統不會將明確的記錄檔酬載傳輸至外部端點，而是使用與 Google Cloud 服務的標準互動記錄遙測事件。

執行部署、同步或示範指令時，架構會與標準 Google Cloud API 通訊，包括 BigQuery 和 Dataform。

這些 API 要求的本文不會傳送遙測資料。而是由 Google Cloud的 API 流量記錄功能原生擷取遙測資料，並剖析自訂 User-Agent 和專案編號標頭，以評估解決方案的採用率和成功率。

停用遙測功能

Cortex Framework 會遵守您的隱私權設定，並實施永久停用政策。您可以使用 cortex-config 工具或在執行期間傳遞 CLI 標記，全域管理遙測資料。

全域停用

如要管理遙測資料，請更新電腦上位於 ~/.cortex/cortex-framework-consent.properties 的永久使用者偏好設定檔案。如果這個檔案包含 enable_telemetry=false，系統會在執行階段完全略過遙測 API 呼叫。

  • 永久停用 (全域停用)：
uv run cortex-config telemetry disable
  • 永久啟用 (全域啟用)：
uv run cortex-config telemetry enable
  • 查看目前狀態：
uv run cortex-config telemetry status

停用單一執行作業

您可以將 --disable-telemetry 標記傳送至執行指令。執行 --disable-telemetry 一次後，架構會在 ~/.cortex/cortex-framework-consent.properties 中自動建立包含 enable_telemetry=false 的持續性設定檔。

## Cortex Framework-deploy
uv run cortex-deploy --config config/config.yaml --disable-telemetry

## Cortex Framework-build-and-deploy
uv run cortex-build-and-deploy --config config/config.yaml --disable-telemetry

## Cortex Framework-demo
uv run cortex-demo --config config/config.yaml --disable-telemetry

## Cortex Framework-kc-sync
uv run cortex-kc-sync --config config/config.yaml --disable-telemetry

如要進一步瞭解這些指令及其參數，請參閱下列 CLI 參考資料：