با Genkit Monitoring شروع کنید

این راهنمای شروع سریع نحوه تنظیم Firebase Genkit Monitoring برای ویژگی‌های Genkit مستقر شده خود را شرح می‌دهد تا بتوانید داده‌های تله‌متری را در زمان واقعی جمع‌آوری و مشاهده کنید. با Firebase Genkit Monitoring، نحوه عملکرد ویژگی‌های Genkit خود را در تولید مشاهده می‌کنید.

قابلیت های کلیدی Firebase Genkit Monitoring عبارتند از:

• مشاهده معیارهای کمی مانند تاخیر ویژگی Genkit، خطاها و استفاده از رمز.
• بررسی ردیابی‌ها برای دیدن مراحل، ورودی‌ها و خروجی‌های ویژگی Genkit برای کمک به اشکال‌زدایی و بهبود کیفیت.
• صادرات آثار تولیدی برای اجرای evals در Genkit.

راه‌اندازی Genkit Monitoring به تکمیل وظایف هم در پایگاه کد و هم در Google Cloud Console نیاز دارد.

قبل از شروع

1. اگر قبلاً این کار را نکرده اید، یک پروژه Firebase ایجاد کنید.

   در کنسول Firebase ، روی افزودن پروژه کلیک کنید، سپس دستورالعمل‌های روی صفحه را دنبال کنید. می توانید یک پروژه جدید ایجاد کنید یا خدمات Firebase را به پروژه Google Cloud موجود اضافه کنید.

2. مطمئن شوید که پروژه شما در برنامه قیمت گذاری Blaze قرار دارد.

   Genkit Monitoring بر داده‌های تله‌متری نوشته شده در Google Cloud Logging، Metrics و Trace متکی است که خدمات پولی هستند. صفحه قیمت گذاری Google Cloud Observability را برای جزئیات قیمت و آشنایی با محدودیت های ردیف رایگان مشاهده کنید.

3. با دنبال کردن راهنمای شروع یک ویژگی Genkit بنویسید و کد خود را با استفاده از یکی از راهنماهای زیر برای استقرار آماده کنید:

   1. استقرار جریان ها با استفاده از توابع ابری برای 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 شما فعال هستند:

• Cloud Logging API
• Cloud Trace API
• Cloud Monitoring API

این APIها باید در داشبورد API پروژه شما فهرست شوند.

مرحله 3. مجوزها را تنظیم کنید

افزونه Firebase باید از یک حساب سرویس برای احراز هویت با سرویس‌های Google Cloud Logging، Metrics و Trace استفاده کند.

نقش‌های زیر را به هر حساب سرویسی که برای اجرای کد شما در Google Cloud IAM Console پیکربندی شده است، اعطا کنید. برای توابع Cloud برای Firebase و/یا Cloud Run، این معمولاً حساب پیش‌فرض سرویس محاسباتی است.

• مانیتورینگ متریک رایتر ( roles/monitoring.metricWriter )
• Cloud Trace Agent ( roles/cloudtrace.agent )
• Logs Writer ( roles/logging.logWriter )

مرحله 4. (اختیاری) پیکربندی خود را به صورت محلی آزمایش کنید

قبل از استقرار، می‌توانید کد Genkit خود را به صورت محلی اجرا کنید تا تأیید کنید که داده‌های تله‌متری در حال جمع‌آوری است و در داشبورد Genkit Monitoring قابل مشاهده است.

1. در کد Genkit خود، forceDevExport روی true تنظیم کنید تا تله متری را از محیط محلی خود ارسال کنید.

2. از حساب سرویس خود برای احراز هویت و آزمایش پیکربندی خود استفاده کنید.

   نکته: برای جعل هویت حساب سرویس، باید نقش roles/iam.serviceAccountTokenCreator IAM را در حساب کاربری خود اعمال کنید.

   با ابزار Google Cloud CLI ، با استفاده از حساب سرویس احراز هویت کنید:

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

3. ویژگی Genkit خود را اجرا و فراخوانی کنید و سپس معیارها را در داشبورد Genkit Monitoring مشاهده کنید. برای جمع آوری اولین معیار حداکثر 5 دقیقه زمان بگذارید. می توانید با تنظیم metricExportIntervalMillis در پیکربندی تله متری، این تاخیر را کاهش دهید.

4. اگر معیارها در داشبورد مانیتورینگ Genkit ظاهر نمی‌شوند، راهنمای عیب‌یابی را برای مراحل رفع اشکال مشاهده کنید.

مرحله 5. کد را دوباره بسازید و مستقر کنید

ویژگی Genkit خود را دوباره بسازید، استقرار و فراخوانی کنید تا شروع به جمع آوری داده ها کنید. پس از اینکه Genkit Monitoring معیارهای شما را دریافت کرد، می توانید با مراجعه به داشبورد Genkit Monitoring آنها را مشاهده کنید.

توجه: جمع آوری اولین متریک (بر اساس تنظیم پیش فرض metricExportIntervalMillis در پیکربندی تله متری) ممکن است تا 5 دقیقه طول بکشد.