#google-cloud #google #google-api #命令行界面 #cloudmonitoring

app google-cloudmonitoring2_beta2-cli

与Cloud Monitoring(协议v2beta2)交互的完整库

20个稳定版本 (4个主要版本)

5.0.4+20170501 2024年3月5日
3.1.0+20170501 2022年4月26日
2.0.4+20170501 2021年4月14日
1.0.14+20170501 2020年7月10日
0.3.6+20160718 2016年9月11日

#102 in #google-cloud

Download history 1/week @ 2024-05-20 8/week @ 2024-07-01

454 每月下载量

MIT 许可证

240KB
3K SLoC

cloudmonitoring2-beta2命令行界面(CLI)允许您从终端舒适地使用Google Cloud Monitoring服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudmonitoring2_beta2-cli

GitHub上查找源代码

用法

本文档是从Cloud Monitoring API的20170501修订版生成的。CLI的版本为5.0.4

cloudmonitoring2-beta2 [options]
        metric-descriptors
                create <project> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <metric> [-p <v>]... [-o <out>]
                list <project> (-r <kv>)... [-p <v>]... [-o <out>]
        timeseries
                list <project> <metric> <youngest> (-r <kv>)... [-p <v>]... [-o <out>]
                write <project> (-r <kv>)... [-p <v>]... [-o <out>]
        timeseries-descriptors
                list <project> <metric> <youngest> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudmonitoring2-beta2 --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文件中,以cloudmonitoring2-beta2-为前缀。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,用户将被要求授权。按照CLI的说明授权权限,或拒绝授权。

如果某个作用域已被用户验证,相应的信息将被存储在配置目录中,格式为JSON,例如:~/.google-service-cli/cloudmonitoring2-beta2-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的验证,请参阅官方文档

应用程序密钥

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

为了便于使用CLI,而无需强迫任何人注册自己的应用程序,CLI自带默认应用程序密钥,并相应地配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

--debug标志将以Debug表示形式将错误打印到标准错误。

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

依赖关系

~20–31MB
~577K SLoC