cloudprofiler2 命令行界面（CLI）允许您从终端舒适地使用Google Cloud Profiler服务的大多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接重定向到文件，而不受您的shell功能限制。错误将打印到标准错误，并导致程序退出代码不为零。

如果请求数据结构，则这些结构将作为格式化的JSON返回，以便作为其他工具的输入。

有关Cloud Profiler API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-cloudprofiler2-cli

在GitHub上找到源代码。

用法

此文档是从修订版 20240219 的Cloud Profiler API生成的。CLI版本为 5.0.4。

cloudprofiler2 [options]
        projects
                profiles-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                profiles-create-offline <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                profiles-list <parent> [-p <v>]... [-o <out>]
                profiles-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudprofiler2 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中，文件名以cloudprofiler2-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数API需要用户对任何请求进行身份验证。如果是这种情况，范围确定授予的权限集。这些权限的粒度通常不超过只读或完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如，在调用只读方法时，它只会请求只读范围。您可以使用--scope标志直接指定范围。所有适用的范围都在相应方法的CLI文档中进行了说明。

第一次使用范围时，用户将被要求允许权限。根据CLI的指示授予权限或拒绝。

如果用户对作用域进行了认证，相关信息将被存储在配置目录中，格式为JSON，例如：~/.google-service-cli/cloudprofiler2-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用，并且有每日配额。

为了在不强迫任何人注册自己的应用程序的情况下更舒适地使用CLI，CLI自带默认应用程序密钥，并相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题：~/.google-service-cli/cloudprofiler2-secret.json，前提是已为它启用了所需的cloudprofiler API。此类密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON处下载并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽力提供可用的错误消息，但有时了解导致特定问题的确切原因可能是有益的。这是通过允许所有客户端服务器通信以原样输出到标准错误来实现的。

使用--debug标志将错误打印到标准错误，使用Debug表示法。

您可以考虑将标准错误重定向到文件，以便于使用，例如：cloudprofiler2 --debug <resource> <method> [options] 2>debug.txt。