Bắt đầu sử dụng tính năng Giám sát Genkit

Hướng dẫn nhanh này mô tả cách thiết lập tính năng Giám sát Genkit của Firebase cho các tính năng Genkit đã triển khai để bạn có thể thu thập và xem dữ liệu đo từ xa theo thời gian thực. Với tính năng Giám sát Firebase Genkit, bạn có thể biết được hiệu suất của các tính năng Genkit trong phiên bản chính thức.

Các tính năng chính của tính năng Giám sát Genkit Firebase bao gồm:

  • Xem các chỉ số định lượng như độ trễ, lỗi và mức sử dụng mã thông báo của tính năng Genkit.
  • Kiểm tra dấu vết để xem các bước, dữ liệu đầu vào và đầu ra của tính năng trong Genkit, giúp gỡ lỗi và cải thiện chất lượng.
  • Xuất dấu vết sản xuất để chạy các hoạt động đánh giá trong Genkit.

Để thiết lập tính năng Giám sát Genkit, bạn cần hoàn tất các nhiệm vụ trong cả cơ sở mã và trên Google Cloud Console.

Trước khi bắt đầu

  1. Nếu chưa có, hãy tạo một dự án Firebase.

    Trong bảng điều khiển của Firebase, hãy nhấp vào Thêm dự án, sau đó làm theo hướng dẫn trên màn hình. Bạn có thể tạo một dự án mới hoặc thêm các dịch vụ Firebase vào một dự án Google Cloud hiện có.

  2. Đảm bảo dự án của bạn đang sử dụng Gói giá linh hoạt.

    Tính năng Giám sát Genkit dựa vào dữ liệu đo từ xa được ghi vào các dịch vụ có tính phí là Google Cloud Logging, Metrics và Trace. Xem trang Thông tin về giá của Google Cloud Observability để biết thông tin chi tiết về giá và tìm hiểu về các giới hạn của cấp miễn phí.

  3. Viết một tính năng Genkit bằng cách làm theo Hướng dẫn bắt đầu và chuẩn bị mã để triển khai bằng một trong các hướng dẫn sau:

    1. Triển khai luồng bằng Cloud Functions cho Firebase
    2. Triển khai flow bằng Cloud Run
    3. Triển khai flow cho mọi nền tảng Node.js

Bước 1. Thêm trình bổ trợ Firebase

Cài đặt trình bổ trợ @genkit-ai/firebase trong dự án:

npm i –save @genkit-ai/firebase

Nhập enableFirebaseTelemetry vào tệp cấu hình Genkit (tệp nơi khởi chạy genkit(...)) và gọi tệp đó là:

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

enableFirebaseTelemetry();

Bước 2. Bật các API bắt buộc

Đảm bảo rằng bạn đã bật các API sau cho dự án GCP:

Các API này sẽ được liệt kê trong trang tổng quan API cho dự án của bạn.

Bước 3. Thiết lập quyền

Trình bổ trợ Firebase cần sử dụng một tài khoản dịch vụ để xác thực với các dịch vụ Google Cloud Logging, Metrics và Trace.

Cấp các vai trò sau cho bất kỳ tài khoản dịch vụ nào được định cấu hình để chạy mã của bạn trong Bảng điều khiển IAM của Google Cloud. Đối với Cloud Functions cho Firebase và/hoặc Cloud Run, đó thường là tài khoản dịch vụ điện toán mặc định.

  • Trình ghi chỉ số giám sát (roles/monitoring.metricWriter)
  • Trình theo dõi trên đám mây (roles/cloudtrace.agent)
  • Trình ghi nhật ký (roles/logging.logWriter)

Bước 4. (Không bắt buộc) Kiểm thử cấu hình cục bộ

Trước khi triển khai, bạn có thể chạy mã Genkit cục bộ để xác nhận rằng dữ liệu đo từ xa đang được thu thập và có thể xem được trong trang tổng quan của công cụ Giám sát Genkit.

  1. Trong mã Genkit, hãy đặt forceDevExport thành true để gửi dữ liệu đo từ xa từ môi trường cục bộ.

  2. Sử dụng tài khoản dịch vụ để xác thực và kiểm thử cấu hình.

    Với công cụ Google Cloud CLI, hãy xác thực bằng tài khoản dịch vụ:

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

  3. Chạy và gọi tính năng Genkit, sau đó xem các chỉ số trên Trang tổng quan về hoạt động giám sát Genkit. Hãy chờ tối đa 5 phút để thu thập chỉ số đầu tiên. Bạn có thể giảm độ trễ này bằng cách đặt metricExportIntervalMillis trong cấu hình đo từ xa.

  4. Nếu các chỉ số không xuất hiện trong trang tổng quan của Genkit Monitoring, hãy xem hướng dẫn Khắc phục sự cố để biết các bước gỡ lỗi.

Bước 5. Tạo lại và triển khai mã

Tạo lại, triển khai và gọi tính năng Genkit để bắt đầu thu thập dữ liệu. Sau khi Genkit Monitoring nhận được các chỉ số của bạn, bạn có thể xem các chỉ số đó bằng cách truy cập vào trang tổng quan Genkit Monitoring