文章目录
官方文档地址: Kubernetes
Kubernetes 生产级日志处理器
Fluent Bit 是一款轻量级的、可扩展的日志处理器,完全支持 Kubernetes:
- 治理来自文件系统或 Systemd / Journald 的 Kubernetes 容器日志。
- 用 Kubernetes 元数据丰富日志。
- 将你的日志集中在第三方存储服务中,比如 Elasticsearch,inflxdb,HTTP等。
1. 概念
在开始之前,了解 Fluent Bit 将如何部署非常重要。Kubernetes 管理一个节点集群,因此我们的日志代理工具需要在每个节点上运行,以从每个 POD 收集日志,因此将 Fluent Bit 部署为 DaemonSet(在集群的每个节点上运行的 POD)。
当 Fluent Bit 运行时,它将读取、解析和过滤每个 POD 的日志,并使用以下信息(元数据)丰富每个条目:
- Pod Name
- Pod ID
- Container Name
- Container ID
- Labels
- Annotations
为了获得这些信息,一个名为 kubernetes 的内置过滤器插件与 kubernetes API Server 对话,以检索相关信息,如 pod_id、labels 和 annotations,其他字段,如 pod_name、container_id 和 container_name 在本地从日志文件名称中检索。所有这些都是自动处理的,不需要从配置方面进行干预。
我们的 Kubernetes 过滤器插件完全是受 Jimmi Dyson 编写的 Fluentd Kubernetes 元数据过滤器的启发。
2. 安装
资源库地址:https://github.com/fluent/fluent-bit-kubernetes-logging
译者注
官方网站文档不全,本节一部分的内容是在这个资源库的 README.md 找到的。
不一定必须按照下面方法来,也可直接访问该资源库,将下面提到的文件下载到服务器上,普通K8S部署的话需要五个 Yaml 文件,然后修改里面的部分内容,再创建 POD,我们就是这么做的。
一般的K8S上的安装只看这一节基本上就能搞定,具体配置文件的修改稍后会发表一篇博文专门讲述。
这个资源库包含一组用于部署 Fluent Bit 的 Yaml 文件,这些文件里面包括了名称空间、RBAC、服务帐户等。
Fluent Bit 必须部署为 DaemonSet,这样它就可以在 Kubernetes 集群的每个节点上使用。首先运行以下命令来创建命名空间、服务帐户、角色设置以及账户角色绑定:
$ kubectl create namespace logging
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/fluent-bit-service-account.yaml
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/fluent-bit-role.yaml
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/fluent-bit-role-binding.yaml
如果您在 openshift 上部署 fluent-bit,还需要运行以下命令:
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/fluent-bit-openshift-security-context-constraints.yaml
2.1. Fluent Bit to Elasticsearch
创建将由我们的 Fluent Bit DaemonSet 使用的 ConfigMap:
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/output/elasticsearch/fluent-bit-configmap.yaml
默认的 configmap 假设集群使用了 dockershim。如果使用 CRI 运行时,如 containerd 或 CRI-O,则应该使用 CRI 解析器。更具体地说,将input-kubernetes.conf
中Parser
的描述从 docker 改为 cri。
Fluent Bit DaemonSet 可与 Elasticsearch 在一个普通的 Kubernetes 集群上一起使用:
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/output/elasticsearch/fluent-bit-ds.yaml
Minikube 上的 Fluent Bit to Elasticsearch
如果您正在使用 Minikube 进行测试,请使用以下可选的 DaemonSet 清单:
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/output/elasticsearch/fluent-bit-ds-minikube.yaml
2.2. Fluent Bit to Kafka
创建将由我们的 Fluent Bit DaemonSet 使用的 ConfigMap:
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/output/kafka/fluent-bit-configmap.yaml
Fluent Bit DaemonSet 可与 Kafka 在一个普通的 Kubernetes 集群上一起使用:
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/output/kafka/fluent-bit-ds.yaml
Minikube 上的 Fluent Bit to Kafka
如果您正在使用 Minikube 进行测试,请使用以下可选的 DaemonSet 清单:
$ kubectl create -f https://raw.githubusercontent.com/fluent/fluent-bit-kubernetes-logging/master/output/kafka/fluent-bit-ds-minikube.yaml
2.3. 注意 Kubernetes < v1.16
对于比 v1.16 更老的 Kubernetes 版本,DaemonSet 资源在apps/v1
上不可用,该资源在apiVersion: extensions/v1beta1
上可用,我们当前的 Daemonset Yaml 文件使用新的apiVersion
。
如果你使用的是旧版本的 Kubernetes,手动获取你的 Daemonset Yaml 文件的副本,并替换 apiVersion 的值:
apiVersion: apps/v1
为
apiVersion: extensions/v1beta1
你可以在 Kubernetes v1.14 Changelog 上阅读更多关于这个弃用的信息:
https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.14.md#deprecations
3. 通过 Helm Chart 安装
Helm 是 Kubernetes 的包管理器,允许您将应用程序包快速部署到正在运行的集群中。Fluent Bit 通过 Fluent Helm Charts repo 中的 helm chart 进行分布式部署:https://github.com/fluent/helm-charts
要添加 Fluent Helm Charts repo,请使用以下命令:
helm repo add fluent https://fluent.github.io/helm-charts
要验证是否添加了 repo,您可以运行helm search repo fluent
,以确保图表已添加。然后可以通过运行以下程序安装默认图表:
helm install fluent-bit fluent/fluent-bit
默认值
默认的图表值包括读取容器日志的配置,使用 Docker 解析,systemd 日志应用 Kubernetes 元数据充实并最终输出到 Elasticsearch 集群。您可以修改https://github.com/fluent/helm-charts/blob/master/charts/fluent-bit/values.yaml文件包含的值,以指定其他输出、运行状况检查、监视端点或其他配置选项。
4. 详情
Fluent Bit 的默认配置确保了以下功能:
- 消费运行节点的所有容器日志。
- Tail 输入插件将不会追加超过 5MB 到引擎,直到他们刷新到 Elasticsearch 后端。这个限制的目的是为反压情况提供一个解决方案。
- Kubernetes 过滤器将使用 Kubernetes 元数据(特别是 labels 和 annotations)丰富日志。过滤器只在找不到缓存的信息时才转到 API 服务器,否则它将使用缓存。
- 配置中的默认后端是 Elasticsearch 输出插件设置的 Elasticsearch。它使用 Logstash 格式来摄取日志。如果你需要一个不同的索引和类型,请参考插件选项并自行调整。
- 有一个名为 Retry_Limit 的选项设置为 False,这意味着如果 Fluent Bit 不能将记录刷新到 Elasticsearch,它将无限期地重新尝试,直到成功。
5. 容器运行时接口(CRI)解析器
Fluent Bit 默认假设日志是按照 Docker 接口标准格式化的。但是,在使用 CRI 时,如果不修改所使用的解析器,就会遇到格式不正确的 JSON 问题。Fluent Bit 包括一个 CRI 日志解析器可以用来代替。下面是解析器的一个示例:
# CRI Parser
[PARSER]
# http://rubular.com/r/tjUt3Awgg4
Name cri
Format regex
Regex ^(?<time>[^ ]+) (?<stream>stdout|stderr) (?<logtag>[^ ]*) (?<message>.*)$
Time_Key time
Time_Format %Y-%m-%dT%H:%M:%S.%L%z
要使用此解析器,请将配置的 Input 部分从docker
更改为cri
。
[INPUT]
Name tail
Path /var/log/containers/*.log
Parser cri
Tag kube.*
Mem_Buf_Limit 5MB
Skip_Long_Lines On
6. Windows 部署
从 v1.5.0 开始,Fluent Bit 支持部署到 Windows pod。
6.1. 日志文件概述
在将 Fluent Bit 部署到 Kubernetes 时,需要注意三个日志文件。
C:\k\kubelet.err.log
- 这是 kubelet 守护进程在主机上运行的错误日志文件。
- 您将需要保留这个文件,以便将来进行故障排除(调试部署失败等)。
C:\var\log\containers\<pod>_<namespace>_<container>-<docker>.log
- 这是您需要查看的主要日志文件。配置 Fluent Bit 以遵循此文件。
- 它实际上是指向
C:\ProgramData\
中的 Docker 日志文件的符号链接,文件名上有一些额外的元数据。
C:\ProgramData\Docker\containers\<docker>\<docker>.log
- Docker 生成的日志文件。
- 通常不直接从该文件读取,但需要确保该文件在 Fluent Bit 中可见。
通常,您的部署 yaml 包含以下卷配置:
spec:
containers:
- name: fluent-bit
image: my-repo/fluent-bit:1.5.0
volumeMounts:
- mountPath: C:\k
name: k
- mountPath: C:\var\log
name: varlog
- mountPath: C:\ProgramData
name: progdata
volumes:
- name: k
hostPath:
path: C:\k
- name: varlog
hostPath:
path: C:\var\log
- name: progdata
hostPath:
path: C:\ProgramData
6.2. 配置 Fluent Bit
假设有上面描述的基本卷配置,您可以应用以下配置来开始日志记录。你可以设想这个构型:
fluent-bit.conf: |
[SERVICE]
Parsers_File C:\\fluent-bit\\parsers.conf
[INPUT]
Name tail
Tag kube.*
Path C:\\var\\log\\containers\\*.log
Parser docker
DB C:\\fluent-bit\\tail_docker.db
Mem_Buf_Limit 7MB
Refresh_Interval 10
[INPUT]
Name tail
Tag kubelet.err
Path C:\\k\\kubelet.err.log
DB C:\\fluent-bit\\tail_kubelet.db
[FILTER]
Name kubernetes
Match kube.*
Kube_URL https://kubernetes.default.svc.cluster.local:443
[OUTPUT]
Name stdout
Match *
parsers.conf: |
[PARSER]
Name docker
Format json
Time_Key time
Time_Format %Y-%m-%dT%H:%M:%S.%L
Time_Keep On
6.3. 减轻 Windows pod 上不稳定的网络
Windows pod 经常在启动后立即缺少工作的 DNS(#78479)。为了缓解这个问题,filter_kubernetes
提供了一个内置的机制来等待网络启动:
DNS_Retries
- 重试 N 次,直到网络开始工作(6)DNS_Wait_Time
- 网络状态检查之间的查找间隔(30)
默认情况下,Fluent Bit 等待3分钟(30秒x 6次)。如果对您来说还不够,可以按如下方式调整配置。
[filter]
Name kubernetes
...
DNS_Retries 10
DNS_Wait_Time 30