ghcr.io/kube-logging/logging-operator:master

Logging operator

Logging operator 现已成为 CNCF Sandbox 项目。

Logging operator 通过自动化部署和配置 Kubernetes 日志流水线，解决 Kubernetes 环境中与日志相关的问题。

• 该 operator 在每个节点上部署并配置日志收集器（当前为 Fluent Bit DaemonSet），以从节点文件系统收集容器和应用日志。
• Fluent Bit 查询 Kubernetes API，并使用关于 Pod 的元数据丰富日志，然后将日志和元数据一起传输到日志转发器实例。
• 日志转发器实例接收、过滤和转换传入日志，并将其传输到一个或多个目标输出。Logging operator 支持 Fluentd 和 syslog-ng 作为日志转发器。
• 您的日志始终通过经过身份验证和加密的通道传输。

此 operator 帮助您将日志信息与应用程序捆绑：您可以在应用程序的图表中描述其行为，其余工作由 Logging operator 完成。

• Fluentd 的 CRD：Output - 定义日志流的 Fluentd 输出，日志消息通过 Fluentd 发送到此处。这是一个命名空间级资源。另请参见 ClusterOutput。要配置 syslog-ng 输出，请参见 SyslogNGOutput。
  Logging- Flow - 使用 filters 和 outputs 定义 Fluentd 日志流。基本上，流会将选定的日志消息路由到指定的 outputs。这是一个命名空间级资源。另请参见 ClusterFlow。要配置 syslog-ng 流，请参见 SyslogNGFlow。
  filters``outputs``ClusterFlow``SyslogNGFlow- ClusterOutput - 定义可从所有 flows 和 clusterflows 使用的 Fluentd 输出。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则操作员仅在 controlNamespace 中评估 clusteroutputs。
  controlNamespace``allowClusterResourcesFromAllNamespaces- ClusterFlow - 定义默认从所有命名空间收集日志的 Fluentd 日志流。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则操作员仅在 controlNamespace 中评估 clusterflows。要配置 syslog-ng clusterflows，请参见 SyslogNGClusterFlow。
  controlNamespace``allowClusterResourcesFromAllNamespaces``SyslogNGClusterFlow- syslog-ng 的 CRD（这些资源与其 Fluentd 对应资源类似，但针对通过 syslog-ng 可用的功能进行了定制）：SyslogNGOutput - 定义日志流的 syslog-ng 输出，日志消息通过 Fluentd 发送到此处。这是一个命名空间级资源。另请参见 SyslogNGClusterOutput。要配置 Fluentd 输出，请参见 output。
  SyslogNGClusterOutput``output- SyslogNGFlow - 使用 filters 和 outputs 定义 syslog-ng 日志流。基本上，流会将选定的日志消息路由到指定的 outputs。这是一个命名空间级资源。另请参见 SyslogNGClusterFlow。要配置 Fluentd 流，请参见 flow。
  filters``outputs``SyslogNGClusterFlow``flow- SyslogNGClusterOutput - 定义可从所有 flows 和 clusterflows 使用的 syslog-ng 输出。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则操作员仅在 controlNamespace 中评估 clusteroutputs。
  controlNamespace``allowClusterResourcesFromAllNamespaces- SyslogNGClusterFlow - 定义默认从所有命名空间收集日志的 syslog-ng 日志流。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则操作员仅在 controlNamespace 中评估 clusterflows。要配置 Fluentd clusterflows，请参见 clusterflow。
  controlNamespace``allowClusterResourcesFromAllNamespaces``clusterflow请参见详细的 CRD 文档。

架构

Logging operator 管理日志基础设施的日志收集器和日志转发器，以及指定不同日志消息发送位置的路由规则。

日志收集器是端点代理，用于收集 Kubernetes 节点的日志并将其发送到日志转发器。Logging operator 当前使用 Fluent Bit 作为日志收集代理。

日志转发器实例接收、过滤和转换传入的日志，并将其传输到一个或多个目标输出。Logging operator 支持 Fluentd 和 syslog-ng 作为日志转发器。哪种日志转发器最适合您取决于您的日志需求。

您可以使用日志转发器的 flow 自定义资源来过滤和处理传入的日志消息，将其路由到适当的 output。输出是您希望发送日志消息的目标，例如 Elasticsearch 或 Amazon S3 存储桶。您还可以定义集群范围的输出和流，例如使用集中式输出，命名空间用户可以引用但无法修改。请注意，流和输出特定于您使用的日志转发器类型（Fluentd 或 syslog-ng）。

您可以使用以下自定义资源定义 (CRD) 配置 Logging operator。

• https://kube-logging.github.io/docs/logging-infrastructure/logging/ - Logging 资源定义集群的日志基础设施（日志收集器和转发器），用于收集和传输日志消息。它还包含 Fluent Bit、Fluentd 和 syslog-ng 的配置。
• Fluentd 的 CRD：
• https://kube-logging.github.io/docs/configuration/output/ - 定义 Fluentd 输出，用于日志流，日志消息通过 Fluentd 发送到该输出。这是一个命名空间级资源。另请参见 ClusterOutput。要配置 syslog-ng 输出，请参见 SyslogNGOutput。
• https://kube-logging.github.io/docs/configuration/flow/ - 使用 filters 和 outputs 定义 Fluentd 日志流。基本上，流将选定的日志消息路由到指定的输出。这是一个命名空间级资源。另请参见 ClusterFlow。要配置 syslog-ng 流，请参见 SyslogNGFlow。
• https://kube-logging.github.io/docs/configuration/output/ - 定义可从所有流和集群流访问的 Fluentd 输出。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则 operator 仅在 controlNamespace 中评估 clusteroutputs。
• https://kube-logging.github.io/docs/configuration/flow/ - 定义默认从所有命名空间收集日志的 Fluentd 日志流。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则 operator 仅在 controlNamespace 中评估 clusterflows。要配置 syslog-ng 集群流，请参见 SyslogNGClusterFlow。
• syslog-ng 的 CRD（这些资源与其 Fluentd 对应项类似，但针对 syslog-ng 提供的功能进行了定制）：
• https://kube-logging.github.io/docs/configuration/output/#syslogngoutput - 定义 syslog-ng 输出，用于日志流，日志消息通过 Fluentd 发送到该输出。这是一个命名空间级资源。另请参见 SyslogNGClusterOutput。要配置 Fluentd 输出，请参见 output。
• https://kube-logging.github.io/docs/configuration/flow/#syslogngflow - 使用 filters 和 outputs 定义 syslog-ng 日志流。基本上，流将选定的日志消息路由到指定的输出。这是一个命名空间级资源。另请参见 SyslogNGClusterFlow。要配置 Fluentd 流，请参见 flow。
• https://kube-logging.github.io/docs/configuration/output/#syslogngoutput - 定义可从所有流和集群流访问的 syslog-ng 输出。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则 operator 仅在 controlNamespace 中评估 clusteroutputs。
• https://kube-logging.github.io/docs/configuration/flow/#syslogngflow - 定义默认从所有命名空间收集日志的 syslog-ng 日志流。除非 allowClusterResourcesFromAllNamespaces 设置为 true，否则 operator 仅在 controlNamespace 中评估 clusterflows。要配置 Fluentd 集群流，请参见 clusterflow。

参见 https://kube-logging.github.io/docs/configuration/crds/%E3%80%82

• 支持本项目的发展，为该仓库点亮星标！:star:
• 如果您在生产环境中使用 Logging operator，请将自己添加到生产https://github.com/kube-logging/logging-operator/blob/master/ADOPTERS.md%EF%BC%88%E9%87%87%E7%94%A8%E8%80%85%EF%BC%89%E5%88%97%E8%A1%A8%E4%B8%AD%E3%80%82:metal:
• 帮助新用户解决他们可能遇到的问题 :muscle:
• 提交包含新功能和错误修复的拉取请求 :rocket:

*有关更多信息，请阅读https://kube-logging.github.io/docs/developers*%E3%80%82

许可证

版权所有 (c) 2021-2023 Cisco Systems, Inc. and its affiliates 版权所有 (c) 2017-2020 Banzai Cloud, Inc.

根据 Apache License, Version 2.0（以下简称“许可证”）授权； 除非符合许可证要求，否则您不得使用本文件。 您可以在以下地址获取许可证副本：

[***]

除非适用***要求或书面同意，否则根据本许可证分发的软件按“原样”分发，不提供任何明示或暗示的保证或条件。有关权限和限制的具体规定，请参见许可证。