Telemetría en Cortex Framework

Cortex Framework recopila estadísticas de uso anónimas durante los procesos de implementación y sincronización.

Propósito de la recopilación de datos

  • Evaluación de la adopción de funciones: Supervisar la frecuencia de las implementaciones de módulos de framework y productos de datos informa las prioridades de desarrollo.
  • Identificación de patrones de integración: El seguimiento de las variantes del sistema de origen conectado (p.ej., SAP ECC, SAP S/4HANA) permite verificar la compatibilidad y priorizar el mantenimiento de estas integraciones.

La telemetría está habilitada de forma predeterminada. Para inhabilitarla, consulta la sección "Inhabilitar la telemetría".

Datos recopilados

El framework recopila identificadores de configuración, como IDs de conjuntos de datos, IDs de instancias de productos de datos y IDs de repositorios. No se recopilan atributos de identidad del usuario, como nombres, correos electrónicos o direcciones IP.

  • Número de proyecto de Google Cloud: Identifica el proyecto que ejecuta la implementación, que se transmite en el encabezado X-Goog-User-Project para agregar el uso.
  • Región o ubicación de la implementación: Es la región en la que se implementan los recursos de destino, que se usa para hacer un seguimiento de la distribución geográfica.
  • Versión del framework: Es la versión de la base de código de Cortex Framework en uso (por ejemplo, 7.0.0).
  • Nombre del componente: Es el componente de arquitectura de alto nivel sobre el que se actúa (por ejemplo, platform, data-product, o foundation).
  • Tipo de herramienta: Es el comando o la utilidad específica de la CLI que se ejecuta (por ejemplo, deployer o knowledge-catalog).
  • Variante de destino: Es el sistema de origen o la categoría de dominio de los módulos implementados (p.ej., sap o marketing).
  • Tipos de módulos habilitados: Son los nombres de directorios o las rutas de los módulos individuales habilitados en la configuración.
  • ID del repositorio de Dataform: Es el nombre configurado por el usuario del repositorio de Dataform de destino.
  • ID del conjunto de datos de BigQuery: Es el nombre del conjunto de datos de BigQuery de destino configurado por el usuario.
  • ID de instancia del producto de datos: Es el ID proporcionado por el usuario que se usa durante el paso de registro de Knowledge Catalog para identificar los productos de datos registrados.
  • Estado de ejecución: Es el estado de éxito o falla del paso de implementación (por ejemplo, deployed, post-deploy-success, error, registered o updated).

Estructura del encabezado User-Agent

Los parámetros de telemetría se insertan en Google Cloud las solicitudes de la API mediante un encabezado User-Agent HTTP especializado que se formatea de forma dinámica con el siguiente patrón:

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

Por ejemplo, cuando se implementan correctamente las bases de SAP ERP:

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

Transmisión de datos

Cortex Framework utiliza un mecanismo de registro de metadatos pasivo y de carga útil cero. En lugar de transmitir cargas útiles de registro explícitas a extremos externos, los eventos de telemetría se registran mediante interacciones estándar con los Google Cloud servicios.

Durante la ejecución de los comandos de implementación, sincronización o demostración, el framework se comunica con las APIs estándar Google Cloud , incluidas BigQuery y Dataform.

No se envían datos de telemetría en el cuerpo de estas solicitudes a la API. En cambio, los datos de telemetría se capturan de forma nativa mediante Google Cloudel registro de tráfico de la API de, que analiza los encabezados personalizados User-Agent y número de proyecto para medir las tasas de adopción y éxito de la solución.

Inhabilitar la telemetría

Cortex Framework respeta tu configuración de privacidad y aplica una política de exclusión persistente. Puedes administrar la telemetría de forma global con la herramienta cortex-config o pasando una marca de la CLI durante la ejecución.

Inhabilitar de forma global

Puedes administrar la telemetría actualizando un archivo de preferencias de usuario persistente ubicado en tu máquina en ~/.cortex/cortex-framework-consent.properties. Si este archivo contiene enable_telemetry=false, las llamadas a la API de telemetría se omiten por completo en el tiempo de ejecución.

  • Excluir de forma permanente (inhabilitar de forma global):
uv run cortex-config telemetry disable
  • Habilitar de forma permanente (habilitar de forma global):
uv run cortex-config telemetry enable
  • Verificar el estado actual:
uv run cortex-config telemetry status

Inhabilitar para una sola ejecución

Puedes pasar la marca --disable-telemetry a los comandos de ejecución. Cuando se ejecuta --disable-telemetry una vez, el framework crea automáticamente el archivo de configuración persistente en ~/.cortex/cortex-framework-consent.properties que contiene 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

Para obtener más información sobre estos comandos y sus parámetros, consulta las siguientes referencias de la CLI: