monitoring3 命令行界面（CLI）允许您从终端轻松使用Google Monitoring服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以使用标志将其直接重定向到文件，而与shell的能力无关。错误将打印到标准错误，并导致程序的退出代码不为零。

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

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

安装和源代码

使用cargo通过以下命令安装命令行界面：

cargo install google-monitoring3-cli

在GitHub上找到源代码。

用法

此文档是根据Monitoring API的修订版20220218生成的。CLI的版本为3.1.0。

monitoring3 [options]
        folders
                time-series-list <name> [-p <v>]... [-o <out>]
        organizations
                time-series-list <name> [-p <v>]... [-o <out>]
        projects
                alert-policies-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                alert-policies-delete <name> [-p <v>]... [-o <out>]
                alert-policies-get <name> [-p <v>]... [-o <out>]
                alert-policies-list <name> [-p <v>]... [-o <out>]
                alert-policies-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                collectd-time-series-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                groups-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                groups-delete <name> [-p <v>]... [-o <out>]
                groups-get <name> [-p <v>]... [-o <out>]
                groups-list <name> [-p <v>]... [-o <out>]
                groups-members-list <name> [-p <v>]... [-o <out>]
                groups-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                metric-descriptors-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                metric-descriptors-delete <name> [-p <v>]... [-o <out>]
                metric-descriptors-get <name> [-p <v>]... [-o <out>]
                metric-descriptors-list <name> [-p <v>]... [-o <out>]
                monitored-resource-descriptors-get <name> [-p <v>]... [-o <out>]
                monitored-resource-descriptors-list <name> [-p <v>]... [-o <out>]
                notification-channel-descriptors-get <name> [-p <v>]... [-o <out>]
                notification-channel-descriptors-list <name> [-p <v>]... [-o <out>]
                notification-channels-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                notification-channels-delete <name> [-p <v>]... [-o <out>]
                notification-channels-get <name> [-p <v>]... [-o <out>]
                notification-channels-get-verification-code <name> (-r <kv>)... [-p <v>]... [-o <out>]
                notification-channels-list <name> [-p <v>]... [-o <out>]
                notification-channels-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                notification-channels-send-verification-code <name> (-r <kv>)... [-p <v>]... [-o <out>]
                notification-channels-verify <name> (-r <kv>)... [-p <v>]... [-o <out>]
                time-series-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                time-series-create-service <name> (-r <kv>)... [-p <v>]... [-o <out>]
                time-series-list <name> [-p <v>]... [-o <out>]
                time-series-query <name> (-r <kv>)... [-p <v>]... [-o <out>]
                uptime-check-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                uptime-check-configs-delete <name> [-p <v>]... [-o <out>]
                uptime-check-configs-get <name> [-p <v>]... [-o <out>]
                uptime-check-configs-list <parent> [-p <v>]... [-o <out>]
                uptime-check-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        services
                create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list <parent> [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                service-level-objectives-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                service-level-objectives-delete <name> [-p <v>]... [-o <out>]
                service-level-objectives-get <name> [-p <v>]... [-o <out>]
                service-level-objectives-list <parent> [-p <v>]... [-o <out>]
                service-level-objectives-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        uptime-check-ips
                list [-p <v>]... [-o <out>]
  monitoring3 --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文件中，这些文件以monitoring3-为前缀。您可以使用--config-dir标志根据每次调用更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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