操作指南

API 文档

JSON 格式

最近更新时间:2021-08-13 09:14:30

操作场景

JSON 格式日志会自动提取首层的 key 作为对应字段名,首层的 value 作为对应的字段值,以该方式将整条日志进行结构化处理,每条完整的日志以换行符\n为结束标识符。

前提条件

假设您的一条 JSON 日志原始数据为:

{"remote_ip":"10.135.46.111","time_local":"22/Jan/2019:19:19:34 +0800","body_sent":23,"responsetime":0.232,"upstreamtime":"0.232","upstreamhost":"unix:/tmp/php-cgi.sock","http_host":"127.0.0.1","method":"POST","url":"/event/dispatch","request":"POST /event/dispatch HTTP/1.1","xff":"-","referer":"http://127.0.0.1/my/course/4","agent":"Mozilla/5.0 (Windows NT 10.0; WOW64; rv:64.0) Gecko/20100101 Firefox/64.0","response_code":"200"}

经过日志服务结构化处理后,该条日志将变为如下:

agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:64.0) Gecko/20100101 Firefox/64.0
body_sent: 23
http_host: 127.0.0.1
method: POST
referer: http://127.0.0.1/my/course/4
remote_ip: 10.135.46.111
request: POST /event/dispatch HTTP/1.1
response_code: 200
responsetime: 0.232
time_local: 22/Jan/2019:19:19:34 +0800
upstreamhost: unix:/tmp/php-cgi.sock
upstreamtime: 0.232
url: /event/dispatch
xff: -

操作步骤

登录控制台

  1. 登录 日志服务控制台
  2. 在左侧导航栏中,单击【日志主题】,进入日志主题管理页面。

创建日志主题

  1. 单击【创建日志主题】。
  2. 在弹出的对话框中,将“日志主题名称”填写为“test-json”,单击【确定】,即可新增日志主题。如下图所示:屏幕快照 2021-03-11 上午12.19.14

机器组管理

  1. 日志主题创建成功后,进入该日志主题管理页面。
  2. 选择【采集配置】页签,单击您需要采集的日志数据源格式。
  3. 在“机器组管理”页面,勾选需要与当前日志主题进行绑定的机器组,单击【下一步】。
    即可进入采集配置阶段,更多详情请参阅 管理机器组

采集配置

配置日志文件采集路径

在“采集配置”页面,根据日志采集路径格式,填写“采集路径”。如下图所示:
日志采集路径格式:[目录前缀表达式]/**/[文件名表达式]
屏幕快照 2021-01-21 下午12.45.01
填写日志采集路径后,LogListener 会按照[目录前缀表达式]匹配所有符合规则的公共前缀路径,并监听这些目录(包含子层目录)下所有符合[文件名表达式]规则的日志文件。其参数详细说明如下:

字段 说明
目录前缀 日志文件前缀目录结构,仅支持通配符 * 和 ? ,* 表示匹配多个任意字符,? 表示匹配单个任意字符
/**/ 表示当前目录以及所有子目录
文件名 日志文件名,仅支持通配符 * 和 ? ,* 表示匹配多个任意字符,? 表示匹配单个任意字符

常用的配置模式如下:

  • [公共目录前缀]/**/[公共文件名前缀]*
  • [公共目录前缀]/**/*[公共文件名后缀]
  • [公共目录前缀]/**/[公共文件名前缀]*[公共文件名后缀]
  • [公共目录前缀]/**/*[公共字符串]*

填写示例如下:

序号 目录前缀表达式 文件名表达式 说明
1. /var/log/nginx access.log 此例中,日志路径配置为/var/log/nginx/**/access.log,LogListener 将会监听/var/log/nginx前缀路径下所有子目录中以access.log命名的日志文件
2. /var/log/nginx *.log 此例中,日志路径配置为/var/log/nginx/**/*.log,LogListener 将会监听/var/log/nginx前缀路径下所有子目录中以.log结尾的日志文件
3. /var/log/nginx error* 此例中,日志路径配置为/var/log/nginx/**/error*,LogListener 将会监听/var/log/nginx前缀路径下所有子目录中以error开头命名的日志文件
注意:

  • Loglistener 2.3.9及以上版本才可以添加多个采集路径。
  • 暂不支持上传的日志内容中含有多种文本格式,可能会导致写入失败,例如 key:"{"substream":XXX}"。
  • 建议配置采集路径为 log/*.log,rename日志轮转后的老文件命名为 log/*.log.xxxx
  • 默认情况下,一个日志文件只能被一个日志主题采集。如果一个文件需要对应多个采集配置,请给源文件添加一个软链接,并将其加到另一组采集配置中。

配置 JSON 模式

在“采集配置”页面,将“提取模式”设置为【JSON】。如下图所示:

配置采集策略

  • 全量采集:Loglistener 采集文件时,从文件的开头开始读。
  • 增量采集:Loglistener 采集文件时,从距离文件末尾1M处开始读取(若文件小于1M,等价全量采集)。

配置采集时间

说明:

  • 日志时间单位为:秒,若时间格式填写错误日志时间将以采集时间为准。
  • 日志的时间属性有两种方式来定义:采集时间和原始时间戳。
  • 采集时间:日志的时间属性由日志服务 CLS 采集该条日志的时间决定。
  • 原始时间戳:日志的时间属性由原始日志中时间戳决定。
  • 采集时间作为日志的时间属性:保持采集时间状态为开启状态即可。
  • 日志的原始时间戳作为日志时间属性:关闭采集时间状态,在时间键和时间格式解析处,填写原始时间戳的时间键以及对应的时间解析格式。时间解析格式详情参见 配置时间格式
    这里举例说明时间格式解析规则填写:
    例1:日志样例原始时间戳:10/Dec/2017:08:00:00,解析格式为:%d/%b/%Y:%H:%M:%S
    例2:日志样例原始时间戳:2017-12-10 08:00:00,解析格式为:%Y-%m-%d %H:%M:%S
    例3:日志样例原始时间戳:12/10/2017, 08:00:00,解析格式为:%m/%d/%Y, %H:%M:%S

配置过滤器条件

过滤器旨在您根据业务需要添加日志采集过滤规则,帮助您筛选出有价值的日志数据。过滤规则为 Perl 正则表达式,所创建的过滤规则为命中规则,即匹配上正则表达式的日志才会被采集上报。

对于 JSON 格式日志,可以根据所解析成的键值对配置过滤规则。例如,您希望原始 JSON 格式日志内容中 response_code 为400或500的所有日志数据被采集,那么 key 处配置 response_code,过滤规则处配置400|500。

注意:

多条过滤规则之间关系是"与"逻辑;若同一 key 名配置多条过滤规则,规则会被覆盖。

相关操作

检索日志

  1. 登录 日志服务控制台
  2. 在左侧导航栏中,单击【检索分析】,进入检索分析页面。
  3. 根据实际需求,选择地域、日志集与日志主题,单击【检索分析】,即可开始按照设定的查询条件检索日志。
目录