Kubernetes中Logtail日志采集CRD配置详解

日志采集配置默认支持控制台配置方式，同时针对Kubernetes微服务开发模式，我们还提供CRD的配置方式，您可以直接使用kubectl对配置进行管理。

我们推荐使用CRD方式进行采集配置管理，该方式与Kubernetes部署、发布流程的集成更加完善。

实现原理

执行安装命令时会自动安装alibaba-log-controller的Helm包。Helm包中主要执行了以下操作：

创建aliyunlogconfigs CRD（CustomResourceDefinition）。
部署alibaba-log-controller的Deployment。
部署Logtail的DaemonSet。

具体配置的内部工作流程如下：

用户使用kubectl或其他工具应用aliyunlogconfigs CRD配置。
alibaba-log-controller监听到配置更新。
alibaba-log-controller根据CRD内容以及服务端状态，自动向日志服务提交logstore创建、配置创建以及应用机器组的请求。
以DaemonSet模式运行的Logtail会定期请求配置服务器，获取新的或已更新的配置并进行热加载。
Logtail根据配置信息采集各个容器(POD)上的标准输出或文件。
最终Logtail将处理、聚合好的数据发送到日志服务。

使用方式

配置方式

注意：如果您之前使用的DaemonSet方式部署的日志服务Logtail，将无法使用CRD的方式进行配置管理。升级方式参见Kubernets日志采集部署中DaemonSet部署方式迁移步骤。

您只需要定义AliyunLogConfig的CRD即可实现配置的创建，删除对应的CRD资源即可删除对应配置。CRD配置格式如下：

apiVersion: log.alibabacloud.com/v1alpha1 ## 默认值，无需改变 kind: AliyunLogConfig ## 默认值，无需改变 metadata:
 name: simple-stdout-example ## 资源名，必须在集群内唯一 spec:
 logstore: k8s-stdout ## logstore名，不存在时自动创建
 shardCount: 2 ## [可选] logstore分区数，默认为2，支持1-10
 lifeCycle: 90 ## [可选] 该logstore存储时间，默认为90，支持1-36500，3650天为永久存储
 logtailConfig: ## 详细配置
 inputType: plugin ## 采集的输入类型，一般为file或plugin
 configName: simple-stdout-example ## 采集配置名，需要和资源名(metadata.name)一致
 inputDetail: ## 详细配置信息，具体请参考示例
 ...

配置完成并apply后，alibaba-log-controller会自动创建

查看配置

您可以通过Kubernetes CRD或控制台查看配置。

控制台查看配置参见查看Logtail配置列表。

注意：使用CRD管理方式，若您在控制台更改配置，下一次执行CRD更新配置时，会覆盖控制台的更改内容。
使用kubectl get aliyunlogconfigs查看当前所有配置

[root@iZbp1dsbiaZ ~]# kubectl get aliyunlogconfigs
NAME AGE
regex-file-example 10s
regex-stdout-example 4h
simple-file-example 5s

使用kubectl get aliyunlogconfigs ${config_name} -o yaml查看详细配置和状态。

配置中status字段显示配置执行的结果，若配置应用成功，status字段中的statusCode为200。若statusCode非200，则说明配置应用失败。

[root@iZbp1dsbiaZ ~]# kubectl get aliyunlogconfigs simple-file-example -o yaml
apiVersion: log.alibabacloud.com/v1alpha1
kind: AliyunLogConfig
metadata:
 annotations:
 kubectl.kubernetes.io/last-applied-configuration: |
 {"apiVersion":"log.alibabacloud.com/v1alpha1","kind":"AliyunLogConfig","metadata":{"annotations":{},"name":"simple-file-example","namespace":"default"},"spec":{"logstore":"k8s-file","logtailConfig":{"configName":"simple-file-example","inputDetail":{"dockerFile":true,"dockerIncludeEnv":{"ALIYUN_LOGTAIL_USER_DEFINED_ID":""},"filePattern":"simple.LOG","logPath":"/usr/local/ilogtail","logType":"common_reg_log"},"inputType":"file"}}}
 clusterName: ""
 creationTimestamp: 2018-05-17T08:44:46Z
 generation: 0
 name: simple-file-example
 namespace: default
 resourceVersion: "21790443"
 selfLink: /apis/log.alibabacloud.com/v1alpha1/namespaces/default/aliyunlogconfigs/simple-file-example
 uid: 8d3a09c4-59ae-11e8-851d-00163f008685
spec:
 lifeCycle: null
 logstore: k8s-file
 logtailConfig:
 configName: simple-file-example
 inputDetail:
 dockerFile: true
 dockerIncludeEnv:
 ALIYUN_LOGTAIL_USER_DEFINED_ID: ""
 filePattern: simple.LOG
 logPath: /usr/local/ilogtail
 logType: common_reg_log
 inputType: file
 machineGroups: null
 project: ""
 shardCount: null
status:
 status: OK
 statusCode: 200

配置示例

容器标准输出

容器标准输出中，需要将inputType设置为plugin，并将具体信息填写到inputDetail下的plugin字段，详细配置字段极其含义请参考：容器标准输出

极简采集方式

采集除了环境变量中配置COLLECT_STDOUT_FLAG=false之外所有容器的标准输出(stdout和stderr)。

apiVersion: log.alibabacloud.com/v1alpha1 kind: AliyunLogConfig metadata: # your config name, must be unique in you k8s cluster
 name: simple-stdout-example
spec: # logstore name to upload log
 logstore: k8s-stdout
 # logtail config detail
 logtailConfig:
 # docker stdout's input type is 'plugin'
 inputType: plugin
 # logtail config name, should be same with [metadata.name]
 configName: simple-stdout-example
 inputDetail:
 plugin:
 inputs:
 -
 # input type
 type: service_docker_stdout
 detail:
 # collect stdout and stderr
 Stdout: true
 Stderr: true
 # collect all container's stdout except containers with "COLLECT_STDOUT_FLAG:false" in docker env config
 ExcludeEnv:
 COLLECT_STDOUT_FLAG: "false"

自定义处理采集方式

采集grafana的access log，并将access log解析成结构化数据。

grafana的容器配置中包含环境变量为：GF_INSTALL_PLUGINS=grafana-piechart-....，通过配置IncludeEnv为GF_INSTALL_PLUGINS: ''指定Logtail只采集该容器的标准输出。

grafana的access log格式如下：

t=2018-03-09T07:14:03+0000 lvl=info msg="Request Completed" logger=context userId=0 orgId=0 uname= method=GET path=/ status=302 remote_addr=172.16.64.154 time_ms=0 size=29 referer=

在这里我们使用正则表达式解析access log，具体配置如下：

apiVersion: log.alibabacloud.com/v1alpha1
kind: AliyunLogConfig
metadata:
 # your config name, must be unique in you k8s cluster
 name: regex-stdout-example
spec:
 # logstore name to upload log
 logstore: k8s-stdout-regex
 # logtail config detail
 logtailConfig:
 # docker stdout's input type is 'plugin'
 inputType: plugin
 # logtail config name, should be same with [metadata.name]
 configName: regex-stdout-example
 inputDetail:
 plugin:
 inputs:
 -
 # input type type: service_docker_stdout
 detail:
 # 只采集stdout，不采集stderr
 Stdout: true
 Stderr: false # 只采集容器环境变量中配置key为"GF_INSTALL_PLUGINS"的stdout 
 InluceEnv:
 GF_INSTALL_PLUGINS: ''
 processors:
 -
 # 使用正则表达式处理 type: processor_regex
 detail:
 # docker 采集的数据默认key为"content"
 SourceKey: content
 # 正则表达式提取
 Regex: 't=(\d+-\d+-\w+:\d+:\d+\+\d+) lvl=(\w+) msg="([^"]+)" logger=(\w+) userId=(\w+) orgId=(\w+) uname=(\S*) method=(\w+) path=(\S+) status=(\d+) remote_addr=(\S+) time_ms=(\d+) size=(\d+) referer=(\S*).*' # 提取出的key
 Keys: ['time', 'level', 'message', 'logger', 'userId', 'orgId', 'uname', 'method', 'path', 'status', 'remote_addr', 'time_ms', 'size', 'referer']
 # 保留原始字段
 KeepSource: true
 NoKeyError: true
 NoMatchError: true

配置应用后，采集到日志服务的数据如下：

容器文件

极简文件

采集环境变量配置中含有key为ALIYUN_LOGTAIL_USER_DEFINED_ID的容器内日志文件，文件所处的路径为/data/logs/app_1，文件名为simple.LOG。

apiVersion: log.alibabacloud.com/v1alpha1 kind: AliyunLogConfig metadata: # your config name, must be unique in you k8s cluster
 name: simple-file-example
spec: # logstore name to upload log
 logstore: k8s-file
 # logtail config detail
 logtailConfig:
 # log file's input type is 'file'
 inputType: file
 # logtail config name, should be same with [metadata.name]
 configName: simple-file-example
 inputDetail:
 # 极简模式日志，logType设置为"common_reg_log"
 logType: common_reg_log
 # 日志文件夹
 logPath: /data/logs/app_1
 # 文件名, 支持通配符，例如log_*.log
 filePattern: simple.LOG
 # 采集容器内的文件，dockerFile flag设置为true
 dockerFile: true
 # only collect container with "ALIYUN_LOGTAIL_USER_DEFINED_ID" in docker env config
 dockerIncludeEnv:
 ALIYUN_LOGTAIL_USER_DEFINED_ID: ""

完全正则模式文件

对于某Java程序日志样例为：

[2018-05-11T20:10:16,000] [INFO] [SessionTracker] [SessionTrackerImpl.java:148] Expiring sessions
java.sql.SQLException: Incorrect string value: '\xF0\x9F\x8E\x8F",...' for column 'data' at row 1
at org.springframework.jdbc.support.AbstractFallbackSQLExceptionTranslator.translate(AbstractFallbackSQLExceptionTranslator.java:84)
at org.springframework.jdbc.support.AbstractFallbackSQLException

日志中由于包含错误堆栈信息，可能一条日志会被分解成多行，因此需要设置行首正则表达式；为了提取出各个字段，这里我们使用正则表达式进行提取，具体配置如下：

apiVersion: log.alibabacloud.com/v1alpha1
kind: AliyunLogConfig
metadata:
 # your config name, must be unique in you k8s cluster
 name: regex-file-example
spec:
 # logstore name to upload log
 logstore: k8s-file
 logtailConfig:
 # log file's input type is 'file'
 inputType: file
 # logtail config name, should be same with [metadata.name]
 configName: regex-file-example
 inputDetail:
 # 对于正则类型的日志，将logType设置为common_reg_log
 logType: common_reg_log
 # 日志文件夹
 logPath: /app/logs
 # 文件名, 支持通配符，例如log_*.log
 filePattern: error.LOG
 # 行首正则表达式
 logBeginRegex: '\[\d+-\d+-\w+:\d+:\d+,\d+]\s\[\w+]\s.*' # 解析正则
 regex: '\[([^]]+)]\s\[(\w+)]\s\[(\w+)]\s\[([^:]+):(\d+)]\s(.*)' # 提取出的key列表
 key : ["time", "level", "method", "file", "line", "message"]
 # 正则模式日志，时间解析默认从日志中的`time`提取，如果无需提取时间，可不设置该字段
 timeFormat: '%Y-%m-%dT%H:%M:%S' # 采集容器内的文件，dockerFile flag设置为true
 dockerFile: true # only collect container with "ALIYUN_LOGTAIL_USER_DEFINED_ID" in docker env config
 dockerIncludeEnv:
 ALIYUN_LOGTAIL_USER_DEFINED_ID: ""