Cortex Framework 中的遥测

Cortex Framework 会在部署和同步过程中收集匿名使用情况统计信息。

数据收集目的

  • 评估功能采用情况：监控框架模块和数据产品部署的频率，以便确定开发优先级。
  • 识别集成模式：跟踪连接的源系统变体（例如 SAP ECC、SAP S/4HANA），以便验证兼容性并确定这些集成的维护优先级。

遥测功能默认处于启用状态 。如需停用此功能，请参阅“停用遥测”部分。

已收集数据

该框架会收集配置标识符，例如数据集 ID、数据产品实例 ID 和仓库 ID。系统不会收集用户身份属性，例如姓名、电子邮件地址或 IP 地址。

  • Google Cloud 项目编号：标识运行部署的项目，在 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）。

User-Agent 标头结构

遥测参数使用专用 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 参考文档：