เริ่มต้นใช้งาน Genkit Monitoring

คู่มือการเริ่มต้นใช้งานฉบับนี้อธิบายวิธีตั้งค่าการตรวจสอบ Genkit ของ Firebase สําหรับฟีเจอร์ Genkit ที่ติดตั้งใช้งาน เพื่อให้คุณรวบรวมและดูข้อมูลการวัดผลแบบเรียลไทม์ได้ การตรวจสอบ Firebase Genkit ช่วยให้คุณเห็นประสิทธิภาพของฟีเจอร์ Genkit ในเวอร์ชันที่ใช้งานจริง

ความสามารถหลักๆ ของ Firebase Genkit Monitoring มีดังนี้

  • การดูเมตริกเชิงปริมาณ เช่น เวลาในการตอบสนอง ข้อผิดพลาด และการใช้โทเค็นของฟีเจอร์ Genkit
  • ตรวจสอบการติดตามเพื่อดูขั้นตอน อินพุต และเอาต์พุตของฟีเจอร์ Genkit เพื่อใช้ในการแก้ไขข้อบกพร่องและปรับปรุงคุณภาพ
  • การส่งออกร่องรอยเวอร์ชันที่ใช้งานจริงเพื่อเรียกใช้การประเมินภายใน Genkit

การตั้งค่าการตรวจสอบ Genkit กำหนดให้ต้องทํางานทั้งโค้ดเบสและในคอนโซล Google Cloud ให้เสร็จสมบูรณ์

ก่อนเริ่มต้น

  1. สร้างโปรเจ็กต์ Firebase หากยังไม่ได้สร้าง

    ในคอนโซล Firebase ให้คลิกเพิ่มโปรเจ็กต์ แล้วทําตามวิธีการบนหน้าจอ คุณสามารถสร้างขึ้นโปรเจ็กต์ใหม่หรือเพิ่มบริการ Firebase ไปยังโปรเจ็กต์ Google Cloud ที่มีอยู่

  2. ตรวจสอบว่าโปรเจ็กต์ใช้แพ็กเกจราคา Blaze

    Genkit Monitoring ใช้ข้อมูลการวัดผลที่เขียนลงใน Google Cloud การบันทึก ข้อมูลเชิงวัด และร่องรอย ซึ่งเป็นบริการแบบชำระเงิน ดูรายละเอียดราคาและขีดจํากัดของรุ่นที่ไม่มีค่าใช้จ่ายได้ในหน้าราคาของ Google Cloud Observability

  3. เขียนฟีเจอร์ Genkit โดยทําตามคู่มือการเริ่มต้นใช้งาน และเตรียมโค้ดสําหรับการทําให้ใช้งานได้โดยใช้คู่มืออย่างใดอย่างหนึ่งต่อไปนี้

    1. ทำให้โฟลว์ใช้งานได้โดยใช้ Cloud Functions for Firebase
    2. ทำให้โฟลว์ใช้งานได้โดยใช้ Cloud Run
    3. ทำให้โฟลว์ใช้งานได้บนแพลตฟอร์ม Node.js ใดก็ได้

ขั้นตอนที่ 1 เพิ่มปลั๊กอิน Firebase

ติดตั้งปลั๊กอิน @genkit-ai/firebase ในโปรเจ็กต์โดยทำดังนี้

npm i –save @genkit-ai/firebase

นําเข้า enableFirebaseTelemetry ไปยังไฟล์การกําหนดค่า Genkit (ไฟล์ที่เริ่มต้น genkit(...)) และเรียกใช้ดังนี้

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

enableFirebaseTelemetry();

ขั้นตอนที่ 2 เปิดใช้ API ที่จำเป็น

ตรวจสอบว่าได้เปิดใช้ API ต่อไปนี้สําหรับโปรเจ็กต์ GCP แล้ว

API เหล่านี้ควรแสดงอยู่ในหน้าแดชบอร์ด API ของโปรเจ็กต์

ขั้นตอนที่ 3 ตั้งค่าสิทธิ์

ปลั๊กอิน Firebase ต้องใช้บัญชีบริการเพื่อตรวจสอบสิทธิ์กับบริการบันทึก ข้อมูลเมตริก และการติดตามของ Google Cloud

มอบบทบาทต่อไปนี้ให้กับบัญชีบริการที่กำหนดค่าให้เรียกใช้โค้ดของคุณภายในคอนโซล IAM ของ Google Cloud สําหรับ Cloud Functions for Firebase และ/หรือ Cloud Run บัญชีดังกล่าวมักจะเป็นบัญชีบริการ Compute เริ่มต้น

  • Monitoring Metric Writer (roles/monitoring.metricWriter)
  • Cloud Trace Agent (roles/cloudtrace.agent)
  • โปรแกรมบันทึก (roles/logging.logWriter)

ขั้นตอนที่ 4 (ไม่บังคับ) ทดสอบการกําหนดค่าในเครื่อง

ก่อนการทําให้ใช้งานได้ คุณสามารถเรียกใช้โค้ด Genkit ในเครื่องเพื่อยืนยันว่าระบบกําลังรวบรวมข้อมูลการวัดผลอยู่และดูข้อมูลดังกล่าวได้ในแดชบอร์ดการตรวจสอบ Genkit

  1. ในโค้ด Genkit ให้ตั้งค่า forceDevExport เป็น true เพื่อส่งข้อมูลการวัดผลจากสภาพแวดล้อมในเครื่อง

  2. ใช้บัญชีบริการเพื่อตรวจสอบสิทธิ์และทดสอบการกําหนดค่า

    ตรวจสอบสิทธิ์โดยใช้บัญชีบริการด้วยเครื่องมือ CLI ของ Google Cloud โดยทำดังนี้

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

  3. เรียกใช้ฟีเจอร์ Genkit แล้วดูเมตริกในหน้าแดชบอร์ดการตรวจสอบ Genkit โปรดรอไม่เกิน 5 นาทีเพื่อรวบรวมเมตริกแรก คุณสามารถลดความล่าช้านี้ได้ด้วยการกําหนดค่า metricExportIntervalMillis ในการกำหนดค่าการวัดผล

  4. หากเมตริกไม่ปรากฏในหน้าแดชบอร์ดการตรวจสอบ Genkit ให้ดูคู่มือการแก้ปัญหาเพื่อดูขั้นตอนการแก้ไขข้อบกพร่อง

ขั้นตอนที่ 5 บิลด์และทำให้โค้ดใช้งานได้อีกครั้ง

บิลด์ ติดตั้งใช้งาน และเรียกใช้ฟีเจอร์ Genkit อีกครั้งเพื่อเริ่มรวบรวมข้อมูล หลังจาก Genkit Monitoring ได้รับเมตริกแล้ว คุณจะดูเมตริกได้โดยไปที่หน้าแดชบอร์ดของ Genkit Monitoring