Fluentd日志采集使用教程

fluentd是何方神圣

fluentd是一个实时的数据收集系统，不仅可以收集日志，还可以收集定期执行的命令输出和HTTP请求内容。数据被收集后按照用户配置的解析规则，形成一系列event。每一个event包含如下内容：

tag = xxx
time = xxx
record = {
    "key1": "value1",
    "key2": "value2"
}

其中：

• tag：为数据流的标记。fluentd中可以具有多个数据源，解析器，过滤器和数据输出。他们之前使用tag来对应。类似于数据流按照tag分组。数据流向下游的时候只会进入tag相匹配的处理器。
• time：event产生的时间，该字段通常由日志内的时间字段解析出来。
• record：日志的内容，为JSON格式。

fluentd支持多种数据的解析过滤和输出操作。其中常用的有：

• tail输入：增量读取日志文件作为数据源，支持日志滚动。
• exec输入：定时执行命令，获取输出解析后作为数据源。
• syslog输出：解析标准的syslog日志作为输入。
• forward输入：接收其他fluentd转发来的数据作为数据源。
• dummy：虚拟数据源，可以定时产生假数据，用于测试。
• regexp解析器：使用正则表达式命名分组的方式提取出日志内容为JSON字段。
• record_transformer过滤器：人为修改record内的字段。
• file输出：用于将event落地为日志文件。
• stdout：将event输出到stdout。如果fluentd以daemon方式运行，输出到fluentd的运行日志中。
• forward：转发event到其他fluentd节点。
• copy：多路输出，复制event到多个输出端。
• kafka：输出event到Kafka。
• webhdfs：输出event到HDFS。
• elasticsearch：输出event到HDFS。

接下来以官网介绍为基础，穿插自己的理解，介绍下fluentd的使用方法。

安装启动方法

官网安装步骤链接：https://docs.fluentd.org/installation/install-by-rpm

下面是精简的在CentOS下的安装步骤。打开shell，执行如下命令：

curl -L https://toolbelt.treasuredata.com/sh/install-redhat-td-agent3.sh | sh

systemctl start td-agent

可以安装并启动fluentd。

配置文件位置

编辑fluentd配置文件的方法：

vim /etc/td-agent/td-agent.conf

修改运行用户和组

默认来说fluentd使用td-agent用户启动。如果需要修改fluentd的用户，需要执行：

vim /usr/lib/systemd/system/td-agent.service

文件内容如下所示：

[Unit]
Description=td-agent: Fluentd based data collector for Treasure Data
Documentation=https://docs.treasuredata.com/articles/td-agent
After=network-online.target
Wants=network-online.target

[Service]
User=td-agent
Group=td-agent
LimitNOFILE=65536
Environment=LD_PRELOAD=/opt/td-agent/embedded/lib/libjemalloc.so
Environment=GEM_HOME=/opt/td-agent/embedded/lib/ruby/gems/2.4.0/
Environment=GEM_PATH=/opt/td-agent/embedded/lib/ruby/gems/2.4.0/
Environment=FLUENT_CONF=/etc/td-agent/td-agent.conf
Environment=FLUENT_PLUGIN=/etc/td-agent/plugin
Environment=FLUENT_SOCKET=/var/run/td-agent/td-agent.sock
Environment=TD_AGENT_LOG_FILE=/var/log/td-agent/td-agent.log
Environment=TD_AGENT_OPTIONS=
EnvironmentFile=-/etc/sysconfig/td-agent
PIDFile=/var/run/td-agent/td-agent.pid
RuntimeDirectory=td-agent
Type=forking
ExecStart=/opt/td-agent/embedded/bin/fluentd --log $TD_AGENT_LOG_FILE --daemon /var/run/td-agent/td-agent.pid $TD_AGENT_OPTIONS
ExecStop=/bin/kill -TERM ${MAINPID}
ExecReload=/bin/kill -HUP ${MAINPID}
Restart=always
TimeoutStopSec=120

[Install]
WantedBy=multi-user.target

修改Service部分User和Group配置项可以更改fluentd进程的用户和组。

检测配置文件是否正确的方法

在shell中运行：

/opt/td-agent/embedded/bin/fluentd -c /etc/td-agent/td-agent.conf

观察输出，如果有错误会给出对应提示。

数据流逻辑

fluentd以tag值为基准，决定数据的流经哪些处理器。

数据的流向为：source -> parser -> filter -> output

input配置

tail

增量读取日志文件。需要提供一个用于标记已经读取到位置的文件（position file）所在的路径。

tail针对日志滚动的支持：
tail方式采用跟踪文件inode的方式进行。比如日志名为app.log，如果日志发生滚动，被重命名为app.log.1。文件重命名的时候inode是不会改变的。因此发生滚动时写入到旧文件末尾的日志也可以被收集到。tail会跟踪旧文件的inode一段时间（rotate_wait配置），这段时间过去之后，tail不再监听app.log.1，开始监听新的app.log文件。

tail方式的示例配置：

  @type tail
  path /var/log/httpd-access.log
  pos_file /var/log/td-agent/httpd-access.log.pos
  tag apache.access
  
    @type apache2
  

注意：如果文件发生修改会输出全量文件内容。

配置项解释

tag：数据源的tag值。*号可以扩展为path（/替换为.）。例如

path /path/to/file
tag foo.*

tag会被扩展为foo.path.to.file

path：配置读取的路径。可以使用*或者是strftime。例如：

path /path/to/%Y/%m/%d/*

如果今天是2020年1月2日，fluentd会读取/path/to/2020/01/02目录下的内容。
也可以配置多个路径，使用逗号分隔：

path /path/to/a/*,/path/to/b/c.log

exclude_path：排除部分目录或文件，使用数组格式配置。

path /path/to/*
exclude_path ["/path/to/*.gz", "/path/to/*.zip"]

refresh_interval：多长时间刷新一次文件监听列表，配合*使用才有意义。

pos_file：位置文件地址。这个文件保存了监听的日志文件已经读取到第几行。该项一定要配置。
注意，不要再多个source之间共用pos file，否则会出现问题。
pos_file_compaction_interval：pos file文件压缩时间间隔。用于压缩pos file中不再监听的记录，不可解析的记录以及重复的记录。

parse标签：用于指定log的解析器（必须的配置项）。
例如：

# json

  @type json


# regexp

  @type regexp
  expression ^(?[^ ]*) (?[^ ]*) (?\d*)$

path_key：如果配置此项，监控文件的path会在event中，此项的key为path_key。
例如：

path /path/to/access.log
path_key tailed_path

生成的数据如下所示：

{"tailed_path":"/path/to/access.log","k1":"v1",...,"kN":"vN"}

rotate_wait：日志发生滚动的时候，可能会有部分日志仍然输出在旧的日志文件，此时需要保持监听旧日志文件一段时间，这个时间配置就是rotate_wait。

exec

周期性执行命令，抽取命令输出为event。

示例配置：

  @type exec
  command cmd arg arg
  
    keys k1,k2,k3
  
  
    tag_key k1
    time_key k2
    time_format %Y-%m-%d %H:%M:%S
  
  run_interval 10s

以上命令的含义为每10秒钟执行cmd arg arg命令，提取命令执行结果，以空白字符分隔三个字段的值为k1,k2,k3。其中k1的值作为tag，k2作为时间字段，使用%Y-%m-%d %H:%M:%S格式。

一个例子，周期获取系统的平均负载。配置方法如下：

  @type exec
  tag system.loadavg
  command cat /proc/loadavg | cut -d ' ' -f 1,2,3
  run_interval 1m
  
    @type tsv
    keys avg1,avg5,avg15
    delimiter " "
  

输出的日志格式为：

2018-06-29 17:27:35.115878527 +0900 system.loadavg: {"avg1":"0.30","avg5":"0.20","avg15":"0.05"}

syslog

连接rsyslog。可以作为rsyslog的接收端。

一个配置的例子：

  @type syslog
  port 5140
  bind 0.0.0.0
  tag system

fluentd打开5140端口监听rsyslog发来的log。

rsyslog配置文件/etc/rsyslog.conf设置为：

# Send log messages to Fluentd
*.* @127.0.0.1:5140

fluentd解析到的event格式如下：

tag = "#{@tag}.#{facility}.#{priority}"
time = 1353436518,
record = {
  "host": "host",
  "ident": "ident",
  "pid": "12345",
  "message": "text"
}

dummy

专用于测试的数据源。周期产生假数据。

配置举例：

  @type dummy
  dummy {"hello":"world"}

dummy常用参数：

• tag: 标记值
• size：每次发送的event数量
• rate：每秒产生多少个event
• auto_increment_key：自增键名。如果配置了此项，会有一个key为该配置项值的自增键
• suspend：重启后自增值是否重新开始
• dummy：测试数据内容

forward

用于接收其他fluentd forward过来的event。

示例配置：

  @type forward
  port 24224
  bind 0.0.0.0

output配置

file

输出event为文件。默认每天输出一个日志文件。

示例配置：

  @type file
  path /var/log/fluent/myapp
  compress gzip
  
    timekey 1d
    timekey_use_utc true
    timekey_wait 10m
  

包含的参数类型：

• path：path支持placeholder，可以在日志路径中嵌入时间，tag和record中的字段值。例如：

path /path/to/${tag}/${key1}/file.%Y%m%d

  # buffer parameters

注意：buffer标签后面的内容为buffer chunk key。Buffer根据这些key分段。

• append：flush的chuck是否追加到已存在的文件后。默认为false，便于文件的并行处理。
• format标签，用来规定文件内容的格式，默认值为out_file。
• inject标签，用来为event增加time和tag等字段。
• add_path_suffix：是否增加path后缀
• path_suffix：path后缀内容，默认为.log。
• compress：采用什么压缩格式，默认不压缩。
• recompress：是否在buffer chunk已经压缩的情况再次压缩，默认为false。

forward

将event转发到其他的fluentd节点。如果配置了多个fluentd节点，会使用负载均衡和支持容错的方式发送。如果需要发送多份数据，需要使用copy。

配置示例：

  @type forward
  send_timeout 60s
  recover_wait 10s
  hard_timeout 60s

  
    name myserver1
    host 192.168.1.3
    port 24224
    weight 60
  
  
    name myserver2
    host 192.168.1.4
    port 24224
    weight 60
  
  ...

  
    @type file
    path /var/log/fluent/forward-failed
  

server标签内可以配置如下字段：

• host
• name
• port
• shared_key
• username
• password
• standby 标记server为备用，只有其他node不可用的时候才会启用standby的node
• weight 负载均衡的权重配置

copy

多路输出（复制event到多个输出端）

示例配置

  @type copy
  
    @type file
    path /var/log/fluent/myapp1
    ...
  
  
    ...
  
  
    ...
  

其中每一个store是一路输出。

重要参数：

• copy_mode：复制模式。可选值有
  • no_copy：每路输出共享event。
  • shallow：浅拷贝，如果不修改嵌套字段可以使用。
  • deep：深拷贝，使用msgpack-ruby方式。
  • marshal：深拷贝，使用marshal方式。
• store标签的ignore_error参数：如果被标记ignore_error的store出现错误，不会影响其他的store。官网的例子为：

  @type copy
  
    @type plugin1
  
  
    @type plugin2
  

假如plugin1出现错误，plugin2也不会执行。如果在plugin1的store添加上ignore_error参数，如下所示：

  @type copy
  
    @type plugin1
  
  
    @type plugin2
  

上述情况plugin2的运行不受影响。通常为不重要的store添加ignore_error参数。

http

通过http请求的方式发送event。
payload的格式由format标签决定。

示例配置：

  @type http

  endpoint http://logserver.com:9000/api
  open_timeout 2

  
    @type json
  
  
    flush_interval 10s
  

该例子使用http方式将event发送到http://logserver.com:9000/api，使用post方式，连接超时时间为2秒。输出格式为json，每10秒钟输出一次。

注意：

如果使用JSON的方式发送，HTTP请求的content-type为application/x-ndjson （newline-delimited JSONs）。如果用spring mvc接收会提示不支持。可以使用HTTPServletRequest接收request body。

stdout

标准输出的模式，如果使用后台模式运行fluentd，输出到fluentd的日志。多用于debug的时候。

配置方法：

  @type stdout

elasticsearch

输出event到elasticsearch。

示例配置：

  @type elasticsearch
  host localhost
  port 9200
  logstash_format true

可选参数：

• host：单个elasticsearch节点地址
• port：单个elasticsearch节点的端口号
• hosts：elasticsearch集群地址。格式为ip1:port1,ip2:port2...
• user和password：elasticsearch的认证信息
• scheme：使用https还是http。默认为http模式
• path：REST接口路径，默认为空
• index_name：index名称
• logstash_format：index是否使用logstash命名方式（logstash-%Y.%m.%d），默认不启用
• logstash_prefix：logstash_format启用的时候，index命名前缀是什么。默认为logstash

kafka

把event输出到kafka。

示例配置如下：

  @type kafka2

  # list of seed brokers
  brokers :,:
  use_event_time true

  # buffer settings
  
    @type file
    path /var/log/td-agent/buffer/td
    flush_interval 3s
  

  # data type settings
  
    @type json
  

  # topic settings
  topic_key topic
  default_topic messages

  # producer settings
  required_acks -1
  compression_codec gzip

重要的参数为：

• brokers：Kafka brokers的地址和端口号
• topic_key：record中哪个key对应的值用作Kafka消息的key
• default_topic：如果没有配置topic_key，默认使用的topic名字
• format标签：确定发送的数据格式
• use_event_time：是否使用fluentd event的时间作为Kafka消息的时间。默认为false。意思为使用当前时间作为发送消息的时间
• required_acks：producer acks的值
• compression_codec：压缩编码方式

webhdfs

event通过REST方式写入到HDFS。

HADOOP启用webhdfs的方法

core-site.xml

    
        fs.defaultFS
        hdfs://10.180.210.172:9000
    

hdfs-site.xml

    
        dfs.replication
        1
    
    
      dfs.http.address
      0.0.0.0:50070
    
    
    
      dfs.webhdfs.enabled
      true
    
    
      dfs.support.append
      true
    
    
      dfs.support.broken.append
      true
    

最后执行$HADOOP_HOME/sbin/httpfs.sh start命令启动webhdfs支持。

注意：此时webhdfs的端口号为50070。

示例配置和参数

示例配置：

  @type webhdfs
  host namenode.your.cluster.local
  port 50070
  path "/path/on/hdfs/access.log.%Y%m%d_%H.#{Socket.gethostname}.log"
  
    flush_interval 10s
  

注意：需要保证HDFS的目标目录具有写入权限。debug过程发现fluentd请求webhdfs没有使用user proxy，HDFS认为操作的用户为dr.who，无法创建文件。为了解决这个问题，设置HDFS目标目录的权限为777。

重要参数：

• host：namenode的地址
• port：namenode的端口号
• path：写入文件路径。可以使用占位符或者ruby表达式。可以使用如下方式表示时间：

\%Y: year including the century (at least 4 digits)
\%m: month of the year (01..12)
\%d: Day of the month (01..31)
\%H: Hour of the day, 24-hour clock (00..23)
\%M: Minute of the hour (00..59)
\%S: Second of the minute (00..60)

输出参数：

• timekey：多久输出一次文件到HDFS。如果path中没有配置占位符，默认为86400（1天）。如果指定了和时间相关的占位符，则文件输出周期自动和最小的时间占位符单位一致
• timekey_wait：允许等待来迟日志的最长时间
• flush_interval：flush间隔时间，默认为不设置
• flush_at_shutdown：关闭的时候是否flush。如果使用内存类型的buffer，需要配置为true

parser配置

regexp

使用正则表达式命名分组的方式从日志(一行或多行)中提取信息。可以通过time_key指定event的time字段的名字。名字为time字段名的分组内容会被抽取为event时间。

一个在线测试正则表达式的工具：http://fluentular.herokuapp.com/

基本配置格式：

  @type regexp
  expression /.../

正则表达式可以添加额外的参数：
忽略大小写：/.../i
多行匹配：/.../m。注意，此时.匹配新行
同时使用忽略大小写和多行匹配：/.../im

一个例子，示例配置如下：

  @type regexp
  expression /^\[(?[^\]]*)\] (?[^ ]*) (?