ログを使用してジョブを分析する

このページでは、ジョブの Cloud Logging からログを有効にして表示する方法について説明します。

ログを使用して、ジョブの分析に役立つ情報を取得できます。たとえば、失敗したジョブのログをデバッグできます。ジョブに対して Cloud Logging が有効になっている場合、Cloud Logging で次のタイプのログが生成されます。

タスクログ（batch_task_logs）: 標準出力（stdout）および標準エラー（stderr）ストリームに書き込まれたデータのログ。ジョブのタスクログを生成するには、分析とデバッグのためのデータをこれらのストリームに書き込むようにタスクを構成します。
エージェントログ（batch_agent_logs）: Batch サービスエージェントのアクティビティのログ。Batchでは、ジョブのログが自動的に生成されます。

Cloud Logging は、ジョブの実行開始後にのみログを生成します。ジョブが開始されたかどうかを確認するには、ジョブの詳細を表示し、ジョブの状態が RUNNING または、それ以降であることを確認します。ログを生成しなかったジョブを分析する必要がある場合（たとえば、ジョブがRUNNING状態以前に失敗）、gcloud CLI または Batch API を使用してジョブの詳細を表示し、statusEventsフィールドを確認します。

準備

Batch を以前に使用したことがなかった場合は、Batch を使ってみるを確認し、プロジェクトとユーザーの前提条件を完了して Batch を有効にします。
ログを使用してジョブを分析するために必要な権限を取得するには、管理者に次の IAM のロールを付与するように依頼してください。
- ログを有効にしてジョブを作成するには: プロジェクトのバッチジョブ編集者（roles/batch.jobsEditor）
- ログを表示するには: プロジェクトのログビューア（roles/logging.viewer）
ロールの付与の詳細については、アクセスの管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

ジョブのログを有効にする

ジョブのログを生成するには、ジョブの作成時に Cloud Logging を有効にします。

Google Cloud Console を使用してジョブを作成すると、Cloud Logging が常に有効になります。
gcloud CLI または Batch API を使用してジョブを作成する場合、Cloud Logging はデフォルトで無効になっています。Cloud Logging を有効にするには、ジョブの作成時に次の構成を logsPolicy フィールドに含めます。
```
{
    ...
    "logsPolicy": {
        "destination": "CLOUD_LOGGING"
    }
    ...
}
```

ジョブのログを表示する

ジョブのログは、Google Cloud コンソール、gcloud CLI、Logging API、Go、Java、Python、C++ を使用して表示できます。

コンソール

Google Cloud コンソールを使用してジョブのログを表示する手順は次のとおりです。

Google Cloud コンソールで、[ジョブリスト] ページに移動します。

ジョブリストに移動する
[ジョブ名] 列で、ジョブの名前をクリックします。ジョブの詳細ページが開きます。
[ログ] タブをクリックします。バッチによって、ジョブに関連付けられているすべてのログが表示されます。
省略可: ログをフィルタリングするには、次のいずれかを行います。
- 　Filterフィールドに　filter を入力します。
- [重大度] リストで、[重大度] を選択します。
- ログエクスプローラで表示をクリックして、バッチフィルタパラメータを使用して、ログエクスプローラのクエリを作成するにします。

gcloud

gcloud CLI を使用してログを表示するには、gcloud logging read コマンドを使用します。

gcloud logging read "QUERY"

QUERY は、バッチフィルタパラメータを含むバッチログのクエリです。

API

Logging API を使用してログを表示するには、entries.list メソッドを使用します。

POST https://logging.googleapis.com/v2/entries:list
{
    "resourceNames": [
        "projects/PROJECT_ID"
    ],
    "filter": "QUERY"
    "orderBy": "timestamp desc"
}

以下を置き換えます。

PROJECT_ID: プロジェクトのプロジェクト ID。
QUERY: バッチフィルタパラメータを含むバッチログのクエリ。

Go

詳細については、Batch Go API のリファレンスドキュメントをご覧ください。

Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

GitHub で表示フィードバック

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/logging"
	"cloud.google.com/go/logging/logadmin"
	"google.golang.org/api/iterator"
	batchpb "google.golang.org/genproto/googleapis/cloud/batch/v1"
)

// Retrieve the logs written by the given job to Cloud Logging
func printJobLogs(w io.Writer, projectID string, job *batchpb.Job) error {
	// projectID := "your_project_id"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	adminClient, err := logadmin.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("Failed to create logadmin client: %w", err)
	}
	defer adminClient.Close()

	const name = "batch_task_logs"

	iter := adminClient.Entries(ctx,
		// Only get entries from the "batch_task_logs" log for the job with the given UID
		logadmin.Filter(fmt.Sprintf(`logName = "projects/%s/logs/%s" AND labels.job_uid=%s`, projectID, name, job.Uid)),
	)

	var entries []*logging.Entry

	for {
		logEntry, err := iter.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("unable to fetch log entry: %w", err)
		}
		entries = append(entries, logEntry)
		fmt.Fprintf(w, "%s\n", logEntry.Payload)
	}

	fmt.Fprintf(w, "Successfully fetched %d log entries\n", len(entries))

	return nil
}

Java

詳細については、Batch Java API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import com.google.cloud.batch.v1.Job;
import com.google.cloud.logging.v2.LoggingClient;
import com.google.logging.v2.ListLogEntriesRequest;
import com.google.logging.v2.LogEntry;
import java.io.IOException;

public class ReadJobLogs {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project hosting the job.
    String projectId = "YOUR_PROJECT_ID";

    // The job which logs you want to print.
    Job job = Job.newBuilder().build();

    readJobLogs(projectId, job);
  }

  // Prints the log messages created by given job.
  public static void readJobLogs(String projectId, Job job) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `loggingClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (LoggingClient loggingClient = LoggingClient.create()) {

      ListLogEntriesRequest request = ListLogEntriesRequest.newBuilder()
          .addResourceNames(String.format("projects/%s", projectId))
          .setFilter(String.format("labels.job_uid=%s", job.getUid()))
          .build();

      for (LogEntry logEntry : loggingClient.listLogEntries(request).iterateAll()) {
        System.out.println(logEntry.getTextPayload());
      }
    }
  }
}

Python

詳細については、Batch Python API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

from __future__ import annotations

from typing import NoReturn

from google.cloud import batch_v1
from google.cloud import logging

def print_job_logs(project_id: str, job: batch_v1.Job) -> NoReturn:
    """
    Prints the log messages created by given job.

    Args:
        project_id: name of the project hosting the job.
        job: the job which logs you want to print.
    """
    # Initialize client that will be used to send requests across threads. This
    # client only needs to be created once, and can be reused for multiple requests.
    log_client = logging.Client(project=project_id)
    logger = log_client.logger("batch_task_logs")

    for log_entry in logger.list_entries(filter_=f"labels.job_uid={job.uid}"):
        print(log_entry.payload)

C++

詳細については、Batch C++ API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

#include "google/cloud/batch/v1/batch_client.h"
#include "google/cloud/logging/v2/logging_service_v2_client.h"
#include "google/cloud/location.h"
#include "google/cloud/project.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id) {
    auto const project = google::cloud::Project(project_id);
    auto const location = google::cloud::Location(project, location_id);
    auto const name = location.FullName() + "/jobs/" + job_id;
    auto batch = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto job = batch.GetJob(name);
    if (!job) throw std::move(job).status();

    auto logging = google::cloud::logging_v2::LoggingServiceV2Client(
        google::cloud::logging_v2::MakeLoggingServiceV2Connection());
    auto const log_name = project.FullName() + "/logs/batch_task_logs";
    google::logging::v2::ListLogEntriesRequest request;
    request.mutable_resource_names()->Add(project.FullName());
    request.set_filter("logName=\"" + log_name +
                       "\" labels.job_uid=" + job->uid());
    for (auto l : logging.ListLogEntries(request)) {
      if (!l) throw std::move(l).status();
      std::cout << l->text_payload() << "\n";
    }
  }

バッチログをフィルタする

Batch ログをフィルタするには、次のフィルタパラメータ 1 つ以上と、0 個以上のブール演算子（AND、OR、NOT）を含むクエリを作成します。

特定のジョブのログをフィルタリングするには、ジョブの一意の ID（UID）を指定します。
```
labels.job_uid=JOB_UID
```
ここで、JOB_UID はジョブの UID です。ジョブの UID を取得するには、ジョブの詳細を表示します。
特定のタイプの Batch ログをフィルタするには、ログタイプを指定します。
```
logName=projects/PROJECT_ID/logs/BATCH_LOG_TYPE
```
以下を置き換えます。
- PROJECT_ID: ログを表示するプロジェクトのプロジェクト ID。
- BATCH_LOG_TYPE: 表示する Batch ログのタイプ（タスクログの場合は batch_task_logs、エージェントログの場合は batch_agent_logs）。

次のステップ

トラブルシューティングの詳細を確認する。
Cloud Logging の詳細を確認する。
ジョブの削除とエクスポートの方法を確認する。