Genkit Monitoring を使ってみる

このクイックスタート ガイドでは、デプロイされた Genkit 機能に Firebase Genkit Monitoring を設定して、リアルタイムのテレメトリー データを収集して表示する方法について説明します。Firebase Genkit Monitoring を使用すると、本番環境での Genkit 機能のパフォーマンスを把握できます。

Firebase Genkit Monitoring の主な機能は次のとおりです。

• Genkit 機能のレイテンシ、エラー、トークン使用量などの定量指標の表示。
• トレースを確認して Genkit の特徴ステップ、入力、出力を確認することで、デバッグと品質改善に役立ちます。
• 本番環境のトレースをエクスポートして、Genkit 内で評価を実行する。

Genkit Monitoring をセットアップするには、コードベースと Google Cloud コンソールの両方でタスクを完了する必要があります。

始める前に

1. まだ作成していない場合は、Firebase プロジェクトを作成します。

   Firebase コンソールで [プロジェクトを追加] をクリックし、画面上の指示に沿って操作します。新しいプロジェクトを作成することも、既存の Google Cloud プロジェクトに Firebase サービスを追加することもできます。

2. プロジェクトで Blaze 料金プランを利用していることを確認します。

   Genkit Monitoring は、Google Cloud Logging、Metrics、Trace（有料サービス）に書き込まれたテレメトリー データに依存します。料金の詳細と無料枠の上限については、Google Cloud Observability の料金のページをご覧ください。

3. スタートガイドに沿って Genkit 機能を作成し、次のいずれかのガイドを使用してデプロイ用のコードを準備します。

   1. Cloud Functions for 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 を有効にする

GCP プロジェクトで次の API が有効になっていることを確認します。

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

これらの API は、プロジェクトの API ダッシュボードに表示されます。

ステップ 3. 権限を設定する

Firebase プラグインは、サービス アカウントを使用して Google Cloud Logging、Metrics、Trace サービスで認証する必要があります。

Google Cloud IAM コンソールで、コードを実行するように構成されているサービス アカウントに次のロールを付与します。Cloud Functions for Firebase または Cloud Run の場合、通常はデフォルトのコンピューティング サービス アカウントです。

• モニタリング指標の書き込み（roles/monitoring.metricWriter）
• Cloud Trace エージェント（roles/cloudtrace.agent）
• ログ書き込み（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 モニタリング ダッシュボードで指標を表示します。最初の指標が収集されるまで、最長で 5 分ほどかかります。この遅延を短縮するには、テレメトリー構成で metricExportIntervalMillis を設定します。

4. Genkit Monitoring ダッシュボードに指標が表示されない場合は、トラブルシューティング ガイドでデバッグ手順をご覧ください。

ステップ 5. コードを再ビルドしてデプロイする

データの収集を開始するには、Genkit 機能を再ビルドしてデプロイし、呼び出します。Genkit Monitoring が指標を受け取ると、Genkit Monitoring ダッシュボードにアクセスして指標を確認できます。

注: 最初の指標の収集には最長で 5 分ほどかかります（テレメトリー構成のデフォルトの metricExportIntervalMillis 設定に基づきます）。