このドキュメントでは、Ops エージェントを自動的にインストールする Batch ジョブを作成して実行する方法について説明します。Ops エージェントをインストールして、ジョブのリソースのパフォーマンスに関する追加の指標を Cloud Monitoring に提供します。ジョブのリソース パフォーマンス指標の使用の詳細については、指標を表示してジョブリソースをモニタリングして最適化するをご覧ください。
始める前に
- Batch を以前に使用したことがない場合は、Batch を使ってみるを確認し、プロジェクトとユーザーの前提条件を完了して Batch を有効にします。
- プロジェクトで Cloud Monitoring API と Cloud Logging API がまだ有効になっていない場合は、有効にします。
-
ジョブの作成に必要な権限を取得するには、次の IAM ロールを付与するよう管理者に依頼してください。
-
ジョブを作成するには:
-
プロジェクトのバッチジョブ編集者(
roles/batch.jobsEditor
) -
ジョブのサービス アカウントのサービス アカウント ユーザー(
roles/iam.serviceAccountUser
)。デフォルトでは Compute Engine のデフォルトのサービス アカウントです。
-
プロジェクトのバッチジョブ編集者(
-
ログを表示するには:
プロジェクトに対するログビューア(
roles/logging.viewer
)
ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
-
ジョブを作成するには:
ジョブのサービス アカウントのデフォルト構成を使用している場合を除き、必要な権限があることを確認します。
ジョブのサービス アカウントに Ops エージェントの指標を Monitoring に書き込むために必要な権限があることを確認するには、ジョブのサービス アカウントに次の IAM ロールを付与するよう管理者に依頼してください。
-
プロジェクトに対するMonitoring 指標の書き込み(
roles/monitoring.metricWriter
) -
プロジェクトに対するログ書き込み (
roles/logging.logWriter
)
-
プロジェクトに対するMonitoring 指標の書き込み(
- 計画されたジョブ構成が Ops エージェントの要件を満たしていることを確認します。
Ops エージェントの要件
Ops エージェントを使用するジョブを作成して実行するには、ジョブが次のすべての要件を満たしている必要があります。
ジョブの VM が Ops エージェントがサポートするオペレーティング システム(OS)を使用していることを確認します。 ジョブの VM OS イメージの詳細については、ジョブの VM OS 環境の概要をご覧ください。
ジョブでデフォルト以外のネットワーキング構成が使用されているか、VPC Service Controls を使用している場合は、ジョブが Ops エージェントのアクセス要件を満たしていることを確認します。詳細については、Google Cloud Observability ドキュメントのリモート パッケージ アクセスを使用しない VM をご覧ください。
ジョブがカスタム イメージやインスタンス テンプレートなどを使用して、以前の Cloud Logging エージェントや Cloud Monitoring エージェントをインストールしていないことを確認します。
Ops エージェントの機能と要件の詳細については、Google Cloud Observability ドキュメントの Ops エージェントの概要をご覧ください。
Ops エージェントを自動的にインストールするジョブを作成する
Google Cloud CLI または REST API を使用して、installOpsAgent
フィールドを含むジョブを作成し、JSON ファイルの本文の allocationPolicy.instances
フィールドに true
を設定します。
"allocationPolicy": {
"instances": [
{
"installOpsAgent": true
}
]
}
たとえば、Ops エージェントを自動的にインストールするジョブには、次のような JSON 構成ファイルを含めることができます。
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"script": {
"text": "echo Hello World! This is task $BATCH_TASK_INDEX."
}
}
]
},
"taskCount": 3,
}
],
"allocationPolicy": {
"instances": [
{
"installOpsAgent": true
}
]
},
"logsPolicy": {
"destination": "CLOUD_LOGGING"
}
}
ジョブの VM の実行が開始されると、他のリソース指標と同じように Ops エージェントの指標が表示されます。詳細については、指標を表示したジョブリソースのモニタリングと最適化をご覧ください。
次のステップ
- ジョブの作成または実行に問題がある場合は、トラブルシューティングをご覧ください。
- ジョブとタスクを表示する。
- 別のジョブ作成オプションについて学習する。