跳转到主要内容

日志

状态：早期草案/提案

日志行​

版本：0.0

属性和字段要求​

  • 时间字段 - 必需
    • 名为 timestamp 的第一个时间字段是时间字段。
    • 它不能为空
  • 正文字段 - 必需
    • 名为 body 的第一个字符串字段是正文字段。
    • 它不能为空
  • 严重性字段 - 可选
    • 名为 severity 的第一个字符串字段是严重性字段。
    • 表示日志行的严重性/级别
    • 如果没有找到严重性字段，消费者/客户端将决定日志级别。例如：日志面板将尝试解析消息字段并确定日志级别
    • 日志级别可以是文档中指定的值之一 这里
  • ID字段 - 可选
    • 名为 id 的第一个字符串字段是ID字段。
    • 日志行的唯一标识符
  • 标签字段 - 可选
    • 名为 labels 的第一个字段是标签字段。
    • 该字段表示关于日志行的附加信息。
    • 字段类型必须是json原始消息类型。例如值：{}，{"hello":"world", "foo": 123.45, "bar" :["yellow","red"], "baz" : { "name": "alice" }}
      • 值应以Record<string,any>类型在javascript中表示。

日志可视化会忽略任何其他字段。

示例​

以下是一个go语言中的日志帧示例

data.NewFrame(
    "logs",
    data.NewField("timestamp", nil, []time.Time{time.UnixMilli(1645030244810), time.UnixMilli(1645030247027), time.UnixMilli(1645030247027)}),
    data.NewField("body", nil, []string{"message one", "message two", "message three"}),
    data.NewField("severity", nil, []string{"critical", "error", "warning"}),
    data.NewField("id", nil, []string{"xxx-001", "xyz-002", "111-003"}),
    data.NewField("labels", nil, []json.RawMessage{[]byte(`{}`), []byte(`{"hello":"world"}`), []byte(`{"hello":"world", "foo": 123.45, "bar" :["yellow","red"], "baz" : { "name": "alice" }}`)}),
)

这可以表示为

名称：timestamp
类型：[]time.Time		名称：body
类型：[]string		名称：severity
类型：[]*string		名称：id
类型：[]*string		名称：labels
类型：[]json.RawMessage
2022-02-16 16:50:44.810 +0000 GMT消息一关键xxx-001{}
2022-02-16 16:50:47.027 +0000 GMT消息二错误xyz-002{"hello":"world"}
2022-02-16 16:50:47.027 +0000 GMT消息三警告111-003{"hello":"world", "foo": 123.45, "bar"["yellow","red"], "baz" : { "name": "alice" }}

元数据要求​

  • 帧类型必须设置为 FrameTypeLogLines/log-lines
  • 帧元数据可以可选地指定 preferredVisualisationType:logs 作为元数据。如果没有此属性，探索页面将以表格形式而不是日志视图来渲染日志数据

无效情况​

  • 没有时间字段的帧
  • 没有字符串字段的帧
  • 字段名为 "tsNs"，其中 "tsNs" 字段类型不是数字的帧