Mulai menggunakan Genkit Monitoring

Panduan memulai ini menjelaskan cara menyiapkan Firebase Genkit Monitoring untuk fitur Genkit yang di-deploy, sehingga Anda dapat mengumpulkan dan melihat data telemetri real-time. Dengan Firebase Genkit Monitoring, Anda mendapatkan visibilitas tentang performa fitur Genkit dalam produksi.

Kemampuan utama Firebase Genkit Monitoring meliputi:

  • Melihat metrik kuantitatif seperti latensi fitur, error, dan penggunaan token Genkit.
  • Memeriksa trace untuk melihat langkah, input, dan output fitur Genkit Anda, untuk membantu proses debug dan peningkatan kualitas.
  • Mengekspor trace produksi untuk menjalankan evaluasi dalam Genkit.

Menyiapkan Genkit Monitoring memerlukan penyelesaian tugas di codebase Anda dan di Google Cloud Console.

Sebelum memulai

  1. Jika Anda belum melakukannya, buat project Firebase.

    Di Firebase console, klik Tambahkan project, lalu ikuti petunjuk di layar. Anda dapat membuat project baru atau menambahkan layanan Firebase ke project Google Cloud yang sudah ada.

  2. Pastikan project Anda menggunakan paket harga Blaze.

    Pemantauan Genkit mengandalkan data telemetri yang ditulis ke Google Cloud Logging, Metrik, dan Trace, yang merupakan layanan berbayar. Lihat halaman Harga Google Cloud Observability untuk mengetahui detail harga dan mempelajari batas paket gratis.

  3. Tulis fitur Genkit dengan mengikuti Panduan Memulai, dan siapkan kode Anda untuk di-deploy menggunakan salah satu panduan berikut:

    1. Men-deploy alur menggunakan Cloud Functions for Firebase
    2. Men-deploy alur menggunakan Cloud Run
    3. Men-deploy alur ke platform Node.js mana pun

Langkah 1. Menambahkan plugin Firebase

Instal plugin @genkit-ai/firebase di project Anda:

npm i –save @genkit-ai/firebase

Impor enableFirebaseTelemetry ke dalam file konfigurasi Genkit (file tempat genkit(...) diinisialisasi), dan beri nama:

import { enableFirebaseTelemetry } from '@genkit-ai/firebase';

enableFirebaseTelemetry();

Langkah 2. Mengaktifkan API yang diperlukan

Pastikan API berikut diaktifkan untuk project GCP Anda:

API tersebut harus tercantum di dasbor API untuk project Anda.

Langkah 3. Siapkan izin

Plugin Firebase harus menggunakan akun layanan untuk melakukan autentikasi dengan layanan Google Cloud Logging, Metrics, dan Trace.

Berikan peran berikut ke akun layanan mana pun yang dikonfigurasi untuk menjalankan kode Anda dalam Konsol IAM Google Cloud. Untuk Cloud Functions for Firebase dan/atau Cloud Run, akun tersebut biasanya adalah akun layanan komputasi default.

  • Monitoring Metric Writer (roles/monitoring.metricWriter)
  • Agen Cloud Trace (roles/cloudtrace.agent)
  • Logs Writer (roles/logging.logWriter)

Langkah 4. (Opsional) Menguji konfigurasi secara lokal

Sebelum men-deploy, Anda dapat menjalankan kode Genkit secara lokal untuk mengonfirmasi bahwa data telemetri sedang dikumpulkan, dan dapat dilihat di dasbor Pemantauan Genkit.

  1. Dalam kode Genkit, tetapkan forceDevExport ke true untuk mengirim telemetri dari lingkungan lokal Anda.

  2. Gunakan akun layanan Anda untuk mengautentikasi dan menguji konfigurasi.

    Dengan alat Google Cloud CLI, lakukan autentikasi menggunakan akun layanan:

    gcloud auth application-default login --impersonate-service-account <SERVICE_ACCT_EMAIL>

  3. Jalankan dan panggil fitur Genkit, lalu lihat metrik di dasbor Pemantauan Genkit. Tunggu hingga 5 menit untuk mengumpulkan metrik pertama. Anda dapat mengurangi penundaan ini dengan menetapkan metricExportIntervalMillis dalam konfigurasi telemetri.

  4. Jika metrik tidak muncul di dasbor Genkit Monitoring, lihat panduan Pemecahan masalah untuk mengetahui langkah-langkah debug.

Langkah 5. Mem-build ulang dan men-deploy kode

Build ulang, deploy, dan panggil fitur Genkit Anda untuk mulai mengumpulkan data. Setelah Genkit Monitoring menerima metrik, Anda dapat melihatnya dengan membuka dasbor Genkit Monitoring