操作指南

API 文档

日志检索

最近更新时间:2020-07-06 20:05:33

操作场景

当部署组关联了日志配置项后,TSF 会对采集的日志数据实时建立索引。用户可以在 TSF 控制台中,通过日志检索功能使用关键词检索出关键日志信息。

操作步骤

  1. 登录 TSF 控制台,单击左侧导航栏【日志服务】>【日志检索】。
  2. 选择搜索的时间范围。
  3. 选择日志数据源
    • 日志配置项:日志配置项决定了日志格式、日志采集路径等规则;
    • 部署组:从关联了日志配置项的部署组中进行选择;
    • 实例:当选择单个部署组时,可以将数据源范围精细化到部署组内某个实例。
  4. 选择排序方式,默认是【按关键词匹配度排序】。
  5. 输入日志关键词,单击【查询】。
    关键词搜索包含三种查询方式:基本查询Lucene 语法查询正则表达式。用户可根据需求自行进行选择。在选定其一查询方式后,输入关键字。
  6. 单击【查看日志上下文】,查看该条日志的上下文信息。
    说明:

    时间范围选择组件的结束时间为进入日志检索页面的时间。

关键词查询

基本查询

输入待查询的关键词或短语,按下回车键,输入下一个待查询的关键词或短语,按下回车,直至全部输入完成。单击【查询】,日志列表将展示出所有符合条件的日志。
本查询方式默认将任意空白字符,.[]{}()?:=认定为分词符,含有上述符号的日志被按照分隔符所在位置拆分。例如org.apache.kafka.clients.NetworkClient将被分词为org apache kafka clients NetworkClient

  • 支持单词的搜索
    例如:输入available,输出日志为所有含有单词available的日志。
  • 支持短语的搜索
    例如:输入Broker may not be available,输出日志为所有含有短语Broker may not be available的日志。

Lucene 语法查询

支持检索类型 规则 示例
全文检索-单词检索 输入单个词语进行搜索,精准输出所有包含该词语的日志 startup
全文检索-短语检索 输入双引号“”囊括短语进行搜索,精准输出所有包含该短语的日志 startup
布尔表达式搜索 支持 A AND B 搜索,输出所有同时包含 A 和 B 的日志;支持 A OR B 搜索,输出所有含有 A 或所有含有 B 或同时含有 A 和 B 的日志;支持 A NOT B 搜索,输出所有含有 A 同时不含有 B 的日志;支持 +A,输出所有包含 Term 的日志;支持 -A,输出的日志不包含 A -
通配符搜索 支持 ? 搜索,?可匹配单个字符; 支持 * 搜索,* 可匹配0到多个字符 -
模糊搜索 支持 A~Beta(数值) 启动模糊搜索,输出包含所有距离 A 相似度为 Beta 的单词的日志。该模糊检索查询出拼写错误的单词 -
优先级搜索 支持 A^beta(数值) B 搜索,使 A 的搜索优先级相较于 B 提高 Beta -
转义特殊字符 以下字符当作值搜索时需要用\转义:
+- = && | > < ! ( ) { } [] ^ " ~ * ? : \ /
(1+1)\=2用来查询(1+1)=2

正则表达式查询

支持使用正则表达式对日志进行搜索。
例如:搜索形如以 p 开头 r 结尾的关键词,我们可以直接在搜索框内输入/p.*r/进行匹配。

目录