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

このドキュメントでは、 コンソールを使用して Gemini Enterprise アプリのオブザーバビリティ設定を構成する方法について説明します。 Google Cloud 設定を有効にすると、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. コンソールで、[Gemini Enterprise] ページに移動します。 Google Cloud

    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 アプリのオブザーバビリティ設定を無効にするには、 コンソールまたは REST API を使用します。 Google Cloud

コンソール

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

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

    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。

次のステップ