Telemetria no Cortex Framework

O Cortex Framework coleta estatísticas de uso anônimas durante os processos de implantação e sincronização.

Objetivo da coleta de dados

  • Avaliação da adoção de recursos: o monitoramento da frequência de implantações de módulos de framework e produtos de dados informa as prioridades de desenvolvimento.
  • Identificação de padrões de integração: o rastreamento de variantes de sistemas de origem conectados (por exemplo, SAP ECC, SAP S/4HANA) permite a verificação da compatibilidade e a priorização da manutenção dessas integrações.

A telemetria é ativada por padrão. Para desativá-la, consulte a seção "Desativar a telemetria".

Dados coletados

O framework coleta identificadores de configuração, como IDs de conjunto de dados, IDs de instância de produto de dados e IDs de repositório. Atributos de identidade do usuário, como nomes, e-mails ou endereços IP, não são coletados.

  • Número do projeto na nuvem do Google Cloud: identifica o projeto que executa a implantação, transmitido no cabeçalho X-Goog-User-Project para agregar o uso.
  • Região ou local de implantação: a região em que os recursos de destino estão sendo implantados, usada para rastrear a distribuição geográfica.
  • Versão do framework: a versão da base de código do Cortex Framework em uso (por exemplo, 7.0.0).
  • Nome do componente: o componente de arquitetura de alto nível em que está sendo realizada a ação (por exemplo, platform, data-product, ou foundation).
  • Tipo de ferramenta: o comando ou utilitário específico da CLI executado (por exemplo, deployer ou knowledge-catalog).
  • Variante de destino: o sistema de origem ou a categoria de domínio dos módulos implantados (por exemplo, sap ou marketing).
  • Tipos de módulos ativados: os nomes ou caminhos de diretório de módulos individuais ativados na configuração.
  • ID do repositório do Dataform: o nome configurado pelo usuário do repositório de destino do Dataform.
  • ID do conjunto de dados do BigQuery: o nome do conjunto de dados de destino do BigQuery configurado pelo usuário.
  • ID da instância do produto de dados: o ID fornecido pelo usuário usado durante a etapa de registro do Knowledge Catalog para identificar produtos de dados registrados.
  • Status da execução: o estado de sucesso ou falha da etapa de implantação (por exemplo, deployed, post-deploy-success, error, registered ou updated).

Estrutura do cabeçalho do user agent

Os parâmetros de telemetria são injetados em Google Cloud solicitações de API usando um cabeçalho HTTP User-Agent especializado que é formatado dinamicamente usando o seguinte padrão:

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

Por exemplo, ao implantar as bases do SAP ERP:

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

Transmissão de dados

O Cortex Framework usa um mecanismo de registro de metadados passivo e de carga útil zero. Em vez de transmitir cargas úteis de registro explícitas para endpoints externos, os eventos de telemetria são gravados usando interações padrão com Google Cloud serviços.

Durante a execução de comandos de implantação, sincronização ou demonstração, o framework se comunica com APIs padrão Google Cloud , incluindo BigQuery e Dataform.

Nenhum dado de telemetria é enviado no corpo dessas solicitações de API. Em vez disso, os dados de telemetria são capturados nativamente pelo Google Cloudregistro de tráfego de API do, que analisa os cabeçalhos personalizados do user agent e do número do projeto para medir as taxas de adoção e sucesso da solução.

Desativar a telemetria

O Cortex Framework respeita suas configurações de privacidade e implementa uma política de desativação permanente. É possível gerenciar a telemetria globalmente usando a ferramenta cortex-config ou transmitindo uma flag da CLI durante a execução.

Desativar globalmente

É possível gerenciar a telemetria atualizando um arquivo de preferências do usuário persistente localizado na sua máquina em ~/.cortex/cortex-framework-consent.properties. Se esse arquivo contiver enable_telemetry=false, as chamadas de API de telemetria serão ignoradas completamente durante a execução.

  • Desativar permanentemente (desativar globalmente):
uv run cortex-config telemetry disable
  • Ativar permanentemente (ativar globalmente):
uv run cortex-config telemetry enable
  • Verificar o status atual:
uv run cortex-config telemetry status

Desativar para uma única execução

É possível transmitir a flag --disable-telemetry para comandos de execução. Quando --disable-telemetry é executado uma vez, o framework cria automaticamente o arquivo de configuração persistente em ~/.cortex/cortex-framework-consent.properties contendo 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 mais informações sobre esses comandos e os respectivos parâmetros, consulte as seguintes referências da CLI: