進階設定

本指南著重於使用 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 監控功能會結合記錄、追蹤和指標,全面掌握 Genkit 互動情形。不過,您也可以視需要個別停用這些元素。

停用輸入和輸出記錄

根據預設,Firebase 追蹤記錄外掛程式會擷取每個 Genkit 功能或步驟的輸入和輸出內容。

如要控管客戶資料的儲存方式,您可以在設定中加入以下內容,停用輸入和輸出的記錄功能:

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

enableFirebaseTelemetry({
  disableLoggingInputAndOutput: true
});

設定這個選項後,輸入和輸出屬性會在 Firebase Genkit 監控追蹤記錄檢視器中被遮蓋,並會從 Google Cloud 記錄中移除。

停用指標

如要停用指標收集功能,請在設定中新增下列內容:

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

enableFirebaseTelemetry({
  disableMetrics: true
});

設定這個選項後,您將無法在 Firebase Genkit 監控資訊主頁中看到穩定度指標,也無法在 Google Cloud Metrics 中看到這項指標。

停用追蹤

如要停用追蹤記錄收集功能,請在設定中新增以下內容:

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

enableFirebaseTelemetry({
  disableTraces: true
});

設定這個選項後,您將無法再透過 Firebase Genkit 監控功能頁面查看追蹤記錄、存取追蹤記錄檢視器,或查看 Google Cloud 追蹤記錄中的追蹤記錄。