有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

操作场景

JSON 提取模式适用于日志文本中每行内容为一条原始日志,且每条日志可按 JSON 解析规则提取为多个 key-value 键值的日志解析模式。若不需要提取 key-value,请参见 单行全文格式 进行配置。本文为您介绍如何使用 JSON 提取模式采集日志。

前提条件

目标文件所在服务器已安装 LogListener。详情请参见:
LogListener Linux 版本为2.4.5以上或 LogListener Windows 版本为2.9.7及以上。

效果预览

假设您的一条 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)在左侧导航栏中,单击概览,进入概览页面。
(3)在快速接入中,找到并单击 JSON-文件日志,进入采集配置流程。



(4)在采集配置流程的创建日志主题页面,根据实际需求,输入日志主题名称,配置日志保存时间等信息,单击下一步



如果您想选择现有的日志主题,可执行如下操作:
(1)登录 日志服务控制台
(2)在左侧导航栏中,单击日志主题,选择需要投递的日志主题,单击日志主题名称,进入日志主题管理页面。
(3)选择采集配置页签,在 LogListener 采集配置栏下单击新增,进入日志数据源选择。



(4)在日志数据源选择页面中,找到并单击 JSON-文件日志,进入采集配置流程。




步骤二:管理机器组

完成日志主题新建或选择之后,单击下一步进入采集配置流程 - 机器组管理页面。



若您需要采集的目标服务器未安装 LogListener, 可参见:
如果您想创建新的机器组,可执行如下操作:
(1)单击新建机器组,并在机器组创建弹窗中,通过 IP 或者机器标识的方式关联已安装 LogListener 的目标服务器。详情请参见机器组






(2)完成创建后,在 Tab 选项中选择您创建的机器组的系统环境,并在列表中找到您创建的机器组。



如果您想选择现有的机器组,可执行如下操作:
在 Tab 选项中选择目标机器组的系统环境,并在列表中找到您的目标机器组。




步骤三:采集配置

配置日志文件采集路径




在“采集配置”页面,填写采集规则名称,并根据日志采集路径格式填写“采集路径”。日志采集路径格式参考如下:
注意:
Linux日志路径必须以/开头。 Windows文件路径必须以盘符开头,如C:\\
Linux系统中的日志路径:/[目录前缀表达式]/**/[文件名表达式],例如:/data/log/**/*.log
Windows系统中的日志路径:[盘符]:\\[目录前缀表达式]\\**\\[文件名表达式],例如:C:\\Program Files\\Tencent\\...\\*.log
填写日志采集路径后,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开头命名的日志文件
注意
Windows 系统环境暂不支持软链采集。
Loglistener 2.3.9及以上版本才可以添加多个采集路径。
建议配置采集路径为 log/*.log,rename 日志轮转后的老文件命名为 log/*.log.xxxx
默认情况下,一个日志文件只能被一个日志主题采集。如果一个文件需要对应多个采集配置,且文件所在系统环境为 Linux,请给源文件添加一个软链接,并将其加到另一组采集配置中。

配置采集路径黑名单

开启采集路径黑名单,可在采集时忽略指定的目录前缀或完整的文件路径。目录路径和文件路径可以是完全匹配,也支持通配符模式匹配。



采集黑名单分为两类过滤类型,且可以同时使用:
文件路径:采集路径下,需要忽略采集的完整文件路径,支持通配*或?,支持**路径模糊匹配。
目录路径:采集路径下,需要忽略采集的目录前缀,支持通配*或?,支持**路径模糊匹配。
注意:
需要 LogListener 2.3.9及以上版本。
采集黑名单是在采集路径下进行排除,因此无论是文件路径模式,还是目录路径模式,其指定路径要求为采集路径的子集。

配置采集策略

全量采集:Loglistener 采集文件时,从文件的开头开始读。
增量采集:Loglistener 采集文件时,只采集文件内新增的内容。

配置回溯采集

注意:
Windows 系统环境暂不支持。
当采集策略选择为增量采集时,您可进一步在回溯采集中指定当 LogListener 启动采集时,是否从最新的位置往前偏移指定字节的位置开始采集。

编码模式

UTF-8:若您的日志文件编码模式为 UTF-8, 请选择该选项。
GBK:若您的日志文件编码模式为 GBK, 请选择该选项。

配置 JSON 模式

注意:
LogListener 仅解析一层 JSON,更深层次的 JSON 解析请通过 索引配置
采集配置页面,将“提取模式”设置为 JSON。如下图所示:



配置自定义元数据

注意:
Windows 系统环境暂不支持。
Loglistener 2.8.7及以上版本才可以配置自定义元数据。
您可配置自定义元数据,可以用来区分日志。当前支持以下几种元数据配置。详情请参见 自定义元数据
机器组元数据:使用机器组元数据。
采集路径:通过正则提取采集路径中的值作为元数据。
自定义:自定义键值作为元数据。

配置日志时间戳来源

您可选择以下两种时间作为日志的时间戳:
指定日志字段:使用日志中指定字段的值作为日志的时间,并填写该值对应的时间解析格式。例如:日志中代表时间的值为10/Dec/2017:08:00:00.000,解析格式为:%d/%b/%Y:%H:%M:%S.%f。更多请参考 配置时间格式



注意:
若时间格式填写错误日志时间将以采集时间为准。
日志采集时间:使用日志采集的时间作为日志时间。




配置过滤器条件

过滤器的目的是根据业务需要添加日志采集过滤规则,以帮助您筛选出有价值的日志数据。
对于 JSON 格式日志,可以根据所解析成的键值对配置过滤条件。支持以下过滤规则:
等于:仅采集指定字段值匹配指定字符的日志。支持完全匹配,或正则匹配。
不等于:仅采集指定字段值不匹配指定字符的日志。支持完全匹配,或正则匹配。
字段存在:仅采集指定字段存在的日志。
字段不存在:仅采集指定字段不存在的日志。
例如,您希望原始 JSON 格式日志内容中 response_code 为400或500的所有日志数据被采集,那么 key 处配置 response_code,过滤规则选择等于,value 处配置400|500。
注意
Windows 系统环境暂不支持。
过滤规则 “不等于”、“字段存在”以及“字段不存在” 仅在 LogListener 2.9.3及以上版本支持。
多条过滤条件之间关系是"与"逻辑,若同一 key 名配置多条过滤条件,规则会被覆盖。

配置上传解析失败日志

建议开启上传解析失败日志。开启后,Loglistener 会上传各式解析失败的日志。若关闭上传解析失败日志,则会丢弃失败的日志。

开启后需要配置解析失败的 Key 值(默认为 LogParseFailure),所有解析失败的日志,均以输入内容作为键名称(Key),原始日志内容作为值(Value)进行上传。

高级配置

注意:
Windows 系统环境暂不支持。
通过勾选,选择您需要定义的高级配置。



JSON提取模式下,支持配置以下高级配置:
名称
描述
配置项
超时属性
该配置控制日志文件的超时时间。如果一个日志文件在指定时间内没有任何更新,则为超时。超时的日志文件 LogListener 将不再采集。当您的日志文件数量较大时,建议降低超时时间,避免 LogListener 性能浪费
不超时:日志文件用不超时
自定义:自定义日志文件的超时时间
最大目录深度
采集路径中的/**/代表查找所有子目录中的文件。但是,在查找过程中,如果不想搜索太深的目录,可以使用"最大目录深度"配置项来限制搜索深度
大于0的整数。 0代表不进行子目录的下钻

步骤四:索引配置

1. 单击下一步,进入索引配置页面。
2. 在“索引配置”页面,设置如下信息。配置详情请参考 索引配置



注意
检索必须开启索引配置,否则无法检索。
3. 单击提交,完成采集配置。

相关操作

检索日志,请参见 检索分析 文档。