tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
日志服务
    文档
    Download PDF

    使用 JSON 提取模式采集日志

    最后更新时间：2024-01-20 17:14:28
    下载PDF

      操作场景

      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”，单击确定，即可新增日志主题。

      机器组管理

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

      采集配置

      配置日志文件采集路径

      在“采集配置”页面，填写采集规则名称，并根据日志采集路径格式填写“采集路径”。如下图所示： 日志采集路径格式：[目录前缀表达式]/**/[文件名表达式]。
      填写日志采集路径后，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。
      默认情况下，一个日志文件只能被一个日志主题采集。如果一个文件需要对应多个采集配置，请给源文件添加一个软链接，并将其加到另一组采集配置中。

      配置采集策略

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

      配置 JSON 模式

      在“采集配置”页面，将“提取模式”设置为 JSON。

      配置采集时间

      说明：
      日志时间单位为：秒，若时间格式填写错误日志时间将以采集时间为准。
      日志的时间属性有两种方式来定义：采集时间和原始时间戳。
      采集时间：日志的时间属性由日志服务 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 名配置多条过滤规则，规则会被覆盖。

      配置上传解析失败日志

      建议开启上传解析失败日志。开启后，Loglistener 会上传各式解析失败的日志。若关闭上传解析失败日志，则会丢弃失败的日志。
      开启后需要配置解析失败的 Key 值（默认为 LogParseFailure），所有解析失败的日志，均以输入内容作为键名称（Key），原始日志内容作为值（Value）进行上传。

      索引配置

      1. 单击下一步，进入“索引配置”页面。
      2. 在“索引配置”页面，设置如下信息。
      索引状态：确认是否开启。
      注意：
      检索必须开启索引配置，否则无法检索。
      全文索引：确认是否需要设置大小写敏感。
      全文分词符：默认关闭，确认是否需要开启。
      键值索引：默认开启，您可按需进行字段类型、分词符以及是否开启统计分析的配置。若您需要关闭键值索引，可将
      
      设置为
      
      。
      3. 单击提交，完成采集配置。

      相关操作

      检索日志，请参见 检索分析 文档。
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款