协议版本: draft
用户交互模型
实现可以自由通过任何适合其需求的界面模式来公开日志记录——协议本身并不强制要求任何特定的用户交互模型。能力
发出日志消息通知的服务器 必须 声明logging 能力:
日志级别
该协议遵循RFC 5424中定义的标准系统日志严重性级别:| 级别 | 描述 | 使用案例 |
|---|---|---|
| 调试 | 详细调试信息 | 函数入口/出口点 |
| info | 通用信息消息 | 操作进度更新 |
| 通知 | 正常但重要的事件 | 配置更改 |
| 警告 | 警告条件 | 已弃用功能使用 |
| 错误 | 错误条件 | 操作失败 |
| critical | 严重状况 | 系统组件故障 |
| alert | 必须立即采取行动 | 检测到数据损坏 |
| emergency | 系统不可用 | 系统发生完全故障 |
协议消息
设置日志级别
要配置最低日志级别,客户端可以发送一个logging/setLevel请求:
请求:
日志消息通知
服务器使用notifications/message 通知发送日志信息:
消息流
错误处理
Servers 应当 return standard JSON-RPC errors for common failure cases:- 无效日志级别:
-32602(参数无效) - 配置错误:
-32603(内部错误)
实施注意事项
-
服务器 应当:
- 速率限制日志消息
- 在数据字段中包含相关上下文
- 使用一致的日志记录器名称
- 移除敏感信息
-
客户端 可以:
- 在用户界面中显示日志消息
- 实现日志过滤/搜索
- 视觉化显示严重性
- 持久化日志消息
安全性
-
日志信息不可包含:
- 凭据或密钥
- 个人身份信息
- 可能有助于攻击的内部系统细节
-
实现应当:
- 限制消息速率
- 验证所有数据字段
- 控制日志访问
- 监控敏感内容