Mengelola setelan kemampuan pengamatan

Dokumen ini menjelaskan cara mengonfigurasi setelan kemampuan pengamatan untuk aplikasi Gemini Enterprise Anda menggunakan konsol Google Cloud . Setelah mengaktifkan setelan, Anda dapat melihat data berikut dari interaksi Anda dengan asisten di aplikasi web Gemini Enterprise:

  • Melihat metrik di Metrics Explorer.
  • Lihat rekaman aktivitas dan rentang di Trace Explorer.

Konsep utama

Bagian ini memperkenalkan konsep utama terkait kemampuan observasi di Gemini Enterprise.

Konsep Deskripsi
Trace Trace adalah kumpulan rentang yang merepresentasikan satu permintaan atau transaksi saat mengalir melalui berbagai layanan dan komponen.

Misalnya, rekaman aktivitas mewakili seluruh siklus proses permintaan. Hal ini mencakup pengguna yang mengajukan pertanyaan dari asisten Gemini Enterprise, asisten Gemini Enterprise yang memberikan respons, dan tindakan berikutnya yang dipicu oleh jawaban, seperti mengirim email.
Span Rentang adalah satu unit kerja berwaktu dalam rekaman aktivitas. Objek ini merepresentasikan operasi tertentu, seperti panggilan fungsi, permintaan API, atau kueri database. Setiap rentang mencakup detail seperti waktu mulai dan berakhirnya, ID unik, dan hubungannya dengan rentang lain. Hubungan ini bersama-sama membentuk rekaman aktivitas.
Log rentang Log rentang adalah pesan atau peristiwa bentuk bebas yang diberi stempel waktu dan terkait dengan rentang tertentu. URL ini memberikan informasi kontekstual yang mendetail tentang eksekusi rentang, membantu pengguna men-debug masalah dan memahami alur permintaan.
Metrik Metrik adalah pengukuran numerik yang dikumpulkan sistem dari waktu ke waktu. Pengukuran ini menunjukkan performa, penggunaan resource, atau perilaku sistem. Engineer menggunakan metrik untuk memantau kondisi sistem, mengidentifikasi tren, dan memicu pemberitahuan.
Log audit penggunaan Log audit penggunaan adalah catatan aktivitas administratif dan akses dalam resource Google Cloud Anda. Log ini memberikan informasi mendetail tentang siapa yang melakukan tindakan apa, kapan, dan dari mana. Log ini sangat penting untuk audit keamanan, kepatuhan, dan pemahaman tentang cara penggunaan resource Anda.
Log error konektor Gemini Enterprise Log error konektor Gemini Enterprise mencatat error dan kegagalan yang terjadi saat mengintegrasikan Gemini Enterprise dengan sumber data pihak ketiga seperti Jira dan Microsoft OneDrive. Log ini mencakup masalah koneksi, masalah transformasi data, dan error API.

Sebelum memulai

Pastikan Anda memiliki:

Mengaktifkan setelan kemampuan observasi

Untuk mengaktifkan kemampuan pengamatan aplikasi Gemini Enterprise, Anda dapat menggunakan konsolGoogle Cloud atau REST API.

Konsol

Untuk mengaktifkan setelan kemampuan pengamatan menggunakan konsol Google Cloud , ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud , buka halaman Gemini Enterprise.

    Gemini Enterprise

  2. Klik nama aplikasi yang ingin Anda konfigurasi.

  3. Klik Configurations, lalu klik tab Observability.

  4. Anda dapat mengaktifkan atau menonaktifkan setelan berikut:

    Setelan kemampuan observasi Deskripsi
    Mengaktifkan instrumentasi trace dan log OpenTelemetry Jika diaktifkan, Anda dapat melihat rekaman aktivitas, rentang, log rentang, dan metrik yang terkait dengan log Anda di Cloud Logging.
    Mengaktifkan logging input perintah dan output respons Jika diaktifkan, Cloud Logging akan mencatat konten lengkap perintah dan respons pengguna. Hal ini mencakup data sensitif atau Informasi Identitas Pribadi (PII). Untuk mengaktifkan setelan ini, Anda harus mengaktifkan Aktifkan instrumentasi log dan rekaman aktivitas OpenTelemetry terlebih dahulu.

REST

Untuk mengonfigurasi setelan kemampuan pengamatan menggunakan REST API, lihat bagian berikut:

Mengaktifkan kemampuan observasi saat membuat aplikasi

Untuk membuat aplikasi baru dengan kemampuan pengamatan diaktifkan, jalankan perintah berikut:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "name": "projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID",
  "displayName": "APP_DISPLAY_NAME",
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "searchEngineConfig": {
    "searchTier": "SEARCH_TIER_ENTERPRISE",
    "searchAddOns": ["SEARCH_ADD_ON_LLM"],
    "requiredSubscriptionTier": "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"
  },
  "industryVertical": "GENERIC",
  "appType": "APP_TYPE_INTRANET",
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

Ganti kode berikut:

  • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
    • us untuk multi-region AS
    • eu untuk multi-region Uni Eropa
    • global untuk lokasi Global
    Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
  • PROJECT_ID: ID project Anda.
  • LOCATION: multi-region penyimpanan data Anda: global, us, atau eu
  • APP_ID: ID aplikasi yang ingin Anda buat.
  • APP_DISPLAY_NAME: nama tampilan aplikasi yang ingin Anda buat.

Mengaktifkan kemampuan observasi untuk aplikasi yang sudah ada

Untuk mengaktifkan kemampuan observasi pada aplikasi yang ada, jalankan perintah berikut:

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

Ganti kode berikut:

  • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
    • us untuk multi-region AS
    • eu untuk multi-region Uni Eropa
    • global untuk lokasi Global
    Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
  • PROJECT_ID: ID project Anda.
  • LOCATION: multi-region penyimpanan data Anda: global, us, atau eu
  • APP_ID: ID aplikasi.

Menonaktifkan setelan kemampuan observasi

Untuk menonaktifkan setelan kemampuan observasi aplikasi Gemini Enterprise, Anda dapat menggunakan konsol Google Cloud atau REST API.

Konsol

Untuk menonaktifkan setelan kemampuan pengamatan menggunakan konsol Google Cloud , ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud , buka halaman Gemini Enterprise.

    Gemini Enterprise

  2. Klik nama aplikasi yang ingin Anda nonaktifkan setelan observabilitasnya.

  3. Klik Configurations, lalu klik tab Observability.

  4. Anda dapat menonaktifkan setelan berikut:

    Setelan kemampuan observasi Deskripsi
    Mengaktifkan instrumentasi trace dan log OpenTelemetry Jika dinonaktifkan, setelan ini akan menghentikan pengumpulan rekaman aktivitas, rentang, log rentang, dan metrik. Tindakan ini juga menonaktifkan setelan Aktifkan logging input perintah dan output respons, yang berarti tidak ada log yang dikirim ke Cloud Logging.
    Mengaktifkan logging input perintah dan output respons Jika dinonaktifkan, Cloud Logging tidak mencatat input perintah dan output respons.

REST

Untuk menonaktifkan setelan kemampuan pengamatan menggunakan REST API, jalankan perintah berikut:

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": false,
    "sensitiveLoggingEnabled": false
  }
}'

Ganti kode berikut:

  • ENDPOINT_LOCATION: multi-region untuk permintaan API Anda. Tentukan salah satu nilai berikut:
    • us untuk multi-region AS
    • eu untuk multi-region Uni Eropa
    • global untuk lokasi Global
    Untuk mengetahui informasi selengkapnya, lihat Menentukan multi-region untuk penyimpanan data Anda.
  • PROJECT_ID: ID project Anda.
  • LOCATION: multi-region penyimpanan data Anda: global, us, atau eu
  • APP_ID: ID aplikasi.

Langkah berikutnya