Telemetri di Cortex Framework

Cortex Framework mengumpulkan statistik penggunaan anonim selama proses deployment dan sinkronisasi.

Tujuan pengumpulan data

  • Evaluasi adopsi fitur: Memantau frekuensi deployment modul framework dan produk data akan menginformasikan prioritas pengembangan.
  • Identifikasi pola integrasi: Pelacakan varian sistem sumber yang terhubung (misalnya, SAP ECC, SAP S/4HANA) memungkinkan verifikasi kompatibilitas dan prioritas pemeliharaan untuk integrasi ini.

Telemetri diaktifkan secara default. Untuk menonaktifkannya, lihat bagian "Menonaktifkan telemetri".

Data yang dikumpulkan

Framework mengumpulkan ID konfigurasi, seperti ID set data, ID instance produk data, dan ID repositori. Atribut identitas pengguna, seperti nama, email, atau alamat IP, tidak dikumpulkan.

  • Nomor project Google Cloud: Mengidentifikasi project yang menjalankan deployment, yang dikirimkan di header X-Goog-User-Project untuk menggabungkan penggunaan.
  • Region atau lokasi deployment: Region tempat resource target di-deploy, digunakan untuk melacak distribusi geografis.
  • Versi framework: Versi codebase Cortex Framework yang digunakan (misalnya, 7.0.0).
  • Nama komponen: Komponen arsitektur tingkat tinggi yang sedang ditindaklanjuti (misalnya, platform, data-product, atau foundation).
  • Jenis alat: Perintah atau utilitas CLI tertentu yang dijalankan (misalnya, deployer, atau knowledge-catalog)
  • Varian target: Kategori sistem atau domain sumber dari modul yang di-deploy (misalnya, sap, atau marketing).
  • Jenis modul yang diaktifkan: Nama atau jalur direktori dari setiap modul yang diaktifkan dalam konfigurasi.
  • ID repositori Dataform: Nama repositori Dataform target yang dikonfigurasi pengguna.
  • ID set data BigQuery: Nama set data BigQuery target yang dikonfigurasi pengguna.
  • ID instance produk data: ID yang disediakan pengguna yang digunakan selama langkah pendaftaran Knowledge Catalog untuk mengidentifikasi produk data terdaftar.
  • Status eksekusi: Status berhasil atau gagal dari langkah deployment (misalnya, deployed, post-deploy-success, error, registered, atau updated).

Struktur header Agen Pengguna

Parameter telemetri disisipkan ke dalam permintaan Google Cloud API menggunakan header Agen Pengguna HTTP khusus yang diformat secara dinamis menggunakan pola berikut:

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

Misalnya, saat berhasil men-deploy fondasi SAP ERP:

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

Transmisi data

Cortex Framework menggunakan mekanisme pencatatan metadata pasif tanpa payload. Daripada mengirimkan payload log eksplisit ke endpoint eksternal, peristiwa telemetri dicatat menggunakan interaksi standar dengan Google Cloud layanan.

Selama eksekusi perintah deploy, sync, atau demo, framework berkomunikasi dengan API Google Cloud standar, termasuk BigQuery dan Dataform.

Tidak ada data telemetri yang dikirim dalam isi permintaan API ini. Sebagai gantinya, data telemetri diambil secara native oleh pencatatan traffic API Google Cloud, yang mengurai header User-Agent kustom dan nomor project untuk mengukur tingkat keberhasilan dan adopsi solusi.

Menonaktifkan telemetri

Cortex Framework menghormati setelan privasi Anda dan menerapkan kebijakan penolakan yang persisten. Anda dapat mengelola telemetri secara global menggunakan alat cortex-config atau dengan meneruskan tanda CLI selama eksekusi.

Nonaktifkan secara global

Anda dapat mengelola telemetri dengan memperbarui file preferensi pengguna persisten yang ada di komputer Anda di ~/.cortex/cortex-framework-consent.properties. Jika file ini berisi enable_telemetry=false, panggilan API telemetri akan sepenuhnya dilewati saat runtime.

  • Memilih tidak ikut secara permanen (menonaktifkan secara global):
uv run cortex-config telemetry disable
  • Ikut serta secara permanen (aktifkan secara global):
uv run cortex-config telemetry enable
  • Periksa status saat ini:
uv run cortex-config telemetry status

Nonaktifkan untuk satu eksekusi

Anda dapat meneruskan tanda --disable-telemetry ke perintah eksekusi. Saat --disable-telemetry dieksekusi satu kali, framework akan otomatis membuat file konfigurasi persisten di ~/.cortex/cortex-framework-consent.properties yang berisi 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

Untuk mengetahui informasi selengkapnya tentang perintah ini dan parameternya, lihat referensi CLI berikut: