オブザーバビリティの設定を管理する

このドキュメントでは、 Google Cloud コンソールを使用して Gemini Enterprise アプリのオブザーバビリティ設定を構成する方法について説明します。設定を有効にすると、Gemini Enterprise ウェブアプリでアシスタントとのやり取りから次のデータを表示できます。

  • Metrics Explorer で指標を表示します。
  • Trace エクスプローラでトレースとスパンを表示する。

主なコンセプト

このセクションでは、Gemini Enterprise のオブザーバビリティに関連する主なコンセプトについて説明します。

コンセプト 説明
トレース トレースは、さまざまなサービスとコンポーネントを通過する単一のリクエストまたはトランザクションを表すスパンのコレクションです。

たとえば、トレースはリクエストのライフサイクル全体を表します。これには、ユーザーが Gemini Enterprise アシスタントに質問する、Gemini Enterprise アシスタントが回答する、回答によってトリガーされる後続のアクション（メールの送信など）が含まれます。
スパン スパンは、トレース内の単一のタイムド作業単位です。関数呼び出し、API リクエスト、データベース クエリなどの特定のオペレーションを表します。各スパンには、開始時刻と終了時刻、一意の ID、他のスパンとの関係などの詳細が含まれます。これらの関係をまとめてトレースと呼びます。
スパンログ スパンログは、特定のスパンに関連付けられたタイムスタンプ付きのフリーフォーム メッセージまたはイベントです。スパンの実行に関する詳細なコンテキスト情報が提供されるため、ユーザーは問題をデバッグし、リクエストのフローを把握できます。
指標 指標は、システムが経時的に収集する数値測定値です。これらの測定値は、システムのパフォーマンス、リソース使用率、動作を表します。エンジニアは指標を使用して、システムの状態をモニタリングし、傾向を特定して、アラートをトリガーします。
使用状況の監査ログ 使用状況監査ログは、 Google Cloud リソース内の管理アクティビティとアクセスを記録したものです。これらのログには、誰が、いつ、どこから、どのような操作を行ったかに関する詳細な情報が記録されます。これらのログは、セキュリティ監査、コンプライアンス、リソースの使用状況の把握に不可欠です。
Gemini Enterprise コネクタのエラーログ Gemini Enterprise コネクタのエラーログには、Gemini Enterprise を Jira や Microsoft OneDrive などのサードパーティのデータソースと統合する際に発生したエラーと障害が記録されます。これらのログには、接続の問題、データ変換の問題、API エラーが含まれます。

始める前に

以下のものが揃っていることを確認してください。

オブザーバビリティ設定を有効にする

Gemini Enterprise アプリのオブザーバビリティを有効にするには、Google Cloud コンソールまたは REST API を使用します。

コンソール

Google Cloud コンソールを使用してオブザーバビリティ設定を有効にする手順は次のとおりです。

  1. Google Cloud コンソールで、[Gemini Enterprise] ページに移動します。

    Gemini Enterprise

  2. 構成するアプリの名前をクリックします。

  3. [構成] をクリックし、[オブザーバビリティ] タブをクリックします。

  4. 次の設定をオンまたはオフにできます。

    オブザーバビリティの設定 説明
    OpenTelemetry のトレースとログの計測を有効にする 有効にすると、Cloud Logging でログに関連付けられたトレース、スパン、スパンログ、指標を表示できます。
    プロンプト入力とレスポンス出力のロギングを有効にする 有効にすると、Cloud Logging はユーザーのプロンプトと回答の完全な内容をログに記録します。これには、センシティブ データや個人情報（PII）が含まれます。この設定を有効にするには、まず OpenTelemetry のトレースとログの計測を有効にするを有効にする必要があります。

REST

REST API を使用してオブザーバビリティ設定を構成するには、次のセクションをご覧ください。

アプリの作成時にオブザーバビリティを有効にする

オブザーバビリティを有効にして新しいアプリを作成するには、次のコマンドを実行します。

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "name": "projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID",
  "displayName": "APP_DISPLAY_NAME",
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "searchEngineConfig": {
    "searchTier": "SEARCH_TIER_ENTERPRISE",
    "searchAddOns": ["SEARCH_ADD_ON_LLM"],
    "requiredSubscriptionTier": "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"
  },
  "industryVertical": "GENERIC",
  "appType": "APP_TYPE_INTRANET",
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

次のように置き換えます。

  • ENDPOINT_LOCATION: API リクエストのマルチリージョン。次のいずれかの値を指定します。
    • 米国のマルチリージョンの場合は us
    • EU のマルチリージョンの場合は eu
    • グローバル ロケーションの場合は global
    詳細については、データストアのマルチリージョンを指定するをご覧ください。
  • PROJECT_ID: 実際のプロジェクトの ID。
  • LOCATION: データストアのマルチリージョン（global、us、eu）
  • APP_ID: 作成するアプリの ID。
  • APP_DISPLAY_NAME: 作成するアプリの表示名。

既存のアプリのオブザーバビリティを有効にする

既存のアプリでオブザーバビリティを有効にするには、次のコマンドを実行します。

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

次のように置き換えます。

  • ENDPOINT_LOCATION: API リクエストのマルチリージョン。次のいずれかの値を指定します。
    • 米国のマルチリージョンの場合は us
    • EU のマルチリージョンの場合は eu
    • グローバル ロケーションの場合は global
    詳細については、データストアのマルチリージョンを指定するをご覧ください。
  • PROJECT_ID: 実際のプロジェクトの ID。
  • LOCATION: データストアのマルチリージョン（global、us、eu）
  • APP_ID: アプリの ID。

オブザーバビリティ設定をオフにする

Gemini Enterprise アプリのオブザーバビリティ設定をオフにするには、 Google Cloud コンソールまたは REST API を使用します。

コンソール

Google Cloud コンソールを使用してオブザーバビリティ設定をオフにする手順は次のとおりです。

  1. Google Cloud コンソールで、[Gemini Enterprise] ページに移動します。

    Gemini Enterprise

  2. オブザーバビリティ設定をオフにするアプリの名前をクリックします。

  3. [構成] をクリックし、[オブザーバビリティ] タブをクリックします。

  4. 次の設定はオフにできます。

    オブザーバビリティの設定 説明
    OpenTelemetry のトレースとログの計測を有効にする この設定をオフにすると、トレース、スパン、スパンログ、指標の収集が停止します。また、[プロンプト入力とレスポンス出力のロギングを有効にする] 設定もオフになります。つまり、ログは Cloud Logging に送信されません。
    プロンプト入力とレスポンス出力のロギングを有効にする オフにすると、Cloud Logging はプロンプト入力とレスポンス出力をログに記録しません。

REST

REST API を使用してオブザーバビリティ設定をオフにするには、次のコマンドを実行します。

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": false,
    "sensitiveLoggingEnabled": false
  }
}'

次のように置き換えます。

  • ENDPOINT_LOCATION: API リクエストのマルチリージョン。次のいずれかの値を指定します。
    • 米国のマルチリージョンの場合は us
    • EU のマルチリージョンの場合は eu
    • グローバル ロケーションの場合は global
    詳細については、データストアのマルチリージョンを指定するをご覧ください。
  • PROJECT_ID: 実際のプロジェクトの ID。
  • LOCATION: データストアのマルチリージョン（global、us、eu）
  • APP_ID: アプリの ID。

次のステップ