Menginstrumentasi aplikasi ADK dengan OpenTelemetry

Dokumen ini menjelaskan cara menginstrumentasi agen AI yang dibuat dengan the Agent Development Kit (ADK) framework. Framework ADK mencakup instrumentasi OpenTelemetry yang mengumpulkan telemetri dari tindakan utama agen. Saat Anda mengaktifkan instrumentasi bawaan, instrumentasi tersebut akan mengirimkan informasi seperti perintah teks dan respons agen ke project Anda Google Cloud . Dokumen ini menguraikan perubahan yang diperlukan dan menyediakan link ke aplikasi contoh.

Aplikasi yang menggunakan ADK juga dapat mengumpulkan perintah dan respons multimodal. Dokumen ini menjelaskan cara mengumpulkan perintah dan respons teks. Jika Anda ingin mengumpulkan data multimodal, konfigurasi tambahan diperlukan. Untuk mengetahui informasi selengkapnya, lihat Mengumpulkan dan melihat perintah dan respons multimodal.

Observabilitas default yang disediakan oleh ADK mungkin tidak cukup untuk kasus penggunaan aplikasi Anda. Anda dapat menambahkan library instrumentasi tambahan menggunakan OpenTelemetry untuk mengambil telemetri dari bagian lain aplikasi Anda, atau instrumentasi kustom Anda sendiri untuk mengambil data khusus aplikasi guna mendapatkan observabilitas yang lebih mendetail. Misalnya, di aplikasi Anda, Anda dapat menulis kode instrumentasi untuk:

• Melacak konsumsi resource alat yang dipanggil agen.
• Melacak kegagalan validasi khusus aplikasi, pelanggaran aturan bisnis, atau mekanisme pemulihan error kustom.
• Melacak skor kualitas untuk respons agen berdasarkan kriteria khusus domain Anda.

Catatan: Dokumen ini mengasumsikan bahwa Anda menggunakan framework ADK dengan versi 1.17.0 atau yang lebih baru.

Menginstrumentasi aplikasi AI generatif untuk mengumpulkan telemetri

Untuk menginstrumentasi agen AI Anda guna mengumpulkan data log, metrik, dan rekaman aktivitas, lakukan hal berikut:

1. Instal paket OpenTelemetry.
2. Konfigurasi lingkungan ADK Anda.

Bagian ini menjelaskan langkah-langkah sebelumnya.

Menginstal paket OpenTelemetry

Tambahkan paket instrumentasi dan eksportir OpenTelemetry berikut:

uv add 'google-adk>=1.17.0' \
  'opentelemetry-instrumentation-google-genai>=0.4b0' \
  'opentelemetry-instrumentation-sqlite3' \
  'opentelemetry-exporter-gcp-logging' \
  'opentelemetry-exporter-otlp-proto-grpc' \
  'opentelemetry-instrumentation-vertexai>=2.0b0'

Data log dikirim ke Google Cloud project Anda menggunakan Cloud Logging API atau Cloud Monitoring API. Library opentelemetry-exporter-gcp-logging memanggil endpoint di Cloud Logging API.

Data metrik tidak dikumpulkan. Biasanya, aplikasi yang tidak menggunakan solusi berbasis pengumpul menyertakan library opentelemetry-exporter-gcp-monitoring. Library ini memanggil endpoint di Cloud Monitoring API.

Data rekaman aktivitas dikirim ke Google Cloud dengan menggunakan Telemetry (OTLP) API, yang mengimplementasikan OpenTelemetry Line Protocol. Library opentelemetry-exporter-otlp-proto-grpc memanggil endpoint API Telemetry (OTLP).

Data rekaman aktivitas Anda disimpan dalam format yang umumnya konsisten dengan file proto yang ditentukan oleh OpenTelemetry Line Protocol. Namun, kolom mungkin dikonversi dari jenis data khusus OpenTelemetry ke jenis data JSON sebelum penyimpanan. Untuk mempelajari format penyimpanan lebih lanjut, lihat Skema untuk data rekaman aktivitas.

Mengonfigurasi lingkungan ADK Anda

Framework ADK versi 1.17.0 dan yang lebih baru menyertakan dukungan bawaan untuk OpenTelemetry dan mengirim data telemetri OpenTelemetry ke Google Cloud Observability. Untuk mengaktifkan fitur ini, konfigurasi lingkungan ADK Anda:

• Jika Anda menjalankan aplikasi dengan perintah adk web, sertakan flag --otel_to_cloud.

• Dalam file opentelemetry.env, tetapkan variabel lingkungan berikut:

  OTEL_SERVICE_NAME='adk-sql-agent'
  OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED='true'
  

• Konfigurasi OpenTelemetry untuk menggunakan konvensi semantik terbaru untuk AI generatif.

  OTEL_SEMCONV_STABILITY_OPT_IN='gen_ai_latest_experimental'
  

• Konfigurasi OpenTelemetry untuk melampirkan pesan sebagai peristiwa.

  OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT='EVENT_ONLY'
  

  Catatan: Jangan menetapkan nilai variabel ini ke true. Jika Anda menggunakan konvensi semantik terbaru, menetapkan nilai variabel ini ke true akan menghasilkan konfigurasi yang tidak valid. Oleh karena itu, data log dan rekaman aktivitas tidak dikumpulkan.

  Untuk mengetahui informasi selengkapnya tentang nilai yang diizinkan, lihat genai/types.py.

• Sebaiknya tambahkan juga variabel lingkungan berikut ke file opentelemetry.env:

  ADK_CAPTURE_MESSAGE_CONTENT_IN_SPANS='false'
  

  Variabel lingkungan ini melakukan hal berikut:

  • Mencegah instrumentasi ADK melampirkan atribut rentang yang melebihi batas ukuran atribut.
  • Mencegah informasi identitas pribadi (PII) dilampirkan ke rentang sebagai atribut.

• Anda mungkin perlu menetapkan variabel lingkungan lainnya. Misalnya, jika Anda men-deploy ke Gemini Enterprise Agent Platform, Anda juga ingin menetapkan variabel lingkungan berikut:

  GOOGLE_CLOUD_AGENT_ENGINE_ENABLE_TELEMETRY='true'
  

Mendownload dan menjalankan aplikasi contoh

Kode contoh ini mengimplementasikan agen AI generatif yang dibuat menggunakan ADK. Agen diinstrumentasi dengan OpenTelemetry, yang dikonfigurasi untuk mengirim metrik, rekaman aktivitas, dan log ke project Anda. Google Cloud Telemetri yang dikirim ke project Anda mencakup perintah dan respons AI generatif.

Persona agen ADK

Agen AI generatif ditentukan sebagai pakar SQL yang memiliki akses penuh ke database SQLite sementara. Agen ini dibuat dengan Agent Development Kit dan mengakses database menggunakan SQLDatabaseToolkit. Database awalnya kosong.

Sebelum memulai

Login ke akun Anda. Google Cloud Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

Buat atau pilih Google Cloud project.

Peran yang diperlukan untuk memilih atau membuat project

• Memilih project: Memilih project tidak memerlukan peran IAM tertentu Anda dapat memilih project mana pun yang telah diberi peran.
• Membuat project: Untuk membuat project, Anda memerlukan peran Project Creator (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.

Catatan: Jika Anda tidak berencana menyimpan resource yang dibuat dalam prosedur ini, buat project, bukan memilih project yang ada. Setelah menyelesaikan langkah-langkah ini, Anda dapat menghapus project, sehingga menghapus semua resource yang terkait dengan project tersebut.

• Buat Google Cloud project:

  gcloud projects create PROJECT_ID

  Ganti PROJECT_ID dengan nama untuk Google Cloud project yang Anda buat.

• Pilih Google Cloud project yang Anda buat:

  gcloud config set project PROJECT_ID

  Ganti PROJECT_ID dengan nama Google Cloud project Anda.

Pastikan penagihan diaktifkan untuk Google Cloud project Anda.

Aktifkan Vertex AI, Penggunaan Layanan, Telemetri, Cloud Logging, Cloud Monitoring, dan Cloud Trace API:

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan peran IAM Admin Service Usage (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.

gcloud services enable aiplatform.googleapis.com serviceusage.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

Buat atau pilih Google Cloud project.

Peran yang diperlukan untuk memilih atau membuat project

• Memilih project: Memilih project tidak memerlukan peran IAM tertentu Anda dapat memilih project mana pun yang telah diberi peran.
• Membuat project: Untuk membuat project, Anda memerlukan peran Project Creator (roles/resourcemanager.projectCreator), yang berisi izin resourcemanager.projects.create. Pelajari cara memberikan peran.

Catatan: Jika Anda tidak berencana menyimpan resource yang dibuat dalam prosedur ini, buat project, bukan memilih project yang ada. Setelah menyelesaikan langkah-langkah ini, Anda dapat menghapus project, sehingga menghapus semua resource yang terkait dengan project tersebut.

• Buat Google Cloud project:

  gcloud projects create PROJECT_ID

  Ganti PROJECT_ID dengan nama untuk Google Cloud project yang Anda buat.

• Pilih Google Cloud project yang Anda buat:

  gcloud config set project PROJECT_ID

  Ganti PROJECT_ID dengan nama Google Cloud project Anda.

Pastikan penagihan diaktifkan untuk Google Cloud project Anda.

Aktifkan Vertex AI, Penggunaan Layanan, Telemetri, Cloud Logging, Cloud Monitoring, dan Cloud Trace API:

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan peran IAM Admin Service Usage (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.

gcloud services enable aiplatform.googleapis.com serviceusage.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com

1. Untuk mendapatkan izin yang Anda perlukan agar aplikasi contoh dapat menulis data log, metrik, dan rekaman aktivitas, minta administrator Anda untuk memberi Anda peran IAM berikut di project Anda:

   • Cloud Telemetry Traces Writer (roles/telemetry.tracesWriter)
   • Logs Writer (roles/logging.logWriter)
   • Monitoring Metric Writer (roles/monitoring.metricWriter)
   • Vertex AI User (roles/aiplatform.user)

   Izin ini cukup jika Anda menjalankan contoh di Cloud Shell, di Google Cloud resource, atau di lingkungan pengembangan lokal.

   Penting: Aplikasi produksi biasanya mengandalkan akun layanan untuk memberikan kredensial yang diperlukan untuk menulis data log, metrik, dan rekaman aktivitas. Dalam skenario tersebut, berikan peran sebelumnya ke akun layanan.

2. Pastikan Anda menentukan project kuota. Vertex AI API (aiplatform.googleapis.com) mengharuskan project kuota ditentukan. Untuk mengetahui informasi selengkapnya, lihat Menetapkan project kuota. Misalnya, perintah berikut dapat menetapkan project kuota.

   gcloud config set billing/quota_project PROJECT_ID

Meluncurkan aplikasi

Untuk meluncurkan aplikasi contoh, lakukan hal berikut:

1. Di Cloud Shell, clone repositori:

   git clone https://github.com/GoogleCloudPlatform/opentelemetry-samples.git
   

2. Buka direktori contoh:

   cd opentelemetry-samples/python/adk-sql-agent
   

   Contoh ini berisi file .env yang menetapkan dua variabel lingkungan. Satu variabel mengontrol endpoint yang digunakan SDK. Variabel lainnya menetapkan lokasi.

   Jika Anda lebih suka menggunakan model lain, edit main.py. Pastikan model yang Anda pilih mendukung lokasi yang ditentukan dalam file .env. Untuk mengetahui informasi tentang model, lihat Model Google.

3. Buat lingkungan virtual dan jalankan contoh:

   uv run --env-file opentelemetry.env adk web --otel_to_cloud
   

   Aplikasi akan menampilkan pesan yang mirip dengan berikut ini:

   Appplication startup complete
   Uvicorn running on http://127.0.0.1:8080
   

4. Untuk berinteraksi dengan agen, pilih URL yang ditampilkan dalam output langkah sebelumnya.

5. Luaskan Select an app , lalu pilih sql_agent dari daftar agen.

   Catatan: Aplikasi ini memerlukan Cross-Origin Resource Sharing (CORS). Jika Anda memasukkan perintah dan CORS diblokir, aplikasi akan menampilkan pesan Failed to create session dan command line akan menunjukkan bahwa perintah ditolak, POST /apps/sql_agent/users/user/sessions HTTP/1.1" 403 Forbidden.
   Anda dapat mengaktifkan CORS dengan menambahkan hal berikut ke perintah yang menjalankan contoh:
   

   --allow_origins="regex:.*"

Berinteraksi dengan agen

Untuk berinteraksi dengan agen, ajukan pertanyaan atau berikan perintah. Misalnya, Anda dapat mengajukan pertanyaan:

What can you do for me ?

Demikian pula, karena sql_agent memiliki persona pakar SQL, Anda dapat memintanya untuk membuat tabel bagi aplikasi Anda dan menulis kueri untuk mengoperasikan tabel yang dibuat. Agen hanya dapat membuat database sementara yang didukung oleh file .db yang dibuat di mesin yang menjalankan aplikasi.

Berikut ini menggambarkan interaksi contoh antara sql_agent dan pengguna:

Tindakan yang dilakukan oleh agen AI generatif tidak deterministik, sehingga Anda mungkin melihat respons yang berbeda untuk perintah yang sama.

Keluar dari aplikasi

Untuk keluar dari aplikasi, masukkan Ctrl-C di shell yang digunakan untuk meluncurkan aplikasi.

Melihat rekaman aktivitas, metrik, dan log

Bagian ini menjelaskan cara melihat peristiwa AI generatif.

Sebelum memulai

Untuk mendapatkan izin yang Anda perlukan guna melihat data log, metrik, dan rekaman aktivitas, minta administrator Anda untuk memberi Anda peran IAM berikut di project Anda:

• Logs Viewer (roles/logging.viewer)
• Monitoring Viewer (roles/monitoring.viewer)
• Cloud Trace User (roles/cloudtrace.user)

Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Melihat telemetri

Untuk melihat peristiwa AI generatif yang dibuat oleh aplikasi, gunakan halaman Trace Explorer:

1. Di Google Cloud konsol, buka halaman Trace explorer:

   Buka Trace explorer

   Anda juga dapat menemukan halaman ini menggunakan kolom penelusuran.

2. Di toolbar, pilih Add filter, pilih Span name, lalu pilih call_llm.

   Berikut ini menggambarkan halaman Trace Explorer setelah memfilter data:

   

   Jika Anda belum pernah menggunakan Cloud Trace, Google Cloud Observability perlu membuat database untuk menyimpan data rekaman aktivitas Anda. Pembuatan database dapat memerlukan waktu beberapa menit dan selama periode tersebut, tidak ada data rekaman aktivitas yang dapat dilihat.

3. Untuk menjelajahi data rentang dan log, pilih rentang di tabel Spans.

   Halaman Details akan terbuka. Halaman ini menampilkan rekaman aktivitas terkait dan rentangnya. Tabel di halaman ini menampilkan informasi mendetail untuk rentang yang Anda pilih. Informasi ini mencakup hal berikut:

   • Tab Inputs/Outputs menampilkan peristiwa untuk agen AI generatif. Untuk mempelajari peristiwa ini lebih lanjut, lihat Melihat peristiwa AI generatif.

     Screenshot berikut menggambarkan rekaman aktivitas, dengan satu rentang memiliki nama call_llm. Rentang tersebut memanggil LLM (Large Language Model) yang mendukung agen ini. Untuk contoh ini, adalah Gemini. Rentang Gemini mencakup peristiwa AI generatif:

     

   • Tab Logs &Events mencantumkan entri log dan peristiwa yang terkait dengan rentang. Jika Anda ingin melihat data log di Logs Explorer, pilih View logs di toolbar tab ini.

     Data log mencakup respons sql_agent. Misalnya, untuk contoh yang dijalankan, payload JSON mencakup konten berikut:

     {
       "logName": "projects/my-project/logs/otel_python_inprocess_log_name_temp",
       "jsonPayload": {
         "content": {
           "parts": [
             0: {
               "text": "Now I can create the table."
             }
             1: {1}
             ],
           "role": "model"
         }
       },
       ...
     }
     

Contoh ini diinstrumentasi untuk mengirim data metrik ke project Anda Google Cloud , tetapi tidak menghasilkan metrik apa pun.