kubetail/kubetail

kubetail

Kubetail是一个基于Web的Kubernetes集群实时日志查看器。

!https://github.com/kubetail-org/kubetail/assets/75881/7647bd90-0859-4b0b-9400-c7cdeb6a93e6 "截图"

演示地址：[***]

![Artifact Hub]([] ![slack]([]

概述

!https://github.com/kubetail-org/kubetail/raw/main/assets/github-logo.svg "Kubetail"

在容器化环境中查看应用日志具有挑战性。通常，一个应用由多个服务组成，每个服务部署在多个容器中，通过负载均衡确保资源均匀消耗。虽然使用kubectl或Kubernetes Dashboard等工具查看单个容器日志很容易，但同时监控构成应用的所有容器日志则较为困难。容器的短暂特性（不断创建和销毁）进一步增加了难度。

Kubetail通过提供易于使用的基于Web的界面解决了这一问题，允许您同时实时查看一组Kubernetes工作负载（如Deployment、CronJob、StatefulSet）的所有日志。其底层通过集群的Kubernetes API监控工作负载，检测新容器的创建或旧容器的删除，并自动将新容器的日志添加到查看流中，或更新UI以反映旧容器不再产生日志。这使您能够轻松跟踪应用日志，即使请求在不同服务的短暂容器间流转。此外，Kubetail支持按节点属性（如可用区、CPU架构或节点ID）过滤日志，有助于调试特定环境下的应用问题。

Kubetail应用由基于Go的后端服务器（连接Kubernetes API）和基于React的静态网站（查询后端并在浏览器中显示结果）组成。通常通过清单文件或Helm chart部署为集群内的Docker容器，可通过与访问Kubernetes Dashboard相同的方式（如kubectl proxy）在Web浏览器中访问。由于内部使用Kubernetes API请求日志，日志消息始终由您掌控，默认保持私有。

我们的目标是构建一个专为容器化环境设计的强大云原生日志平台，该项目仍在开发中。如发现bug或有建议，请创建GitHub Issue或发送邮件至***！

核心功能

• 资源占用小且高效（内存<30MB，CPU消耗可忽略）
• 实时查看日志消息
• 查看特定工作负载（如Deployment、CronJob、StatefulSet）的日志
• 自动检测工作负载容器的创建和删除，并将其日志添加到查看流
• 使用Kubernetes API，日志消息永不离开您的集群（默认私有）
• 按时间过滤日志
• 按节点属性（如可用区、CPU架构或节点ID）过滤日志
• 彩色编码日志行以区分不同容器
• 简洁易用的界面

安装

选项1：清单文件

若允许Kubetail使用内部集群服务账户查询Kubernetes API，使用-clusterauth清单文件：

console
kubectl apply -f https://github.com/kubetail-org/kubetail/releases/latest/download/kubetail-clusterauth.yaml

若要求Kubetail用户使用自己的Kubernetes认证令牌，使用-tokenauth清单文件：

console
kubectl apply -f https://github.com/kubetail-org/kubetail/releases/latest/download/kubetail-tokenauth.yaml

选项2：Helm chart

使用Helm安装Kubetail，需先添加Kubetail仓库，然后安装chart：

console
helm repo add kubetail https://kubetail-org.github.io/helm-charts/
helm install kubetail kubetail/kubetail --namespace kubetail --create-namespace

如需配置Helm chart，请参考https://github.com/kubetail-org/helm-charts/blob/main/charts/kubetail/values.yaml%E4%BA%86%E8%A7%A3%E6%9C%89%E6%95%88%E5%80%BC%E5%8F%8A%E9%BB%98%E8%AE%A4%E5%80%BC%E3%80%82%E5%8F%AF%E4%BD%BF%E7%94%A8YAML%E6%96%87%E4%BB%B6%E6%88%96%E9%80%9A%E8%BF%87%60--set key=value[,key=value]`参数指定配置：

console
helm install kubetail kubetail/kubetail \
  --namespace kubetail \
  --create-namespace \
  -f values.yaml \
  --set key1=val1,key2=val2

访问

Kubetail应用在集群中运行后，有多种方式访问其仪表板。为简单起见，若部署使用auth-mode: cluster，建议使用kubectl proxy；若使用auth-mode: token，建议使用kubectl auth-proxy插件。

选项1：kubectl proxy

最简单的访问方式是使用kubectl proxy：

console
kubectl proxy

此时可通过以下地址访问仪表板：http://localhost:8001/api/v1/namespaces/kubetail/services/kubetail:4000/proxy/。

选项2：kubectl port-forward

另一种访问方式是使用kubectl port-forward：

console
kubectl port-forward -n kubetail svc/kubetail 4000:4000

此时可通过以下地址访问仪表板：http://localhost:4000。

选项3：kubectl auth-proxy

若启用了auth-mode: token，建议使用kubectl https://github.com/int128/kauthproxy%E8%AE%BF%E9%97%AE%E4%BB%AA%E8%A1%A8%E6%9D%BF%EF%BC%8C%E8%AF%A5%E6%8F%92%E4%BB%B6%E4%BC%9A%E8%87%AA%E5%8A%A8%E5%9C%A8%E6%9C%AC%E5%9C%B0%E8%8E%B7%E5%8F%96%E8%AE%BF%E9%97%AE%E4%BB%A4%E7%89%8C%E5%B9%B6%E6%B7%BB%E5%8A%A0%E5%88%B0HTTP%E8%AF%B7%E6%B1%82%E5%A4%B4%E4%B8%AD%EF%BC%9A

console
kubectl auth-proxy -n kubetail http://kubetail.svc

此时计算机将自动打开新浏览器标签页指向Kubetail仪表板。

配置

命令行界面（CLI）

Kubetail服务器可执行文件（server）支持以下命令行配置选项：

配置文件

Kubetail支持使用YAML、JSON、TOML、HCL或envfile格式的配置文件。应用会自动将${NAME}格式的环境变量替换为对应值。配置文件支持以下选项（另见hack/config.yaml）：

如何贡献

我们的目标是构建一个专为容器化环境设计的强大云原生日志平台，该项目仍在开发中。如您有兴趣参与，请发送邮件至***或加入我们的Slack频道（kubetail）。我们特别需要以下方面的帮助：

• UI/设计
• React前端开发