Mengelola setelan pengamatan

Dokumen ini menjelaskan cara mengonfigurasi setelan kemampuan observasi untuk aplikasi Gemini Enterprise atau agen individual menggunakan konsol Google Cloud atau REST API.

Logika pengaktifan bergantung pada jenis agen:

  • Agen Asisten inti: Gunakan tombol tingkat aplikasi (tingkat mesin) dalam konfigurasi.
  • Agen lainnya: (Saat ini terbatas pada agen buatan karyawan di Workflow Builder dan agen Deep Research): Gunakan tombol tingkat agen di dalam setelan masing-masing agen.

Setelah mengaktifkan setelan, Anda dapat melihat data berikut dari interaksi Anda dengan asisten atau agen di aplikasi web Gemini Enterprise:

  • Melihat metrik di Metrics Explorer.
  • Melihat trace dan span di Trace Explorer.

Konsep utama

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

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

Misalnya, trace mewakili seluruh siklus proses permintaan. Hal ini mencakup pengguna yang mengajukan pertanyaan dari asisten Gemini Enterprise, asisten Gemini Enterprise yang merespons, dan tindakan berikutnya yang dipicu oleh jawaban, seperti mengirim email.
Span Span adalah satu unit kerja berjangka waktu dalam trace. Span mewakili operasi tertentu, seperti panggilan fungsi, permintaan API, atau kueri database. Setiap span mencakup detail seperti waktu mulai dan berakhirnya, ID unik, dan hubungannya dengan span lain. Hubungan ini bersama-sama membentuk trace.
Log span Log span adalah pesan atau peristiwa berstempel waktu dan berformat bebas yang terkait dengan span tertentu. Atribut ini memberikan informasi kontekstual yang mendetail tentang eksekusi span, sehingga membantu pengguna men-debug masalah dan memahami alur permintaan.
Metrik Metrik adalah pengukuran numerik yang dikumpulkan sistem dari waktu ke waktu. Pengukuran ini mewakili performa, pemanfaatan 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 penting untuk audit keamanan, kepatuhan, dan memahami cara resource Anda digunakan.
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 observasi bagi aplikasi Gemini Enterprise atau agen individual, Anda dapat menggunakan konsol Google Cloud atau REST API.

Konsol

Untuk mengaktifkan setelan kemampuan observasi 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. Bergantung pada jenis agen yang Anda konfigurasi, lakukan salah satu hal berikut:

    • Agen Core Assistant: Klik Configurations, lalu klik tab Observability.
    • Agen lain (agen buatan karyawan di Workflow Builder dan agen Deep Research): Klik Agen, klik nama agen yang ingin Anda konfigurasi, lalu klik tab Konfigurasi.

  4. Anda dapat mengaktifkan atau menonaktifkan setelan berikut:

    Setelan kemampuan observasi Deskripsi
    Mengaktifkan instrumentasi trace dan log OpenTelemetry Jika diaktifkan, Anda dapat melihat trace, span, log span, 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 Enable instrumentation of OpenTelemetry traces and logs terlebih dahulu.

REST

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

Mengonfigurasi setelan kemampuan observasi untuk Core Assistant (tingkat aplikasi)

Untuk mengonfigurasi setelan visibilitas menggunakan REST API di tingkat aplikasi (yang berlaku untuk agen Core Assistant), lihat bagian berikut:

Mengaktifkan kemampuan observasi saat membuat aplikasi

Untuk membuat aplikasi baru dengan kemampuan observasi 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.

Mengonfigurasi setelan kemampuan observasi untuk setiap agen

Untuk mengaktifkan kemampuan observasi bagi agen tertentu (seperti agen Workflow Builder atau agen Deep Research) menggunakan REST API, jalankan perintah berikut untuk mengupdate observabilityConfig agen:

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/assistants/default_assistant/agents/AGENT_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.
  • AGENT_ID: ID agen yang ingin Anda konfigurasi

Menonaktifkan setelan kemampuan observasi

Untuk menonaktifkan setelan kemampuan observasi untuk aplikasi Gemini Enterprise atau agen individual, gunakan konsol Google Cloud atau REST API.

Konsol

Untuk menonaktifkan setelan kemampuan observasi 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 kemampuan observasinya.

  3. Bergantung pada jenis agen yang Anda konfigurasi, lakukan salah satu hal berikut:

    • Agen Core Assistant: Klik Configurations, lalu klik tab Observability.
    • Agen lain (termasuk agen buatan karyawan Workflow Builder dan agen Deep Research): Klik Agen, klik nama agen yang ingin Anda konfigurasi, lalu klik tab Konfigurasi.

  4. Anda dapat menonaktifkan setelan berikut:

    Setelan kemampuan observasi Deskripsi
    Mengaktifkan instrumentasi trace dan log OpenTelemetry Jika dinonaktifkan, setelan ini akan menghentikan pengumpulan trace, span, log span, dan metrik. Tindakan ini juga akan menonaktifkan setelan Enable logging of prompt inputs and response outputs, yang berarti tidak ada log yang dikirim ke Cloud Logging.
    Mengaktifkan logging input perintah dan output respons Jika dinonaktifkan, Cloud Logging tidak akan mencatat input perintah dan output respons.

REST

Untuk menonaktifkan setelan kemampuan observasi menggunakan REST API, lihat bagian berikut:

Menonaktifkan kemampuan observasi di tingkat aplikasi (Core Assistant)

Untuk menonaktifkan kemampuan observasi di tingkat aplikasi, 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.

Menonaktifkan kemampuan observasi untuk setiap agen

Untuk menonaktifkan kemampuan observasi untuk setiap agen (seperti agen Workflow Builder atau agen Deep Research), 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/assistants/default_assistant/agents/AGENT_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.
  • AGENT_ID: ID agen yang ingin Anda konfigurasi

Langkah berikutnya