如何调试调用Google Cloud API的Golang代码以排查运行异常

直接根因 #

你的代码运行无报错返回nil是正常现象：ListAllInstances方法的返回值是error类型，无异常时就返回nil。你把实例列表的输出内容全部写入了bytes.Buffer对象buf，但主函数里从未打印过buf的内容，自然看不到查询结果。

修正后的主函数代码 #

package main

import (
    "bytes"
    "fmt"

    "example.com/compute"
)

func main() {
    buf := new(bytes.Buffer)
    // 注意将第二个参数替换为你自己的实际项目ID
    err := compute.ListAllInstances(buf, "project-unique-id")
    // 先判断是否存在报错
    if err != nil {
        fmt.Printf("查询报错: %v\n", err)
        return
    }
    // 打印缓冲区中存储的实例查询结果
    fmt.Println("查询结果如下：")
    fmt.Println(buf.String())
}

其他可使用的调试手段 #

• 打印中间变量确认执行流程：在ListAllInstances的遍历循环中增加日志，打印每个可用区的实例数量len(pair.Value.Instances)，确认是API未返回实例，还是打印逻辑未触发
• 验证项目ID和凭证有效性：用gcloud工具执行gcloud compute instances list --project 你的项目ID，如果该命令能返回实例，说明凭证和项目ID无误，问题出在代码逻辑；如果命令返回空，说明项目确实无运行实例、或凭证无对应资源的访问权限
• 调整API请求参数：暂时删除MaxResults参数、增加过滤条件Filter: proto.String("status = RUNNING")，确认是否是分页规则或过滤逻辑导致结果为空
• 开启SDK调试日志：初始化客户端前添加代码os.Setenv("GOOGLE_SDK_GO_LOGGING_LEVEL", "debug")，可打印SDK发起的请求和收到的响应明细，直接确认API返回的原始数据内容

内容的提问来源于stack exchange，提问作者yung peso