下载个人资料数据

本文档介绍了如何将配置数据下载到本地系统，以及如何使用 Go 应用以编程方式检索配置数据。

使用 Google Cloud 控制台下载配置文件

如需下载火焰图中显示的性能剖析文件，请点击下载 。

Profiler 对下载的文件使用以下命名惯例：

profiler_[SERVICE_NAME]_[PROFILE_TYPE]_[FROM_DATE]_[TO_DATE]_[ZONE]_[VERSION].pb.gz

在此表达式中：

  • SERVICE_NAME 包含您选定的服务
  • PROFILE_TYPE 包含您选定的性能剖析文件类型
  • FROM_DATE 和 TO_DATE 包含您指定的时间范围
  • ZONE 包含您选定的地区
  • VERSION 包含您选定的版本

示例：profiler_docdemo-service_HEAP_2018-04-22T20_25_31Z_2018-05-22T20_25_31Z_us-east1-c.pb.gz

以编程方式下载配置文件

如需检索配置数据，请使用 ListProfiles API 方法。以下 Go 程序示例演示了如何使用此 API。

示例程序会在其运行目录中创建一个文件夹，并生成一组编号的 pprof 文件。每个文件的命名惯例都与 profile000042.pb.gz 类似。每个目录都包含配置数据和一个元数据文件 - metadata.csv，其中包含有关下载文件的信息。


// Sample export shows how ListProfiles API can be used to download
// existing pprof profiles for a given project from GCP.
package main

import (
	"bytes"
	"context"
	"encoding/csv"
	"encoding/json"
	"flag"
	"fmt"
	"io"
	"log"
	"os"
	"time"

	cloudprofiler "cloud.google.com/go/cloudprofiler/apiv2"
	pb "cloud.google.com/go/cloudprofiler/apiv2/cloudprofilerpb"
	"google.golang.org/api/iterator"
)

var project = flag.String("project", "", "GCP project ID from which profiles should be fetched")
var pageSize = flag.Int("page_size", 100, "Number of profiles fetched per page. Maximum 1000.")
var pageToken = flag.String("page_token", "", "PageToken from a previous ListProfiles call. If empty, the listing will start from the begnning. Invalid page tokens result in error.")
var maxProfiles = flag.Int("max_profiles", 1000, "Maximum number of profiles to fetch across all pages. If this is <= 0, will fetch all available profiles")

const ProfilesDownloadedSuccessfully = "Read max allowed profiles"

// This function reads profiles for a given project and stores them into locally created files.
// The profile metadata gets stored into a 'metdata.csv' file, while the individual pprof files
// are created per profile.
func downloadProfiles(ctx context.Context, w io.Writer, project, pageToken string, pageSize, maxProfiles int) error {
	client, err := cloudprofiler.NewExportClient(ctx)
	if err != nil {
		return err
	}
	defer client.Close()
	log.Printf("Attempting to fetch %v profiles with a pageSize of %v for %v\n", maxProfiles, pageSize, project)

	// Initial request for the ListProfiles API
	request := &pb.ListProfilesRequest{
		Parent:    fmt.Sprintf("projects/%s", project),
		PageSize:  int32(pageSize),
		PageToken: pageToken,
	}

	// create a folder for storing profiles & metadata
	profilesDirName := fmt.Sprintf("profiles_%v", time.Now().Unix())
	if err := os.Mkdir(profilesDirName, 0750); err != nil {
		log.Fatal(err)
	}
	// create a file for storing profile metadata
	metadata, err := os.Create(fmt.Sprintf("%s/metadata.csv", profilesDirName))
	if err != nil {
		return err
	}
	defer metadata.Close()

	writer := csv.NewWriter(metadata)
	defer writer.Flush()

	writer.Write([]string{"File", "Name", "ProfileType", "Target", "Duration", "Labels"})

	profileCount := 0
	// Keep calling ListProfiles API till all profile pages are fetched or max pages reached
	profilesIterator := client.ListProfiles(ctx, request)
	for {
		// Read individual profile - the client will automatically make API calls to fetch next pages
		profile, err := profilesIterator.Next()

		if err == iterator.Done {
			log.Println("Read all available profiles")
			break
		}
		if err != nil {
			return fmt.Errorf("error reading profile from response: %w", err)
		}
		profileCount++

		filename := fmt.Sprintf("%s/profile%06d.pb.gz", profilesDirName, profileCount)
		err = os.WriteFile(filename, profile.ProfileBytes, 0640)

		if err != nil {
			return fmt.Errorf("unable to write file %s: %w", filename, err)
		}
		fmt.Fprintf(w, "deployment target: %v\n", profile.Deployment.Labels)

		labelBytes, err := json.Marshal(profile.Labels)
		if err != nil {
			return err
		}

		err = writer.Write([]string{filename, profile.Name, profile.Deployment.Target, profile.Duration.String(), string(labelBytes)})
		if err != nil {
			return err
		}

		if maxProfiles > 0 && profileCount >= maxProfiles {
			fmt.Fprintf(w, "result: %v", ProfilesDownloadedSuccessfully)
			break
		}

		if profilesIterator.PageInfo().Remaining() == 0 {
			// This signifies that the client will make a new API call internally
			log.Printf("next page token: %v\n", profilesIterator.PageInfo().Token)
		}
	}
	return nil
}

func main() {
	flag.Parse()
	// validate project ID
	if *project == "" {
		log.Fatalf("No project ID provided, please provide the GCP project ID via '-project' flag")
	}
	var writer bytes.Buffer
	if err := downloadProfiles(context.Background(), &writer, *project, *pageToken, *pageSize, *maxProfiles); err != nil {
		log.Fatal(err)
	}
	log.Println("Finished reading all profiles")
}

示例程序接受以下命令行参数：

  • project：要从中检索配置文件的项目。必填。
  • page_size：每次 API 调用检索的个人资料数量上限。page_size 的最大值为 1000。如果未指定，此字段会设为 100。
  • page_token：上次运行该程序时生成的字符串令牌，用于恢复下载。可选。
  • max_profiles：要检索的配置文件的数量上限。如果提供非正整数，则程序会尝试检索所有配置文件。
    可选。

运行示例应用

如需运行示例应用，请执行以下操作：

  1. 克隆代码库：

    git clone https://github.com/GoogleCloudPlatform/golang-samples.git

  2. 切换到包含示例程序的目录：

    cd golang-samples/profiler/export

  3. 将 YOUR_GCP_PROJECT 替换为您的 Google Cloud 项目的 ID 后，运行该程序：

    go run main.go -project YOUR_GCP_PROJECT -page_size 1000 -max_profiles 10000

该程序可能需要很长时间才能完成。该程序会在检索当前页面后输出下一页的令牌。如果程序被中断，您可以使用令牌来恢复该进程。

查看已下载的配置文件

如需读取以序列化协议缓冲区格式写入的下载文件，请使用开源 pprof 工具。