kubetail

Kubetail是一个适用于Kubernetes集群的私有实时日志查看器。

<img src="https://github.com/kubetail-org/kubetail/assets/75881/7647bd90-0859-4b0b-9400-c7cdeb6a93e6" width="300px" title="screenshot">

演示: https://www.kubetail.com/demo

简介

<img src="https://yellow-cdn.veclightyear.com/ab5030c0/3c956022-1dc1-481f-bb4e-b0338c679004.svg" width="300px" title="KubeTail">

在容器化环境中查看应用程序日志可能很有挑战性。通常,一个应用程序由几个服务组成,每个服务都部署在多个容器上,并进行负载均衡以确保资源的均衡使用。虽然使用像kubectl或Kubernetes Dashboard这样的工具查看单个容器日志很容易,但同时监控构成应用程序的所有容器的日志更加困难。这一困难进一步加剧了容器的短暂性,它们不断进出存在。

Kubetail通过提供一个易于使用的基于Web的界面来解决这个问题,允许您实时同时查看一组Kubernetes工作负载(如Deployment、CronJob、StatefulSet)的所有日志。在引擎盖下,它使用您集群的Kubernetes API来监控您的工作负载,并在新的工作负载容器创建或旧容器删除时检测。Kubetail将自动将新容器的消息添加到您的查看流中,或更新其UI以反映某个旧容器将不再产生消息。这让您可以轻松跟踪应用程序日志,因为用户请求在服务之间来回移动到不同的临时容器。Kubetail还可以通过允许您根据可用性区域、CPU架构或节点ID等节点属性过滤日志,来帮助您调试应用程序问题。这对于找到特定于应用程序实例运行的环境的问题很有用。

Kubetail应用程序由一个Go语言编写的后端服务器和一个基于React的静态网站组成,后者查询后端服务器并在浏览器中显示结果。通常,Kubetail会以Docker容器的形式部署在您的集群中,使用清单文件或Helm图表,并且可以使用与连接Kubernetes仪表板相同的方式(如kubectl proxy)通过Web浏览器访问。由于Kubetail在内部使用您的Kubernetes API来请求日志,您的日志消息始终保留在您的控制之下,默认情况下Kubetail是私有的。

我们的目标是建立一个强大的云原生日志平台,从头到尾为容器化环境而设计,这个项目仍在持续开发中。如果您发现任何bug或有任何建议,请创建一个GitHub问题或发送电子邮件(hello@kubetail.com)!

主要特性

• 小巧、资源高效(内存<30MB,CPU开销可忽略不计)
• 实时查看日志消息
• 查看属于特定工作负载(如Deployment、CronJob、StatefulSet)的日志
• 自动检测工作负载容器的创建和删除,并将其日志添加到查看流中
• 使用您的Kubernetes API,所以日志消息永远不会离开您的掌控(默认为私有)
• 根据时间过滤日志
• 根据可用性区域、CPU架构或节点ID等节点属性过滤日志
• 使用彩色代码区分不同容器的日志行
• 干净、易于使用的界面

安装

选项1: 清单文件

要让kubetail使用内部集群服务帐户查询Kubernetes API,请使用-clusterauth清单文件:

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

要要求kubetail用户使用自己的Kubernetes身份验证令牌,请使用-tokenauth清单文件:

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

选项2: Helm图表

要使用Helm安装kubetail,请先添加kubetail存储库,然后安装图表:

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

要配置Helm图表,请参考values.yaml了解有效值及其默认值。您可以使用YAML文件或使用--set key=value[,key=value]参数指定每个参数:

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

选项3: Glasskube

要使用Glasskube安装kubetail,您可以在Glasskube GUI的"ClusterPackages"选项卡中选择"kubetail",然后单击"install",或者运行以下命令:

glasskube install kubetail

安装kubetail后,您可以通过单击Glasskube GUI中的"open"或使用open命令来访问:

glasskube open kubetail

访问

当kubetail应用程序在您的集群中运行时,有几种方式可以访问kubetail仪表板。为简单起见,如果您的kubetail部署使用auth-mode: cluster,我们建议使用kubectl proxy,如果使用auth-mode: token,则建议使用kubectl auth-proxy插件。

选项1: kubectl proxy

访问仪表板最简单的方法是使用kubectl proxy:

kubectl proxy

现在您可以通过以下链接访问仪表板: http://localhost:8001/api/v1/namespaces/kubetail/services/kubetail:4000/proxy/。

选项2: kubectl port-forward

另一种访问仪表板的方法是使用kubectl port-forward:

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

现在您可以通过以下链接访问仪表板: http://localhost:4000。

选项3: kubectl auth-proxy

如果您启用了auth-mode: token,那么我们建议使用kubectl auth-proxy插件来访问仪表板,它将自动在本地获取访问令牌,并在向kubetail服务发出请求时将其添加到HTTP头中:

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

现在您的计算机将自动打开一个新的浏览器选项卡,指向kubetail仪表板。

配置

CLI

kubetail服务器可执行文件(server)支持以下命令行配置选项:

标志	数据类型	描述	默认值
-c, --config	字符串	配置文件路径	""
-a, --addr	字符串	要绑定的主机地址	":4000"
--gin-mode	字符串	Gin模式(release, debug)	"release"

配置文件

Kubetail可以使用YAML、JSON、TOML、HCL或envfile格式编写的配置文件进行配置。应用程序将自动用相应的值替换写为${NAME}格式的环境变量。配置文件支持以下选项(也请参见hack/config.yaml):

名称	数据类型	描述	默认值
addr	字符串	绑定的主机地址	":4000"
auth-mode	字符串	认证模式(token, cluster, local)	"token"
allowed-namespaces	[]字符串	如果已填充,则限制命名空间访问	[]
base-path	字符串	URL路径前缀	"/"
gin-mode	字符串	Gin模式(release, debug)	"release"
kube-config	字符串	Kubectl配置文件路径	"${HOME}/.kube/config"
csrf.enabled	布尔值	启用CSRF保护	true
csrf.field-name	字符串	表单中的CSRF令牌名称	"csrf_token"
csrf.secret	字符串	CSRF哈希密钥	""
csrf.cookie.name	字符串	CSRF cookie名称	"csrf"
csrf.cookie.path	字符串	CSRF cookie路径	"/"
csrf.cookie.domain	字符串	CSRF cookie域	""
csrf.cookie.max-age	整数	CSRF cookie最大年龄(以秒为单位)	43200
csrf.cookie.secure	布尔值	CSRF cookie安全属性	false
csrf.cookie.http-only	布尔值	CSRF cookie HttpOnly属性	true
csrf.cookie.same-site	字符串	CSRF cookie SameSite属性(strict, lax, none)	"strict"
logging.enabled	布尔值	启用日志记录	true
logging.level	字符串	日志级别	"info"
logging.format	字符串	日志格式(json, pretty)	"json"
logging.access-log.enabled	布尔值	启用访问日志	true
logging.access-log.hide-health-checks	布尔值	从访问日志中隐藏对/healthz的请求	false
session.secret	字符串	会话哈希密钥	""
session.cookie.name	字符串	会话cookie名称	"session"
session.cookie.path	字符串	会话cookie路径	"/"
session.cookie.domain	字符串	会话cookie域	""
session.cookie.max-age	整数	会话cookie最大年龄(以秒为单位)	43200
session.cookie.secure	布尔值	会话cookie安全属性	false
session.cookie.http-only	布尔值	会话cookie HttpOnly属性	true
session.cookie.same-site	字符串	会话cookie SameSite属性(strict, lax, none)	"strict"
tls.enabled	布尔值	启用TLS端点终止	false
tls.cert-file	字符串	证书文件路径	""
tls.key-file	字符串	密钥文件路径	""

开发

这个存储库被组织为一个monorepo,包含一个Go后端服务器和一个React前端静态网站,分别位于backend和frontend目录中。该网站查询后端服务器,后端服务器代理对Kubernetes API的请求,并执行一些其他自定义任务(例如认证)。在生产中,前端网站被捆绑到后端服务器中,并作为静态网站提供服务(参见构建)。在开发过程中,后端和前端分别运行,但使用Tilt配置为一起工作。

要开发kubetail,首先使用一个与Tilt配合使用的dev cluster工具创建一个kubernetes dev cluster。您也可以使用ctlptl和hack/ctlptl目录中的一个配置来自动化这个过程。例如,要使用minikube创建一个dev cluster,您可以使用以下命令:

ctlptl apply -f hack/ctlptl/minikube.yaml

一旦dev cluster启动并且kubectl指向它,您就可以使用Tilt启动开发环境:

tilt up

Tilt启动后端服务器后,您可以在localhost的4000端口访问它。要运行前端开发网站,请进入frontend目录并运行install和dev命令:

cd frontend
pnpm install
pnpm dev

现在可以在http://localhost:5173访问控制台。

构建

要为生产部署构建一个docker镜像,请运行以下命令:

docker build -t kubetail:latest .

如何参与

我们的目标是构建一个功能强大的云原生日志平台,从头设计用于容器化环境,这个项目还在进行中。如果您有兴趣参与,请给我们发送电子邮件(hello@kubetail.com)或加入我们的Slack频道(kubetail)。我们特别需要以下方面的帮助:

• UI/设计
• React前端开发