Telemetrie in Cortex Framework

Cortex Framework erfasst während der Bereitstellung und Synchronisierung anonyme Nutzungsstatistiken.

Zweck der Datenerhebung

  • Bewertung der Feature-Nutzung: Die Häufigkeit der Bereitstellungen von Framework-Modulen und Datenprodukten gibt Aufschluss über die Entwicklungsprioritäten.
  • Identifizierung von Integrationsmustern: Durch das Tracking verbundener Quellsystemvarianten (z.B. SAP ECC, SAP S/4HANA) kann die Kompatibilität überprüft und die Wartung für diese Integrationen priorisiert werden.

Die Telemetrie ist standardmäßig aktiviert. Informationen zum Deaktivieren finden Sie im Abschnitt Telemetrie deaktivieren.

Erfasste Daten

Das Framework erfasst Konfigurations-IDs wie Dataset-IDs, Instanz-IDs für Datenprodukte und Repository-IDs. Attribute zur Nutzeridentität wie Namen, E-Mails oder IP-Adressen werden nicht erfasst.

  • Google Cloud-Projektnummer: Identifiziert das Projekt, in dem die Bereitstellung ausgeführt wird. Sie wird im X-Goog-User-Project Header übertragen, um die Nutzung zu aggregieren.
  • Bereitstellungsregion oder ‑standort: Die Region, in der Zielressourcen bereitgestellt werden. Wird verwendet, um die geografische Verteilung zu verfolgen.
  • Framework-Version: Die Version der Cortex Framework-Codebasis, die verwendet wird (z. B. 7.0.0).
  • Komponentenname: Die Architekturkomponente auf hoher Ebene, auf die sich die Aktion bezieht (z. B. platform, data-product, oder foundation).
  • Tooltyp: Der spezifische CLI-Befehl oder das Dienstprogramm, das ausgeführt wird (z. B. deployer oder knowledge-catalog).
  • Zielvariante: Das Quellsystem oder die Domainkategorie der bereitgestellten Module (z.B. sap oder marketing).
  • Aktivierte Modultypen: Die Verzeichnisnamen oder Pfade der einzelnen Module, die in der Konfiguration aktiviert sind.
  • Dataform-Repository-ID: Der vom Nutzer konfigurierte Name des Dataform-Ziel-Repositorys.
  • BigQuery-Dataset-ID: Der vom Nutzer konfigurierte Name des BigQuery-Ziel-Datasets.
  • Instanz-ID des Datenprodukts: Die vom Nutzer angegebene ID, die im Schritt der Knowledge Catalog-Registrierung verwendet wird, um registrierte Datenprodukte zu identifizieren.
  • Ausführungsstatus: Der Status des Bereitstellungsschritts (z. B. deployed, post-deploy-success, error, registered, oder updated).

Struktur des User-Agent-Headers

Telemetrieparameter werden mithilfe eines speziellen HTTP-User-Agent-Headers in Google Cloud API-Anfragen eingefügt, der dynamisch nach dem folgenden Muster formatiert wird:

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

Beispiel für die erfolgreiche Bereitstellung von SAP ERP-Foundations:

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

Datenübertragung

Cortex Framework verwendet einen passiven Metadatenprotokollierungsmechanismus ohne Nutzlast. Anstatt explizite Protokollnutzlasten an externe Endpunkte zu übertragen, werden Telemetrieereignisse mithilfe von Standardinteraktionen mit Google Cloud Diensten aufgezeichnet.

Bei der Ausführung von Bereitstellungs-, Synchronisierungs- oder Demobefehlen kommuniziert das Framework mit Standard Google Cloud APIs, darunter BigQuery und Dataform.

Im Textkörper dieser API-Anfragen werden keine Telemetriedaten gesendet. Stattdessen werden Telemetriedaten nativ durch Google Clouddie API-Traffic-Protokollierung von erfasst, die die benutzerdefinierten User-Agent- und Projektnummern-Header parst, um die Akzeptanz- und Erfolgsraten der Lösung zu messen.

Telemetrie deaktivieren

Cortex Framework berücksichtigt Ihre Datenschutzeinstellungen und implementiert eine dauerhafte Deaktivierungsrichtlinie. Sie können die Telemetrie global mit dem Tool cortex-config verwalten oder ein CLI-Flag während der Ausführung übergeben.

Global deaktivieren

Sie können die Telemetrie verwalten, indem Sie eine dauerhafte Nutzerpräferenzdatei auf Ihrem Computer unter ~/.cortex/cortex-framework-consent.properties aktualisieren. Wenn diese Datei enable_telemetry=false enthält, werden Telemetrie-API-Aufrufe zur Laufzeit vollständig übersprungen.

  • Dauerhaft deaktivieren (global deaktivieren):
uv run cortex-config telemetry disable
  • Dauerhaft aktivieren (global aktivieren):
uv run cortex-config telemetry enable
  • Aktuellen Status prüfen:
uv run cortex-config telemetry status

Für eine einzelne Ausführung deaktivieren

Sie können das Flag --disable-telemetry an Ausführungsbefehle übergeben. Wenn --disable-telemetry einmal ausgeführt wird, erstellt das Framework automatisch die dauerhafte Konfigurationsdatei unter ~/.cortex/cortex-framework-consent.properties mit 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

Weitere Informationen zu diesen Befehlen und ihren Parametern finden Sie in den folgenden CLI-Referenzen: