21个稳定版本 (4个主要版本)
5.0.4+20190325 | 2024年3月5日 |
---|---|
3.1.0+20190325 | 2022年4月26日 |
3.0.0+20190325 | 2022年3月8日 |
2.0.4+20190325 | 2021年4月14日 |
0.3.6+20160322 | 2016年9月11日 |
#1763 in 网络编程
每月455次下载
385KB
5K SLoC
该logging2-beta1
命令行界面(CLI)允许您从终端方便地使用Google Logging服务的大多数功能。
默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接定向到文件,而无需考虑shell的能力。错误将打印到标准错误,并导致程序退出代码非零。
如果请求数据结构,则这些结构将作为格式化的JSON返回,以便作为其他工具的输入。
有关Logging API的所有其他信息,请参阅官方文档网站。
安装和源代码
使用cargo安装命令行界面:
cargo install google-logging2_beta1-cli
用法
本文档是根据修订版20190325的Logging API生成的。CLI的版本为5.0.4。
logging2-beta1 [options]
entries
list (-r <kv>)... [-p <v>]... [-o <out>]
write (-r <kv>)... [-p <v>]... [-o <out>]
monitored-resource-descriptors
list [-p <v>]... [-o <out>]
projects
metrics-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
metrics-delete <metric-name> [-p <v>]... [-o <out>]
metrics-get <metric-name> [-p <v>]... [-o <out>]
metrics-list <parent> [-p <v>]... [-o <out>]
metrics-update <metric-name> (-r <kv>)... [-p <v>]... [-o <out>]
sinks-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
sinks-delete <sink-name> [-p <v>]... [-o <out>]
sinks-get <sink-name> [-p <v>]... [-o <out>]
sinks-list <parent> [-p <v>]... [-o <out>]
sinks-update <sink-name> (-r <kv>)... [-p <v>]... [-o <out>]
logging2-beta1 --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文件中,文件名以logging2-beta1-
开头。您可以使用--config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落中提供了有关各种类型持久数据的更多信息。
身份验证
大多数API需要用户对任何请求进行身份验证。如果是这样,则范围确定授予的权限集。这些权限的粒度通常不超过只读或完全访问。
如果没有设置,系统将自动选择最小的可行范围,例如,当调用只读方法时,它只会请求只读范围。您可以使用--scope
标志直接指定范围。所有适用的范围均在相应方法的CLI文档中有记录。
当第一次使用作用域时,会要求用户授权。按照CLI的指示授权或拒绝。
如果用户已对作用域进行了认证,相应的信息将以JSON格式存储在配置目录中,例如:~/.google-service-cli/logging2-beta1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,需要使用Google开发者控制台进行注册。然后逐个启用应用程序可能使用的API。大多数API可以免费使用,并设有每日配额。
为了在不强迫用户注册自己的应用程序的情况下更方便地使用CLI,CLI自带了一个默认应用程序密钥,并相应地进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过将自定义密钥文件放置在此位置来解决这个问题:~/.google-service-cli/logging2-beta1-secret.json
,假设已为它启用了所需的logging API。此类密钥文件可以从Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误信息,但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原始格式输出到标准错误来实现的。
--debug
标志将以Debug
表示形式将错误打印到标准错误。
您可以考虑将标准错误重定向到文件以方便使用,例如:logging2-beta1 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–31MB
~580K SLoC