通过REST传递过滤日志消息的Flask端点
pbu-log-inspector的Python项目详细描述
PBU日志检查器
python-basic-utils原木的烧瓶(pip)和反应(npm)集成。在
安装
pip3 install pbu-log-inspector npm install pbu-log-inspector
集成
后端
^{pr2}$register_endpoint
函数将注册一个端点GET /api/_logs
,该端点可用于提供日常日志。
此功能还有其他可用参数:
register_endpoint(app,log_folder="_logs",api_prefix="/api",log_file_mapping=None,login_check=None)
- 默认的
log_folder
与应用程序的启动脚本相关,因为这是pbu
默认值。在 - 如果您提供不同的^{str1}$
api_prefix
这将只是前缀,而不是/_logs
部分。E、 g./rest
会 导致端点/rest/_logs
log_file_mapping
是可选的,并且只有在您指示{}写入不同的文件名时才是必需的 而不是默认值。当提供时,映射需要提供一个字典,其中包含表示默认pbu日志的键 文件名(信息日志, 调试日志, 警告.log, 错误.log)它们各自的值是中的日志文件的名称 你的应用程序。在 - 如果应用程序包含身份验证,请通过
login_check
参数提供一个函数,该函数执行 身份验证。没有参数传递给函数。您可以使用from flask import request
并访问所有请求 数据
限制
- 日期必须是日志消息的第一部分
- 日期的格式必须是
%Y-%m-%d %H:%M:%S.%s
,例如2019-12-25 13:37:01.567
- 端点交付的日志数量没有限制。这很容易导致较大的有效载荷,并可能超过 操作限制(例如浏览器性能、响应大小等)
前端
importReactfrom"react"importLogInspectorContainerfrom"pbu-log-inspector"constMyContainer=props=>(<div><LogInspectorContainer/></div>)
容器提供以下属性:
apiPrefix
-默认"/api"
-对应于Flask后端配置的api_prefix
参数applyRequestOptions
-默认null
-一个接受基本请求参数并必须返回 获取请求的参数,以防需要身份验证并需要设置标头errorHandler
-默认值null
-在获取日志时处理错误的函数(例如,显示警报),否 ^应为{}。参数是引发的错误。在
- 项目
标签: