通过Sidecar方式采集Kubernetes容器文本日志

工作原理

Logtail采集配置的管理方式

（推荐）通过CRD管理Logtail采集配置

通过CRD可以自定义Kubernetes资源，为了便于通过云原生方式管理Logtail采集配置，日志服务定义了AliyunLogConfig这种CRD，它基本等价于Logtail采集配置。用户可以向kube-apiserver提交YAML配置文件来创建AliyunLogConfig资源，从而创建相应的Logtail采集配置。这种配置方式需要连接Kubernetes集群，并额外使用Kubernetes鉴权。

警告

通过CRD方式创建的配置，在控制台上对其修改不会同步到CRD中。因此，如需修改由CRD创建的配置内容，只能修改CRD资源，不要直接在控制台操作，避免配置不一致。

通过CRD管理Logtail采集配置的工作原理

1. 日志服务通过Deployment部署了一个控制器alibaba-log-controller，该控制器负责监听 AliyunLogConfig 资源的变化。

2. 当用户通过kubectl或其他Kubernetes管理工具创建、更新或删除AliyunLogConfig资源时，alibaba-log-controller会监测到这些变化，然后根据资源配置文件中的内容和服务端Logtail采集配置的状态，自动向日志服务提交各种请求，如采集配置变更等。

前提条件

• 已安装Logtail组件。具体操作，请参见安装Logtail组件（阿里云Kubernetes集群）。

• 在安装Logtail组件时所使用的Project中已创建Logstore。具体操作，请参见创建Logstore。

• 安装Logtail的主机需开放80（HTTP）端口和443（HTTPS）端口。ECS实例的端口由安全组规则控制，添加安全组规则的步骤请参见添加安全组规则。

• 目标容器持续新增日志。Logtail只采集增量日志。如果下发logtail采集配置后，日志文件无更新，则Logtail不会采集该文件中的日志。更多信息，请参见读取日志。

• 业务容器中待采集文件必须位于存储卷中，且该存储卷必须挂载到Logtail容器。

步骤一：为业务Pod注入Logtail容器

1. 登录Kubernetes集群。

2. 创建一个YAML文件。sidecar.yaml为文件的示例名称，请根据实际情况替换。

   vim sidecar.yaml

3. 在YAML文件中输入如下脚本，并根据实际情况设置其中的参数。

   警告

   YAML模板中，所有带有${}的占位符都需要替换为您环境中实际的值，其他参数禁止改动、删除。

   YAML模板

   apiVersion: batch/v1
   kind: Job
   metadata:
     # 在这里添加 Job 元信息，比如 name 和 namespace
     name: ${job_name}
     namespace: ${namespace}
   spec:
     template:
       spec:
         restartPolicy: Never
         containers:
           # 业务容器
           - name: ${main_container_name}
             image: ${main_container_image}
             command: ["/bin/sh", "-c"]
             args:
               - until [[ -f /tasksite/cornerstone ]]; do sleep 1; done;
                 # 替换为业务容器的实际启动命令
                 ${container_start_cmd};
                 retcode=$?;
                 touch /tasksite/tombstone;
                 exit $retcode
             volumeMounts:
               # 业务容器的日志目录挂载到共享存储卷
               - name: ${shared_volume_name}
                 mountPath: ${dir_containing_your_files}
               # 与 Logtail 容器交互的挂载点
               - mountPath: /tasksite
                 name: tasksite
            
           # Logtail sidecar 容器
           - name: logtail
             image: ${logtail_image}
             command: ["/bin/sh", "-c"]
             args:
               - /etc/init.d/ilogtaild start;
                 sleep 10; # 等待 Logtail 配置下载完成
                 touch /tasksite/cornerstone;
                 until [[ -f /tasksite/tombstone ]]; do sleep 1; done;
                 sleep 10; # 等待 Logtail 完成日志发送
                 /etc/init.d/ilogtaild stop;
             livenessProbe:
               exec:
                 command:
                   - /etc/init.d/ilogtaild
                   - status
               initialDelaySeconds: 30
               periodSeconds: 30
             env:
               # 设置时区。请根据kubernetes集群所在地域，配置时区，格式为"地区/城市"。如果是中国大陆，可以设置时区为Asia/Shanghai。
               # 如果没有正确配置时区，可能导致原始日志与处理日志的时间标签不匹配，进而将日志数据归档到错误的时间点。
               - name: TZ   
                 value: "${timezone}"
               - name: ALIYUN_LOGTAIL_USER_ID
                 value: "${your_aliyun_user_id}"
               - name: ALIYUN_LOGTAIL_USER_DEFINED_ID
                 value: "${your_machine_group_user_defined_id}"
               - name: ALIYUN_LOGTAIL_CONFIG
                 value: "/etc/ilogtail/conf/${your_region_config}/ilogtail_config.json"
               # 追加 Pod 环境信息作为日志标签
               - name: "ALIYUN_LOG_ENV_TAGS"
                 value: "_pod_name_|_pod_ip_|_namespace_|_node_name_|_node_ip_"
               # 获取 Pod 和 Node 的信息
               - name: "_pod_name_"
                 valueFrom:
                   fieldRef:
                     fieldPath: metadata.name
               - name: "_pod_ip_"
                 valueFrom:
                   fieldRef:
                     fieldPath: status.podIP
               - name: "_namespace_"
                 valueFrom:
                   fieldRef:
                     fieldPath: metadata.namespace
               - name: "_node_name_"
                 valueFrom:
                   fieldRef:
                     fieldPath: spec.nodeName
               - name: "_node_ip_"
                 valueFrom:
                   fieldRef:
                     fieldPath: status.hostIP
             volumeMounts:
               # Logtail 容器的日志目录挂载到共享存储卷
               - name: ${shared_volume_name}
                 mountPath: ${dir_containing_your_files}
               # 与业务容器交互的挂载点
               - mountPath: /tasksite
                 name: tasksite
         volumes:
           # 定义空的共享存储卷用于日志存储
           - name: ${shared_volume_name}
             emptyDir: {}
           # 定义存储卷用于容器间通信
           - name: tasksite
             emptyDir:
               medium: Memory
   

   关键参数说明

   变量	说明
   ${your_aliyun_user_id}	设置为您的阿里云账号ID。更多信息，请参见配置用户标识。
   ${your_machine_group_user_defined_id}	自定义设置机器组的自定义标识，例如nginx-log-sidecar。 重要 请确保该标识在您的Project所在地域内唯一。
   ${your_region_config}	请根据日志服务Project所在地域和访问的网络类型填写。其中，地域信息请参见安装Logtail（Linux系统）。 如果使用公网采集日志，格式为region-internet，例如华东 1（杭州）为cn-hangzhou-internet。 如果使用阿里云内网采集日志，格式为region。例如华东 1（杭州）为cn-hangzhou。
   ${logtail_image}	Logtail镜像地址。
   ${shared_volume_name}	自定义设置卷的名称。 重要 volumeMounts节点下的name参数与volumes节点下的name参数需设置为一致，即确保Logtail容器和业务容器挂载相同的卷上。
   ${dir_containing_your_files}	设置挂载路径，即容器待采集文本日志所在目录。

   示例

   apiVersion: batch/v1
   kind: Job
   metadata:
     # 在这里添加 Job 元信息，比如 name 和 namespace
     name: nginx-log-sidecar-demo
     namespace: default
   spec:
     template:
       metadata:
         # 在这里添加 Pod 元信息，比如 labels
         labels:
           app: nginx-logger
       spec:
         restartPolicy: Never
         containers:
           # 业务容器
           - name: nginx
             image: nginx-test
             command: ["/bin/sh", "-c"]
             args:
               - until [[ -f /tasksite/cornerstone ]]; do sleep 1; done;
                 # 替换为业务容器的实际启动命令
                 nginx -g 'daemon off;';
                 retcode=$?;
                 touch /tasksite/tombstone;
                 exit $retcode
             volumeMounts:
               # 业务容器的日志目录挂载到共享存储卷
               - name: nginx-logs
                 mountPath: /var/log/nginx
               # 与 Logtail 容器交互的挂载点
               - mountPath: /tasksite
                 name: tasksite
             # 在这里定义业务容器的资源请求和限制
             resources:
               limits:
                 cpu: 500m
                 memory: 512Mi
               requests:
                 cpu: 10m
                 memory: 30Mi
           # Logtail sidecar 容器
           - name: logtail
             image: registry.cn-hangzhou.aliyuncs.com/log-service/logtail:v1.5.1.0-aliyun
             command: ["/bin/sh", "-c"]
             args:
               - /etc/init.d/ilogtaild start;
                 sleep 10; # 等待 Logtail 配置下载完成
                 touch /tasksite/cornerstone;
                 until [[ -f /tasksite/tombstone ]]; do sleep 1; done;
                 sleep 10; # 等待 Logtail 完成日志发送
                 /etc/init.d/ilogtaild stop;
             livenessProbe:
               exec:
                 command:
                   - /etc/init.d/ilogtaild
                   - status
               initialDelaySeconds: 30
               periodSeconds: 30
             resources:
               limits:
                 cpu: 500m
                 memory: 512Mi
               requests:
                 cpu: 10m
                 memory: 30Mi
             env:
               # 设置时区。请根据kubernetes集群所在地域，配置时区，格式为"地区/城市"。如果是中国大陆，可以设置时区为Asia/Shanghai。
               # 如果没有正确配置时区，可能导致原始日志与处理日志的时间标签不匹配，进而将日志数据归档到错误的时间点。
               - name: TZ   
                 value: "Asia/Shanghai"
               # 在这里替换为实际的环境变量值
               - name: ALIYUN_LOGTAIL_USER_ID
                 value: "20*******28"
               - name: ALIYUN_LOGTAIL_USER_DEFINED_ID
                 value: "nginx-log-sidecar"
               - name: ALIYUN_LOGTAIL_CONFIG
                 value: "/etc/ilogtail/conf/cn-hangzhou-internet/ilogtail_config.json"
               # 追加 Pod 环境信息作为日志标签
               - name: "ALIYUN_LOG_ENV_TAGS"
                 value: "_pod_name_|_pod_ip_|_namespace_|_node_name_|_node_ip_"
               # 获取 Pod 和 Node 的信息
               - name: "_pod_name_"
                 valueFrom:
                   fieldRef:
                     fieldPath: metadata.name
               - name: "_pod_ip_"
                 valueFrom:
                   fieldRef:
                     fieldPath: status.podIP
               - name: "_namespace_"
                 valueFrom:
                   fieldRef:
                     fieldPath: metadata.namespace
               - name: "_node_name_"
                 valueFrom:
                   fieldRef:
                     fieldPath: spec.nodeName
               - name: "_node_ip_"
                 valueFrom:
                   fieldRef:
                     fieldPath: status.hostIP
             volumeMounts:
               # Logtail 容器的日志目录挂载到共享存储卷
               - name: nginx-logs
                 mountPath: /var/log/nginx
               # 与业务容器交互的挂载点
               - mountPath: /tasksite
                 name: tasksite
         volumes:
           # 定义空的共享存储卷用于日志存储
           - name: nginx-logs
             emptyDir: {}
           # 定义存储卷用于容器间通信
           - name: tasksite
             emptyDir:
               medium: Memory
   

4. 执行如下命令使sidecar.yaml文件配置生效。

   sidecar.yaml为文件名，请根据实际情况替换。

   kubectl apply -f sidecar.yaml

步骤二：创建Logtail采集配置

问题排查