openfin日志管理服务的cli
oflog的Python项目详细描述
openfin日志管理cli
概述
openfin日志管理cli允许用户通过命令行与日志管理服务交互。启用日志管理的应用程序将对其日志进行加密,并在rvm关闭后上载到日志管理服务。此cli可用于列出按应用程序名称和/或桌面存储的日志,并下载和解密这些日志文件,以便应用程序提供程序可以读取这些日志文件并将其用于调试目的。
假设
以下是使用cli工具的要求:
- 必须安装Python2.7。
- 运行
pip install oflog
安装cli工具。
功能
- 列出应用程序名,并列出给定应用程序名的桌面ID。
- 列出给定应用程序的日志。
- 从日志管理服务下载并解密压缩文件。
升级
- 要升级到新版本,请运行
pip install --upgrade oflog
开始
文件结构
- openfin_log_cli.py:cli工具入口点。
- config.ini:包含默认配置信息的文件,包括日志管理器URL、API密钥和私钥文件。
配置
运行oflog --configure
,并回答提示输入基本url、api密钥和私钥以配置cli。配置存储在~/.openfin/config.ini
使用量
所有命令都从日志管理服务返回json响应。
所有命令至少需要在config.ini或参数--base-url
或--api-key
中配置基url和api密钥。要下载日志,还必须在config.ini或参数--private-key
中配置PEM格式的RSA私钥文件。
如果在config.ini文件中和作为命令行参数提供了上述配置项,则将优先使用命令行参数。
命令
oflog --get-app-names
:列出所有应用程序名。oflog --get-app-desktops --app-name <name>
:列出给定应用程序名称的所有桌面。oflog --get-desktop-logs --app-name <name> --desktop-id <id>
:列出给定应用程序名/桌面组合的所有日志。oflog --get-logs --app-name <name>
:获取给定应用程序名的所有日志。oflog --download-log <log-id>
:下载具有给定id的日志,并使用提供的私钥文件对其进行解密。
其他参数
--start-date
:导致--get-logs
和--get-desktop-logs
仅显示超过该开始日期的日志。--end-date
:导致--get-logs
和--get-desktop-logs
仅显示该结束日期之前的日志。可与--start-date
一起使用。--private-key
:pem形式的rsa私钥的位置,用于解密日志。此标志重写config.ini中设置的私钥。--base-url
:api调用的基url。此标志覆盖config.ini中设置的URL。--api-key
:api调用的api键。此标志重写config.ini中设置的API密钥。--version
:显示cli工具的版本。--help
:显示命令和参数的描述。
贡献
这是一个开源项目,鼓励所有人都参与其中。
发展
您可以通过运行openfin_log_cli.py
文件替换oflog
来测试本地所做的任何更改(例如,像这样调用cli:python log_manager_cli\openfin_log_cli.py <args>
)。
许可证
此项目使用Apache2 license。 通过下载openfin,您同意我们的Developer License条款。
支架
如有任何疑问或问题,请在回购协议中输入问题。或者,请致电support@openfin.co