Télémétrie dans Cortex Framework

Cortex Framework collecte des statistiques d'utilisation anonymes lors des processus de déploiement et de synchronisation.

Objectif de la collecte de données

  • Évaluation de l'adoption des fonctionnalités : la surveillance de la fréquence des déploiements de modules de framework et de produits de données permet d'orienter les priorités de développement.
  • Identification des modèles d'intégration : le suivi des variantes de systèmes sources connectés (par exemple, SAP ECC, SAP S/4HANA) permet de vérifier la compatibilité et de hiérarchiser la maintenance de ces intégrations.

La télémétrie est activée par défaut. Pour la désactiver, consultez la section Désactiver la télémétrie.

Données collectées

Le framework collecte des identifiants de configuration, tels que des ID d'ensemble de données, des ID d'instance de produit de données et des ID de dépôt. Les attributs d'identité de l'utilisateur, tels que les noms, les adresses e-mail ou les adresses IP, ne sont pas collectés.

  • Numéro de projet Google Cloud : identifie le projet exécutant le déploiement, transmis dans l'en-tête X-Goog-User-Project pour agréger l'utilisation.
  • Région ou emplacement de déploiement : région dans laquelle les ressources cibles sont déployées, utilisée pour suivre la distribution géographique.
  • Version du framework : version du codebase Cortex Framework en cours d'utilisation (par exemple, 7.0.0).
  • Nom du composant : composant d'architecture de haut niveau sur lequel l'action est effectuée (par exemple, platform, data-product, ou foundation).
  • Type d'outil : commande ou utilitaire CLI spécifique exécuté (par exemple, deployer ou knowledge-catalog)
  • Variante cible : système source ou catégorie de domaine des modules déployés (par exemple, sap ou marketing).
  • Types de modules activés : noms de répertoire ou chemins d'accès des modules individuels activés dans la configuration.
  • ID de dépôt Dataform : nom configuré par l'utilisateur du dépôt Dataform cible.
  • ID d'ensemble de données BigQuery : nom de l'ensemble de données BigQuery cible configuré par l'utilisateur.
  • ID d'instance de produit de données : ID fourni par l'utilisateur lors de l'étape d'enregistrement de Knowledge Catalog pour identifier les produits de données enregistrés.
  • État d'exécution : état de réussite ou d'échec de l'étape de déploiement (par exemple, deployed, post-deploy-success, error, registered, ou updated).

Structure de l'en-tête User-Agent

Les paramètres de télémétrie sont injectés dans Google Cloud les requêtes d’API à l’aide d’un en-tête HTTP User-Agent spécialisé, mis en forme de manière dynamique selon le modèle suivant :

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

Par exemple, lors du déploiement réussi des bases SAP ERP :

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

Transmission de données

Cortex Framework utilise un mécanisme de journalisation des métadonnées passif et sans charge utile. Au lieu de transmettre des charges utiles de journal explicites à des points de terminaison externes, les événements de télémétrie sont enregistrés à l'aide d'interactions standards avec les Google Cloud services.

Lors de l'exécution des commandes de déploiement, de synchronisation ou de démonstration, le framework communique avec des API standards Google Cloud , y compris BigQuery et Dataform.

Aucune donnée de télémétrie n'est envoyée dans le corps de ces requêtes d'API. Au lieu de cela, les données de télémétrie sont capturées de manière native par Google Cloudla journalisation du trafic de l'API de, qui analyse les en-têtes personnalisés User-Agent et de numéro de projet pour mesurer les taux d'adoption et de réussite de la solution.

Désactiver la télémétrie

Cortex Framework respecte vos paramètres de confidentialité et met en œuvre une politique de désactivation permanente. Vous pouvez gérer la télémétrie de manière globale à l'aide de l'outil cortex-config ou en transmettant un indicateur CLI lors de l'exécution.

Désactiver de manière globale

Vous pouvez gérer la télémétrie en mettant à jour un fichier de préférences utilisateur persistant situé sur votre machine à l'adresse ~/.cortex/cortex-framework-consent.properties. Si ce fichier contient enable_telemetry=false, les appels d'API de télémétrie sont complètement ignorés lors de l'exécution.

  • Désactiver définitivement (désactivation globale) :
uv run cortex-config telemetry disable
  • Activer définitivement (activation globale):
uv run cortex-config telemetry enable
  • Vérifier l'état actuel :
uv run cortex-config telemetry status

Désactiver pour une seule exécution

Vous pouvez transmettre l'indicateur --disable-telemetry aux commandes d'exécution. Lorsque --disable-telemetry est exécuté une fois, le framework crée automatiquement le fichier de configuration persistant à l'adresse ~/.cortex/cortex-framework-consent.properties contenant 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

Pour en savoir plus sur ces commandes et leurs paramètres, consultez les références CLI suivantes :