使用日志分析作业

本文档介绍了如何为批处理作业启用、生成和查看 Cloud Logging 中的日志。

您可以使用日志获取对分析作业有用的相关信息。例如，日志可以帮助您调试失败的作业。

值得注意的是，只有在作业开始运行后，并且仅当为作业启用了日志记录功能时，才会生成日志。如果您需要分析没有日志的作业，请改为查看状态事件。

准备工作

  1. 如果您之前未使用过批处理功能，请参阅开始使用批处理，并完成适用于项目和用户的前提条件，以启用批处理功能。

  2. 如需获得使用日志分析作业所需的权限，请让您的管理员为您授予以下 IAM 角色：

    如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

    您也可以通过自定义角色或其他预定义角色来获取所需的权限。

为作业启用日志记录

如需允许为作业生成日志，请在创建作业时通过 Cloud Logging 启用日志：

  • 如果您使用 Google Cloud 控制台创建作业，则 Cloud Logging 中的日志始终处于启用状态。

  • 如果您使用 gcloud CLI 或批处理 API 创建作业，则 Cloud Logging 中的日志默认处于停用状态。如需启用 Cloud Logging 日志，请在创建作业时为 logsPolicy 字段添加以下配置：

    {
    ...
    "logsPolicy": {
        "destination": "CLOUD_LOGGING"
    }
    ...
}

为作业写入和生成日志

为作业启用 Cloud Logging 日志后，Cloud Logging 会自动生成为作业写入的所有日志。具体而言，批处理作业可以具有以下日志类型：

  • 代理日志 (batch_agent_logs)：Batch Service Agent 中的活动日志。

    批处理作业会自动为已启用日志记录功能的每个作业写入代理日志。

  • 任务日志 (batch_task_logs)：您配置作业的可运行项将数据写入标准输出 (stdout) 流或标准错误 (stderr) 流的任何数据的日志。

    您可以选择为启用了日志记录的每个作业写入任务日志。

查看作业的日志

您可以使用 Google Cloud 控制台、gcloud CLI、Logging API、Go、Java、Python 或 C++ 查看作业的日志。

控制台

如需使用 Google Cloud 控制台查看作业的日志，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 Job list（作业列表）页面。

    前往“作业列表”

  2. 在作业名称列中，点击作业的名称。 作业详情页面随即打开。

  3. 点击日志标签页。“批处理”会显示与作业关联的所有日志。

  4. 可选：如需过滤日志，请执行以下任一操作：

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"
}

替换以下内容：

Go

Go

如需了解详情，请参阅 批处理 Go API 参考文档。

如需向 Batch 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

import (
	"context"
	"fmt"
	"io"

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

// 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

Java

如需了解详情，请参阅 批处理 Java API 参考文档。

如需向 Batch 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

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

Python

如需了解详情，请参阅 批处理 Python API 参考文档。

如需向 Batch 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

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++

C++

如需了解详情，请参阅 批处理 C++ API 参考文档。

如需向 Batch 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。 

#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";
    }
  }

过滤批量日志

您可以编写包含以下一个或多个过滤参数以及零个或多个布尔运算符（AND、OR 和 NOT）的查询，以过滤出批处理日志。

  • 如需过滤特定作业中的日志，请指定作业的唯一 ID (UID)：

    labels.job_uid=JOB_UID

    其中，JOB_UID 是作业的 UID。如需获取作业的 UID，请查看作业的详细信息。

  • 如需过滤出特定类型的批处理日志，请指定日志类型：

    logName=projects/PROJECT_ID/logs/BATCH_LOG_TYPE

    替换以下内容：

    • PROJECT_ID：您要查看日志的项目的项目 ID。
    • BATCH_LOG_TYPE：您要查看的批处理日志的类型，对于任务日志为 batch_task_logs，对于代理日志为 batch_agent_logs。

  • 如需过滤包含自定义状态事件的日志，请指定日志必须定义 jsonPayload.batch/custom/event 字段：

    jsonPayload.batch"/"custom"/"event!=NULL_VALUE

  • 如需过滤出一个或多个特定严重级别的日志，请指定以下比较：

    severityCOMPARISON_OPERATORSEVERITY_ENUM

    替换以下内容：

如需了解更多过滤选项，请参阅 Cloud Logging 查询语言文档。

后续步骤