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

このドキュメントでは、 コンソールまたは Google Cloud REST API を使用して、Gemini Enterprise アプリまたは個々のエージェントのオブザーバビリティ設定 を構成する方法について説明します。

有効化ロジックはエージェントのタイプによって異なります。

  • コア アシスタント エージェント: 構成でアプリケーション レベル(エンジンレベル)の切り替え を使用します。
  • その他のエージェント(現時点では Workflow Builder の従業員作成エージェント と Deep Research エージェントのみ): 個々のエージェントの設定内で エージェントレベルの切り替えを使用します。

設定を有効にすると、Gemini Enterprise ウェブアプリのアシスタントまたはエージェントとのインタラクションから次のデータを表示できます。

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

主なコンセプト

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

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

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

始める前に

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

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

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

Console

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

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

    Gemini Enterprise

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

  3. 構成するエージェントのタイプに応じて、次のいずれかを行います。

    • コア アシスタント エージェント: [構成] をクリックし、 [オブザーバビリティ] タブをクリックします。
    • その他のエージェント(Workflow Builder の従業員作成エージェントと Deep Research エージェント): [エージェント] をクリックし、構成するエージェントの 名前をクリックして、[構成] タブをクリックします。
  4. 次の設定をオンまたはオフにできます。

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

REST

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

コア アシスタント(アプリレベル)のオブザーバビリティ設定を構成する

アプリレベルで 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。

個々のエージェントのオブザーバビリティ設定を構成する

REST API を使用して個々のエージェント(Workflow Builder エージェントや Deep Research エージェントなど)のオブザーバビリティを有効にするには、次のコマンドを実行してエージェントの observabilityConfig を更新します。

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/assistants/default_assistant/agents/AGENT_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。
  • AGENT_ID: 構成するエージェントの ID

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

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

Console

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

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

    Gemini Enterprise

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

  3. 構成するエージェントのタイプに応じて、次のいずれかを行います。

    • コア アシスタント エージェント: [構成] をクリックし、[オブザーバビリティ] タブをクリックします。
    • その他のエージェント(Workflow Builder の従業員作成 エージェントと Deep Research エージェントを含む): [エージェント] をクリックし、構成するエージェントの名前をクリックして、[構成] タブをクリックします。
  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。

個々のエージェントのオブザーバビリティを無効にする

個々のエージェント(Workflow Builder エージェントや Deep Research エージェントなど)のオブザーバビリティを無効にするには、次のコマンドを実行します。

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/assistants/default_assistant/agents/AGENT_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。
  • AGENT_ID: 構成するエージェントの ID

次のステップ