תצורה מתקדמת

המדריך הזה מתמקד באפשרויות תצורה מתקדמות של תכונות שנפרסו באמצעות הפלאגין של טלמטריה ב-Firebase. תיאורים מפורטים של כל אפשרות הגדרה מופיעים במסמכי העזרה של JS API.

במסמך הזה נסביר איך לכוונן את נתוני הטלמטריה שנאספים, את התדירות שבה הם נאספים ואת הסביבות שמהן הם נאספים.

הגדרות ברירת המחדל

הפלאגין של טלמטריה של Firebase מספק אפשרויות ברירת מחדל מוכנות לשימוש, כדי שתוכלו להתחיל להשתמש בו במהירות. אלה ערכי ברירת המחדל שסופקו:

{
  autoInstrumentation: true,
  autoInstrumentationConfig: {
    '@opentelemetry/instrumentation-dns': { enabled: false },
  }
  disableMetrics: false,
  disableTraces: false,
  disableLoggingInputAndOutput: false,
  forceDevExport: false,
  // 5 minutes
  metricExportIntervalMillis: 300_000,
  // 5 minutes
  metricExportTimeoutMillis: 300_000,
  // See https://js.api.genkit.dev/interfaces/_genkit-ai_google-cloud.GcpTelemetryConfigOptions.html#sampler
  sampler: AlwaysOnSampler()
}

ייצוא נתוני טלמטריה מקומיים

כדי לייצא נתוני טלמטריה כשמריצים את הקוד באופן מקומי, מגדירים את האפשרות forceDevExport לערך true.

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

enableFirebaseTelemetry({forceDevExport: true});

במהלך הפיתוח והבדיקה, אפשר להקטין את זמן האחזור על ידי שינוי של פרק הזמן לייצוא וזמן הקצאת הזמן.

הערה: שליחת נתוני טלמטריה לסביבת הייצור במרווחי זמן קצרים לייצוא עשויה להגדיל את העלות של נתוני הטלמטריה שיוצאו.

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

enableFirebaseTelemetry({
  forceDevExport: true,
  metricExportIntervalMillis: 10_000, // 10 seconds
  metricExportTimeoutMillis: 10_000 // 10 seconds
});

שינוי של המדידה האוטומטית

הפלאגין של טלמטריה של Firebase יאסוף באופן אוטומטי נתוני מעקב ומדדים של מסגרות פופולריות באמצעות מכשירי מדידה ללא קוד של OpenTelemetry.

רשימה מלאה של הכלים הזמינים זמינה במסמכי העזרה של auto-instrumentations-node.

כדי להשבית או להפעיל באופן סלקטיבי את הכלים למדידה שעומדים בדרישות לכלי למדידה אוטומטית, מעדכנים את השדה autoInstrumentationConfig:

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

enableFirebaseTelemetry({
  autoInstrumentationConfig: {
    '@opentelemetry/instrumentation-fs': { enabled: false },
    '@opentelemetry/instrumentation-dns': { enabled: false },
    '@opentelemetry/instrumentation-net': { enabled: false },
  }
});

השבתת הטלמטריה

ב-Firebase Genkit Monitoring נעשה שימוש בשילוב של רישום ביומן, מעקב ונתונים כדי לתעד תמונה מקיפה של האינטראקציות שלכם עם Genkit. עם זאת, אם צריך, אפשר להשבית כל אחד מהרכיבים האלה בנפרד.

השבתת הרישום ביומן של קלט ופלט

כברירת מחדל, הפלאגין של טלמטריה של Firebase יתעד את הקלט והפלט של כל שלב או תכונה ב-Genkit.

כדי לשלוט באופן האחסון של נתוני הלקוחות, אפשר להשבית את הרישום ביומן של הקלט והפלט. לשם כך, מוסיפים את הקוד הבא לתצורה:

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

enableFirebaseTelemetry({
  disableLoggingInputAndOutput: true
});

כשמגדירים את האפשרות הזו, מאפייני הקלט והפלט יימחקו במעקב ב-Firebase Genkit Monitoring, ולא יופיעו ברישום ביומן של Google Cloud.

השבתת מדדים

כדי להשבית את איסוף המדדים, מוסיפים את הקוד הבא לתצורה:

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

enableFirebaseTelemetry({
  disableMetrics: true
});

אם תגדירו את האפשרות הזו, מדדי היציבות לא יוצגו יותר בלוח הבקרה של Firebase Genkit Monitoring, והם לא יופיעו ב-Google Cloud Metrics.

השבתת עקבות

כדי להשבית את איסוף המעקב, מוסיפים את הקוד הבא להגדרות:

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

enableFirebaseTelemetry({
  disableTraces: true
});

אחרי שמגדירים את האפשרות הזו, לא יוצגו יותר שרטוטים בדף התכונה Monitoring ב-Firebase Genkit, לא תהיה גישה לצופה בשרטוטים ולא יוצגו שרטוטים ב-Google Cloud Tracing.