该 cloudtrace2 命令行界面（CLI）允许您从终端舒适地使用Google Cloud Trace服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudtrace2-cli

在GitHub上找到源代码。

用法

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

cloudtrace2 [options]
        projects
                traces-batch-write <name> (-r <kv>)... [-p <v>]... [-o <out>]
                traces-spans-create-span <name> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudtrace2 --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文件中，这些文件以cloudtrace2-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会要求用户授权。按照CLI提供的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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