cloudtrace1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Cloud Trace 服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其重定向到与您的 shell 功能无关的文件。错误将打印到标准错误，并导致程序退出代码非零。

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

关于 Cloud Trace API 的其他所有信息，请参阅 官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-cloudtrace1-cli

在 GitHub 上查找源代码。

用法

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

cloudtrace1 [options]
        projects
                patch-traces <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                traces-get <project-id> <trace-id> [-p <v>]... [-o <out>]
                traces-list <project-id> [-p <v>]... [-o <out>]
  cloudtrace1 --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 目录中，以 cloudtrace1- 为前缀的 JSON 文件中。您可以使用 --config-dir 标志在每次调用时更改用于存储配置的目录。

有关各种持久数据的更多信息，请参阅以下段落。

身份验证

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

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

首次使用作用域时，会询问用户权限。按照CLI给出的说明授予权限或拒绝。

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

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

应用程序密钥

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

为了让CLI使用更方便，而不必强迫任何人注册自己的应用程序，CLI自带了一个默认的应用程序密钥，并进行相应的配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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