ヘルス ステータスをモニタリングする

ユーザー管理のノートブック インスタンスには、ノートブックの状態をモニタリングする方法がいくつかあります。このページでは、それぞれの方法について説明します。

ヘルス ステータスをモニタリングする方法

ユーザー管理のノートブック インスタンスの状態をモニタリングするには、いくつかの方法があります。このページでは、次の方法について説明します。

• ゲスト属性を使用してシステムの状態を報告する

• Cloud Monitoring にカスタム指標を報告する

• ユーザー管理のノートブック インスタンスに Monitoring をインストールして、システム指標とアプリケーション指標を Monitoring に報告する

• 診断ツールを使用する

gcloud CLI を設定する

Install the Google Cloud CLI, then initialize it by running the following command:

gcloud init

ゲスト属性を使用してシステムの状態を報告する

ゲスト属性を使用すると、次のコアサービスのシステム状態を報告できます。

• Docker サービス
• Docker リバース プロキシ エージェント
• Jupyter サービス
• Jupyter API

ゲスト属性は、ユーザー管理のノートブック インスタンスで実行中にアプリケーションから書き込み可能なカスタム メタデータです。ゲスト属性の詳細については、VM メタデータについてをご覧ください。

インスタンスがゲスト属性を使用してシステムの状態を報告する方法

notebooks-collection-agent サービスは、Python プロセスをバックグラウンドで実行します。ここでは、ユーザー管理のノートブック インスタンスのコアサービスのステータスを確認し、問題が検出されない場合は 1 として、または障害が検出された場合は -1 としてゲスト属性を更新します。

notebooks-collection-agent サービスを使用して、ユーザー管理のノートブック インスタンスの状態を報告するには、ユーザー管理のノートブック インスタンスを作成するときに、次のゲスト属性を有効にする必要があります。

• enable-guest-attributes=TRUE: ユーザー管理のノートブック インスタンスでゲスト属性を有効にします。デフォルトでは、この属性はすべての新しいインスタンスで有効になります。
• report-system-health=TRUE: ゲスト属性にシステムのヘルスチェックの結果が記録されます。

notebooks-collection-agent サービスには、インスタンスのゲスト属性を書き込むための特別な権限は必要ありません。

システム状態のゲスト属性を有効にして、ユーザー管理のノートブック インスタンスを作成する

システム状態のゲスト属性を使用して、ユーザー管理のノートブック インスタンスの状態に関するレポートを作成するには、ユーザー管理のノートブック インスタンスを作成するときに [システムのヘルスレポートを有効にする] チェックボックスをオンにする必要があります。

システムのヘルスレポートを有効にするには、Google Cloud コンソールまたは Google Cloud CLI を使用します。

準備

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Notebooks API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Notebooks API.

   Enable the API

8. ユーザー管理のノートブック インスタンスで GPU を使用する場合は、Google Cloud コンソールの [割り当て] ページで、プロジェクトに使用できる GPU が十分であることを確認してください。GPU が [割り当て] ページのリストにない場合や、さらに GPU 割り当てが必要な場合は、割り当て量の増加をリクエストしてください。Compute Engine のリソースの割り当てページの割り当て量の増加をリクエストするをご覧ください。

必要なロール

プロジェクトを作成した場合、そのプロジェクトに対するオーナー（roles/owner）IAM ロールが付与されています。このロールには、必要な権限がすべて含まれています。このセクションをスキップして、ユーザー管理のノートブック インスタンスの作成を開始します。プロジェクトを自分で作成していない場合は、このセクションに進んでください。

Vertex AI Workbench ユーザー管理ノートブック インスタンスの作成に必要な権限がユーザー アカウントに付与されるように、プロジェクトに対する次の IAM ロールをユーザー アカウントに付与するよう管理者に依頼してください。

• Notebooks 管理者（roles/notebooks.admin）
• サービス アカウント ユーザー（roles/iam.serviceAccountUser）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

管理者は、カスタムロールや他の事前定義ロールを使用して、必要な権限をユーザー アカウントに付与することもできます。

インスタンスを作成する

ゲスト属性を使用してシステムの状態をモニタリングする

関連するゲスト属性が有効になっているユーザー管理のノートブック インスタンスの場合、Google Cloud コンソール、Compute Engine コマンドを使用する Google Cloud CLI、または Vertex AI Workbench コマンドを使用する Google Cloud CLI を使用して、システム状態のゲスト属性の値を取得できます。

gcloud compute instances get-guest-attributes INSTANCE_NAME \
    --zone ZONE

 NAMESPACE   KEY                         VALUE
 notebooks   docker_proxy_agent_status   1
 notebooks   docker_status               1
 notebooks   jupyterlab_api_status       1
 notebooks   jupyterlab_status           1
 notebooks   system-health               1
 notebooks   updated                     2020-10-01 17:00:00.12345

 NAMESPACE   KEY                         VALUE
 notebooks   docker_proxy_agent_status   -1
 notebooks   docker_status               -1
 notebooks   jupyterlab_api_status       1
 notebooks   jupyterlab_status           1
 notebooks   system-health               -1
 notebooks   updated                     2020-10-01 17:00:00.12345

gcloud notebooks instances is-healthy example-instance \
    --location=ZONE

  {
          "health_state": HEALTHY,
          "docker-proxy-agent": 1,
          "docker-service": 1,
          "jupyter-service": 1,
          "jupyter-api": 1,
          "last-updated": "2020-10-01 17:00:30.12345"
  }

  {
          "healthy": UNHEALTHY,
          "docker-proxy-agent": 1,
          "docker-service": 1,
          "jupyter-service": -1,
          "jupyter-api": -1,
          "last-updated": "2020-10-01 17:00:30.12345"
  }

カスタム指標を Monitoring に報告する

ユーザー管理のノートブック インスタンスを使用すると、システムのステータスと JupyterLab の指標を収集し、Cloud Monitoring に報告できます。これらのカスタム指標は、ユーザー管理のノートブック インスタンスに Monitoring をインストールするときに報告される標準指標とは異なります。

Monitoring に報告されるカスタム指標は次のとおりです。

• ユーザー管理のノートブックのコアサービスのシステム状態:

  • Docker サービス
  • Docker リバース プロキシ エージェント
  • Jupyter サービス
  • Jupyter API

• 次の JupyterLab 指標:

  • カーネルの数
  • ターミナルの数
  • 接続の数
  • セッションの数
  • 最大メモリ
  • ハイメモリ
  • 現在のメモリ

インスタンスが Monitoring にカスタム指標を報告する方法

Monitoring にカスタム指標を報告するには、ユーザー管理のノートブック インスタンスの作成中に report-notebook-metrics メタデータ設定を有効にする必要があります。

また、ユーザー管理のノートブック インスタンスのサービス アカウントに、モニタリング指標の書き込み（roles/monitoring.metricWriter）権限が必要です。詳細については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

カスタム指標を Monitoring にレポートするユーザー管理のノートブック インスタンスを作成する

Monitoring にカスタム指標を報告するには、ユーザー管理のノートブック インスタンスを作成するときに、[Cloud Monitoring にカスタム指標を報告する] チェックボックスをオンにする必要があります。

Cloud Monitoring へのカスタム指標の報告を有効にするには、Google Cloud コンソールまたは Google Cloud CLI を使用します。

準備

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Notebooks API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Notebooks API.

   Enable the API

8. ユーザー管理のノートブック インスタンスで GPU を使用する場合は、Google Cloud コンソールの [割り当て] ページで、プロジェクトに使用できる GPU が十分であることを確認してください。GPU が [割り当て] ページのリストにない場合や、さらに GPU 割り当てが必要な場合は、割り当て量の増加をリクエストしてください。Compute Engine のリソースの割り当てページの割り当て量の増加をリクエストするをご覧ください。

必要なロール

プロジェクトを作成した場合、そのプロジェクトに対するオーナー（roles/owner）IAM ロールが付与されています。このロールには、必要な権限がすべて含まれています。このセクションをスキップして、ユーザー管理のノートブック インスタンスの作成を開始します。プロジェクトを自分で作成していない場合は、このセクションに進んでください。

Vertex AI Workbench ユーザー管理ノートブック インスタンスの作成に必要な権限がユーザー アカウントに付与されるように、プロジェクトに対する次の IAM ロールをユーザー アカウントに付与するよう管理者に依頼してください。

• Notebooks 管理者（roles/notebooks.admin）
• サービス アカウント ユーザー（roles/iam.serviceAccountUser）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

管理者は、カスタムロールや他の事前定義ロールを使用して、必要な権限をユーザー アカウントに付与することもできます。

インスタンスを作成する

モニタリング指標の書き込み権限をサービス アカウントに付与する

新しいユーザー管理のノートブック インスタンスを作成したら、ユーザー管理のノートブック インスタンスのサービス アカウントにモニタリング指標書き込み権限（roles/monitoring.metricWriter）を付与します。詳細については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

Monitoring を使用してカスタム指標をモニタリングする

ユーザー管理のノートブック インスタンスでカスタム指標が有効になっている場合、Google Cloud Console でそのカスタム指標をモニタリングできます。

1. Google Cloud コンソールで、[ユーザー管理のノートブック] ページに移動します。

   [ユーザー管理のノートブック] に移動

2. カスタム指標を表示するインスタンス名をクリックします。

3. [ノートブックの詳細] ページで、[モニタリング] タブをクリックします。インスタンスのカスタム指標を確認します。

インスタンスに Monitoring をインストールする

このオプションを使用すると、Monitoring が自動的にインストールされます。インストールには 256 MB のディスク容量が必要です。指標を Monitoring に報告するには、インターネット接続が必要です。

インスタンスによるシステム指標とアプリケーション指標の報告方法

ユーザー管理のノートブック インスタンスに Cloud Monitoring をインストールしてシステム指標とアプリケーション指標を報告するには、ユーザー管理のノートブック インスタンスを作成するときに、[Cloud Monitoring エージェントをインストールする] をオンにする必要があります。これらの指標は、report-notebook-metrics メタデータ設定が有効になっているときに報告されるカスタム指標とは異なります。

システム指標とアプリケーション指標を Monitoring に報告するユーザー管理のノートブック インスタンスを作成する

ユーザー管理のノートブック インスタンスに Monitoring をインストールするには、Google Cloud コンソールまたは Google Cloud CLI を使用します。

準備

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Notebooks API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Notebooks API.

   Enable the API

8. ユーザー管理のノートブック インスタンスで GPU を使用する場合は、Google Cloud コンソールの [割り当て] ページで、プロジェクトに使用できる GPU が十分であることを確認してください。GPU が [割り当て] ページのリストにない場合や、さらに GPU 割り当てが必要な場合は、割り当て量の増加をリクエストしてください。Compute Engine のリソースの割り当てページの割り当て量の増加をリクエストするをご覧ください。

必要なロール

プロジェクトを作成した場合、そのプロジェクトに対するオーナー（roles/owner）IAM ロールが付与されています。このロールには、必要な権限がすべて含まれています。このセクションをスキップして、ユーザー管理のノートブック インスタンスの作成を開始します。プロジェクトを自分で作成していない場合は、このセクションに進んでください。

Vertex AI Workbench ユーザー管理ノートブック インスタンスの作成に必要な権限がユーザー アカウントに付与されるように、プロジェクトに対する次の IAM ロールをユーザー アカウントに付与するよう管理者に依頼してください。

• Notebooks 管理者（roles/notebooks.admin）
• サービス アカウント ユーザー（roles/iam.serviceAccountUser）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

管理者は、カスタムロールや他の事前定義ロールを使用して、必要な権限をユーザー アカウントに付与することもできます。

インスタンスを作成する

Monitoring を使用してシステムとアプリケーションの指標をモニタリングする

ユーザー管理のノートブック インスタンスに Monitoring がインストールされている場合、Google Cloud Console を使用して、システムとアプリケーションの指標をモニタリングできます。

1. Google Cloud コンソールで、[ユーザー管理のノートブック] ページに移動します。

   [ユーザー管理のノートブック] に移動

2. システムとアプリケーションの指標を表示するインスタンス名をクリックします。

3. [ノートブックの詳細] ページで、[モニタリング] タブをクリックします。インスタンスのシステム指標とアプリケーション指標を確認します。 これらの指標の解釈方法については、リソース指標を確認するをご覧ください。

診断ツールを使用してシステムの状態をモニタリングする

ユーザー管理のノートブック インスタンスには、インスタンスのシステム状態のモニタリングに役立つ診断ツールが組み込まれています。

診断ツールで実行されるタスク

この診断ツールは次のタスクを行います。

• ユーザー管理ノートブックの次のコアサービスのステータスを確認します。

  • Docker サービス
  • Docker リバース プロキシ エージェント
  • Jupyter サービス
  • Jupyter API

• ブートディスクとデータディスクのディスク容量が 85% のしきい値を超えているかどうかを確認します。

• lsof をインストールします（インターネット接続が必要）。

• 次のインスタンス ログを収集します。

  • ネットワーク情報（ifconfig、netstat）
  • /var/log/ フォルダ内のログ
  • Docker のステータス情報
  • lsof（開いているファイル）のデータ
  • Docker サービスのステータス
  • プロキシ リバース エージェントのステータス
  • Jupyter サービスのステータス
  • Jupyter API のステータス
  • プロキシ エージェント構成ファイル
  • Python プロセス

• 次のコマンドを実行して、結果を収集します。

  • pip freeze
  • conda list
  • gcloud compute instances describe INSTANCE_NAME
  • gcloud config list

診断ツールを実行します。

診断ツールの実行手順は次のとおりです。

1. SSH を使用して、ユーザー管理のノートブック インスタンスに接続します。

2. SSH ターミナルで、次のコマンドを実行します。

   sudo -i
   cd /opt/deeplearning/bin/
   ./diagnostic_tool.sh

   診断ツールがログを収集し、.tar.gz ファイルに圧縮して、/tmp/ フォルダに配置します。

3. ファイルを展開して、内容を評価します。次の内容が含まれます。

   • log フォルダ: var/log/ フォルダのログ
   • report.log: 収集されたすべてのコマンドの出力
   • proxy-agent-config.json: プロキシ構成情報
   • Docker ログ: Docker コンテナログを含む -json.log ファイル

診断ツールには以下のオプションがあります。

次のステップ

• VM メタデータの詳細を確認する。

• Monitoring の詳細を確認する。