Skip to content

Latest commit

 

History

History
171 lines (155 loc) · 7.69 KB

regex-accelerate.md

File metadata and controls

171 lines (155 loc) · 7.69 KB

正则加速

简介

processor_regex_accelerate processor插件通过正则匹配以加速模式实现文本日志的字段提取。

备注：该插件目前仅支持与输入插件file_log和输出插件flusher_sls配套使用，且不得与其它加速插件混用。

配置参数

参数 类型 是否必选 说明
Type String 是 插件类型，指定为processor_regex_accelerate。
Keys Array 是 提取的字段名列表。
Regex String 是 提取字段的正则表达式，使用()标注待提取的字段。
LogBeginRegex String 否 行首正则表达式，仅当待采集日志为多行日志时使用。
FilterKey Array 否 用于过滤日志的字段。仅当该字段的值与FilterRegex参数中对应设置的正则表达式匹配时，对应的日志才会被采集。
FilterRegex Array 否，当FilterKey参数不为空时必选 日志字段过滤的正则表达式。该参数元素个数必须与FilterKey参数的元素个数相同。
TimeFormat String 否 日志时间格式，仅当Keys参数中有“time”字段时有效，用于对“time”字段的值进行解析。未配置该字段时，默认使用系统时间作为日志时间。具体信息参见表1。
EnablePreciseTimestamp Boolean 否 是否提取高精度时间。如果未添加该参数，则默认使用false，表示不提取高精度时间。
PreciseTimestampKey String 否 保存高精度时间戳的字段。如果未添加该参数，则默认使用precise_timestamp字段。
PreciseTimestampUnit String 否 高精度时间戳的单位，取值包括ms（毫秒）、us（微秒）、ns（纳秒）。如果未添加该参数，则默认为ms。
AdjustTimezone Boolean 否 是否调整日志时区。仅当TimeFormat参数有效时有效。如果未添加该参数，则默认使用false，表示使用机器时区。
LogTimezone String 否 时区偏移量，格式为GMT+HH:MM（东区）、GMT-HH:MM（西区）。仅当AdjustTimezone参数值为false时有效。
EnableRawLog Boolean 否 是否上传原始日志。如果未添加该参数，则默认使用false，表示不上传原始日志。
DiscardUnmatch Boolean 否 是否丢弃匹配失败的日志。如果未添加该参数，则默认使用true，表示丢弃匹配失败的日志。
MergeType String 否 日志聚合方式。可选值包括“topic”和“logstore”。如果未添加该参数，则默认使用topic，表示根据topic聚合。
SensitiveKeys Map<String, Object> 否 脱敏功能，具体信息参见表2。
  • 表1:时间格式
时间格式 说明 示例
%a 星期的缩写。 Fri
%A 星期的全称。 Friday
%b 月份的缩写。 Jan
%B 月份的全称。 January
%d 每月第几天，十进制，范围为01~31。 07, 31
%h 月份的缩写，等同于%b。 Jan
%H 小时，24小时制。 22
%I 小时，12小时制。 11
%m 月份，十进制，范围为01~12。 08
%M 分钟，十进制，范围为00~59。 59
%n 换行符。 换行符
%p AM或PM。 AM、PM
%r 12小时制的时间组合，等同于%I:%M:%S %p。 11:59:59 AM
%R 小时和分钟组合，等同于%H:%M。 23:59
%S 秒数，十进制，范围为00~59。 59
%t Tab符号，制表符。 无
%y 年份，十进制，不带世纪，范围为00~99。 04、98
%Y 年份，十进制。 2004、1998
%C 世纪，十进制，范围为00~99。 16
%e 每月第几天，十进制，范围为1~31。如果是个位数字，前面需要加空格。 7、31
%j 一年中的天数，十进制，范围为001~366。 365
%u 星期几，十进制，范围为1~7，1表示周一。 2
%U 每年的第几周，星期天是一周的开始，范围为00~53。 23
%V 每年的第几周，星期一是一周的开始，范围为01~53。如果一月份刚开始的一周>=4天，则认为是第1周，否则认为下一个星期是第1周。 24
%w 星期几，十进制，范围为0~6，0代表周日。 5
%W 每年的第几周，星期一是一周的开始，范围为00~53。 23
%c 标准的日期和时间。 Tue Nov 20 14:12:58 2020
%x 标准的日期，不带时间。 Tue Nov 20 2020
%X 标准的时间，不带日期。 11:59:59
%s Unix时间戳。 1476187251
  • 表2:脱敏信息
参数名称 数据类型 是否必填 示例值 描述
key String 是 content 日志字段名称。
type String 是 const 脱敏方式。可选值如下：
- const：将敏感内容替换成const字段取值内容。
- md5：将敏感内容替换为其对应的MD5值。
regex_begin String 是 'password':' 敏感内容前缀的正则表达式，用于查找敏感内容。使用RE2语法。
regex_content String 是 [^']* 敏感内容的正则表达式，使用RE2语法。
all Boolean 是 true 是否替换该字段中所有的敏感内容。可选值如下：
- true（推荐）：替换。
- false：只替换字段中匹配正则表达式的第一部分内容。
const String 否 "********" 当type设置为const时，必须配置。

样例

单行日志采集

采集/home/test-log/路径下的reg.log文件，日志内容按照提取字段。

  • 输入

127.0.0.1 - - [07/Jul/2022:10:43:30 +0800] "POST /PutData?Category=YunOsAccountOpLog" 0.024 18204 200 37 "-" "aliyun-sdk-java"' >> /home/test-log/reg.log

  • 采集配置
enable: true
inputs:
  - Type: file_log
    LogPath: /home/test-log/
    FilePattern: reg.log
processors:
  - Type: processor_regex_accelerate
    Keys:
    - ip
    - time
    - method
    - url
    - request_time
    - request_length
    - status
    - length
    - ref_url
    - browser
    Regex: ([\d\.]+) \S+ \S+ \[(\S+) \S+\] \"(\w+) ([^\\"]*)\" ([\d\.]+) (\d+) (\d+) (\d+|-) \"([^\\"]*)\" \"([^\\"]*)\"
flushers:
  - Type: flusher_sls
    Endpoint: cn-xxx.log.aliyuncs.com
    ProjectName: test_project
    LogstoreName: test_logstore
  • 输出
{
    "__tag__:__path__": "/home/test-log/reg.log",
    "ip": "127.0.0.1",
    "time": "07/Jul/2022:10:43:30",
    "method": "POST",
    "url": "/PutData?Category=YunOsAccountOpLog",
    "request_time": "0.024",
    "request_length": "18204",
    "status": "200",
    "length": "37",
    "ref_url": "-",
    "browser": "aliyun-sdk-java",
    "__time__": "1657161810"
}

多行日志采集

采集/home/test-log/路径下的regMulti.log文件，日志内容按照提取字段。

  • 输入
[2022-07-07T10:43:27.360266763]	[INFO]	java.lang.Exception: exception happened
    at com.aliyun.sls.devops.logGenerator.type.RegexMultiLog.f2(RegexMultiLog.java:108)
    at java.base/java.lang.Thread.run(Thread.java:833)
  • 采集配置
enable: true
inputs:
  - Type: file_log
    LogPath: /home/test-log/
    FilePattern: regMulti.log
processors:
  - Type: processor_regex_accelerate
    Keys:
    - time
    - level
    - msg
    Regex: \[(\S+)]\s\[(\S+)]\s(.*)
    LogBeginRegex: \[\d+-\d+-\w+:\d+:\d+,\d+]\s\[\w+]\s.*
flushers:
  - Type: flusher_sls
    Endpoint: cn-xxx.log.aliyuncs.com
    ProjectName: test_project
    LogstoreName: test_logstore
  • 输出
{
    "__tag__:__path__": "/home/test-log/regMulti.log",
    "time": "2022-07-07T10:43:27.360266763",
    "level": "INFO",
    "msg": "java.lang.Exception: exception happened
    at com.aliyun.sls.devops.logGenerator.type.RegexMultiLog.f2(RegexMultiLog.java:108)
    at java.base/java.lang.Thread.run(Thread.java:833)",
    "__time__": "1657161807"
}