بدء استخدام Genkit Monitoring

يوضّح دليل البدء السريع هذا كيفية إعداد ميزة "مراقبة Firebase Genkit" لأجل ميزات Genkit المنشورة، حتى تتمكّن من جمع بيانات قياس الأداء في الوقت الفعلي وعرضها. من خلال ميزة "مراقبة Firebase Genkit"، يمكنك الاطّلاع على مستوى أداء ميزات Genkit في مرحلة الإنتاج.

تشمل الإمكانات الرئيسية لميزة "مراقبة Firebase Genkit" ما يلي:

  • عرض المقاييس الكميّة، مثل وقت استجابة ميزات Genkit والأخطاء واستخدام الرمز المميّز
  • فحص عمليات التتبّع للاطّلاع على خطوات ميزة Genkit ومدخلاتها ومخرجاتها، للمساعدة في تصحيح الأخطاء وتحسين الجودة
  • تصدير عمليات تتبُّع الإصدار العلني لإجراء عمليات التقييم ضمن Genkit

يتطلّب إعداد Genkit Monitoring إكمال المهام في كلّ من قاعدة بياناتك وGoogle Cloud Console.

قبل البدء

  1. أنشئ مشروعًا على Firebase، إذا لم يسبق لك ذلك.

    في وحدة تحكُّم Firebase، انقر على إضافة مشروع، ثم اتّبِع التعليمات التي تظهر على الشاشة. يمكنك إنشاء مشروع جديد أو إضافة خدمات Firebase إلى مشروع Google Cloud حالي.

  2. تأكَّد من أنّ مشروعك يستخدم خطة أسعار Blaze.

    تعتمد ميزة "مراقبة Genkit" على بيانات القياس التي يتم كتابتها في Google Cloud Logging وMetrics وTrace، وهي خدمات مدفوعة. اطّلِع على صفحة أسعار مراقبة Google Cloud لمعرفة تفاصيل الأسعار والتعرّف على حدود الفئات المجانية.

  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: تفعيل واجهات برمجة التطبيقات المطلوبة

تأكَّد من تفعيل واجهات برمجة التطبيقات التالية لمشروعك على Google Cloud Platform:

يجب أن تكون واجهات برمجة التطبيقات هذه مُدرَجة في لوحة بيانات واجهة برمجة التطبيقات لمشروعك.

الخطوة 3: إعداد الأذونات

يجب أن يستخدم المكوّن الإضافي Firebase حساب خدمة للمصادقة مع خدمات logging وMetrics وTrace في Google Cloud.

امنح الأدوار التالية لأي حساب خدمة تم إعداده لتشغيل الرمز البرمجي ضمن وحدة تحكّم إدارة الهوية وإمكانية الوصول في Google Cloud. بالنسبة إلى "وظائف السحابة الإلكترونية لبرنامج Firebase" و/أو Cloud Run، يكون ذلك عادةً حساب الخدمة التلقائي لحساب الخدمة الحسابي.

  • Monitoring Metric Writer (roles/monitoring.metricWriter)
  • Cloud Trace Agent (roles/cloudtrace.agent)
  • كاتب السجلّات (roles/logging.logWriter)

الخطوة 4: (اختياري) اختبار الإعدادات محليًا

قبل نشر الرمز البرمجي لـ Genkit، يمكنك تشغيله محليًا للتأكّد من أنّه يتم جمع بيانات القياس عن بُعد، ويمكن عرضها في لوحة تحكّم مراقبة Genkit.

  1. في رمز Genkit، اضبط forceDevExport على true لإرسال بيانات القياس من بيئتك المحلية.

  2. استخدِم حساب الخدمة للمصادقة واختبار الإعدادات.

    باستخدام أداة Google Cloud CLI، يمكنك المصادقة باستخدام حساب الخدمة:

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

  3. شغِّل ميزة Genkit واستخدِمها، ثم اطّلِع على المقاييس في لوحة التحكّم في مراقبة Genkit. يُرجى الانتظار لمدة تصل إلى 5 دقائق لجمع المقياس الأول. يمكنك تقليل مدّة التأخير هذه من خلال ضبط metricExportIntervalMillis في إعدادات القياس.

  4. إذا لم تظهر المقاييس في لوحة بيانات "مراقبة Genkit"، اطّلِع على دليل تحديد المشاكل وحلّها لمعرفة الخطوات اللازمة لتحديد الأخطاء وحلّها.

الخطوة 5: إعادة إنشاء الرمز ونشره

أعِد إنشاء ميزة Genkit ونشرها واستخدامها لبدء جمع البيانات. بعد أن تتلقّى أداة Genkit Monitoring المقاييس، يمكنك الاطّلاع عليها من خلال الانتقال إلى لوحة بيانات Genkit Monitoring.