协议修订版: draft
用户交互模型
实现可以自由地通过任何适合其需求的界面模式来暴露日志——协议本身并不强制要求任何特定的用户交互模型。能力
发出日志消息通知的服务器必须声明logging 能力:
日志级别
协议遵循 RFC 5424 中指定的标准 syslog 严重性级别:协议消息
设置日志级别
要配置最小日志级别,客户端可以发送logging/setLevel 请求:
请求:
日志消息通知
服务器使用notifications/message 通知发送日志消息:
消息流程
错误处理
服务器应该为常见故障情况返回标准的 JSON-RPC 错误:- 无效的日志级别:
-32602(无效参数) - 配置错误:
-32603(内部错误)
实现注意事项
-
服务器应该:
- 对日志消息进行速率限制
- 在数据字段中包含相关上下文
- 使用一致的记录器名称
- 移除敏感信息
-
客户端可以:
- 在 UI 中呈现日志消息
- 实现日志过滤/搜索
- 视觉上显示严重性
- 持久化日志消息
安全
-
日志消息不得包含:
- 凭据或秘密
- 个人识别信息
- 可能帮助攻击的内部系统细节
-
实现应该:
- 对消息进行速率限制
- 验证所有数据字段
- 控制日志访问
- 监控敏感内容