租户端 存储 日志服务（CLS） 操作指南 采集文本日志 完全正则格式

完全正则格式

最近更新时间: 2024-10-17 17:10:00

概述

完全正则模式指将一条完整日志按正则方式提取多个 key-value 的日志解析模式，若不需要提取 key-value，请参阅 单行全文采集 或 多行全文采集 进行配置。配置完全正则模式，您需先输入日志样例，其次自定义正则表达式，系统将根据正则表达式里的捕获组提取对应的 key-value。下面将为您详细介绍如何采集完全正则格式日志。

示例

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

10.135.46.111 - - [22/Jan/2019:19:19:30 +0800] "GET /my/course/1 HTTP/1.1" 127.0.0.1 200 782 9703 "http://127.0.0.1/course/explore?filter%5Btype%5D=all&filter%5Bprice%5D=all&filter%5BcurrentLevelId%5D=all&orderBy=studentNum" "Mozilla/5.0 (Windows NT 10.0; WOW64; rv:64.0) Gecko/20100101 Firefox/64.0"  0.354 0.354

配置的自定义正则表达式为：

(\S+)[^\[]+(\[[^:]+:\d+:\d+:\d+\s\S+)\s"(\w+)\s(\S+)\s([^"]+)"\s(\S+)\s(\d+)\s(\d+)\s(\d+)\s"([^"]+)"\s"([^"]+)"\s+(\S+)\s(\S+).*

则日志服务会根据()捕获组提取对应的 key-value，您可以自定义每组的 key 名称，如下所示。

body_bytes_sent: 9703
http_host: 127.0.0.1
http_protocol: HTTP/1.1
http_referer: http://127.0.0.1/course/explore?filter%5Btype%5D=all&filter%5Bprice%5D=all&filter%5BcurrentLevelId%5D=all&orderBy=studentNum
http_user_agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:64.0) Gecko/20100101 Firefox/64.0
remote_addr: 10.135.46.111
request_length: 782
request_method: GET
request_time: 0.354
request_url: /my/course/1
status: 200
time_local: [22/Jan/2019:19:19:30 +0800]
upstream_response_time: 0.354

注意：

完全正则目前只支持单行日志提取 key-value ，多行日志暂不支持提取，如需采集多行日志请参阅 多行全文采集 文档。

采集配置

登录控制台

登录日志服务控制台，在左侧导航栏中，单击【日志主题】。

新建 LogListener 采集

  1. 单击目标日志主题名称，进入主题详情基本信息页面。

  2. 单击【采集配置】页签，可新增LogListener采集规则。

  3. 在LogListener采集配置中，单击【新增】。

  4. 在日志数据源中，选择对应格式的日志数据源。

配置机器组

从机器组列表中选择目标机器组，将其与当前日志主题进行关联，值得注意的是，关联的机器组与日志主题所在的地域需保持一致。操作详情请参见 如何创建机器组 文档。

采集配置

配置采集路径

日志采集路径格式为 [目录前缀表达式]/**/[文件名表达式] ，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开头命名的日志文件

注意：

  1. 多层目录和通配符配置方式依赖2.2.2及以上版本的 loglistener。
  2. 一个日志文件只能被一个日志主题采集。
  3. LogListener 不支持监听软连接方式的日志文件和 NFS、CIFS 等共享文件目录上的日志文件。

配置日志提取模式

【提取模式】，选择【单行-完全正则】。

定义正则表达式

在完全正则模式下，系统将根据定义好的正则表达式提取 key-value，单击【自动生成】完成正则提取模式。如果无法自动生成，可以切换成手动方式进行正则模式验证。

  • 自动模式

    1. 输入日志样例。

    2. 单击【正则表达式自动生成】，根据检索分析需要，将一部分日志内容选中，输入Key值后，单击【确认提取】，下方显示提取结果。

    3. 重复上述步骤，直到生成所有需提取的 key-value。

    4. 单击【确定】，系统将日志分组生成正则提取模式。

  • 手动模式

    1. 输入日志样例。

    2. 手动输入正则提取表达式。

    3. 单击【验证】，系统将判断日志样例与正则表达式是否匹配。

说明：

无论是自动模式还是手动模式，一旦正则提取模式定义好并验证通过后，提取结果将会展示在下方，您需要对每一组 key-value 对定义好一个 key 名称，该名称会用于日志检索分析。

配置采集时间

  • 日志时间单位为：秒。

  • 日志的时间属性有两种方式来定义：采集时间和原始时间戳。

  • 采集时间：日志的时间属性由日志服务 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 正则表达式，所创建的过滤规则为命中规则，即匹配上正则表达式的日志才会被采集上报。

完全正则过来采集时，需要根据所自定义的键值对来配置过滤规则。例如，样例日志使用完全正则模式解析后，您希望 status 字段为 400 或 500 的所有日志数据被采集，那么 key 处配置 status，过滤规则处配置 400|500。

注意：

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

索引配置

配置日志索引信息，具体请参见 配置索引。

检索结果

  1. 登录日志服务控制台。

  2. 在左侧导航树中，选择【检索分析】。

  3. 在检索分析页面，选择日志集与日志主题，单击【检索分析】，即可开始按照设定的查询条件检索日志。

注意：

检索必须开启索引配置，否则无法进行检索。