两款超好用的 Kubernetes 实时日志查看工具

Posted by Mike on 2020-11-09

通常情况下,Kubernetes 环境下的应用日志都需要通过日志系统来进行收集,比如:Filebeat + ElasticSearch + Kibana 的组合来实现。虽然这一组合的功能相当强大,但是在一些比较简陋的测试集群中,或者不具备浏览器条件的自动化/控制台环境下,自动合并多个 Pod 中的日志进行集中的查看,对处理问题和调试故障还是很有大帮助的。

今天,我们就给大家介绍两款超好用的多容器实时日志查看工具 SternKubetail

Stern

Kubectl 本身的 Log 命令是不支持同时查看多个 Pod 容器中的日志,Stern 很好的解决了这个问题, 它除了可以同时 tail 多个容器的日志之外, 还支持以下一些强大的功能:

  • 允许使用正则表达式来选择需要 tail 的 PodName
  • 自定义不同 Pod 的日志输出的颜色
  • 自动添加符合规则的新创建 Pod 并进行 tail

项目地址: https://github.com/wercker/stern

安装 Stern

Stern 使用 Go 语言开发,安装非常简单,开箱即用。你只需下载对应平台相关的二进制预编译安装包,就可以使用了。

Linux 平台为例:

1
2
3
$ wget https://github.com/wercker/stern/releases/download/1.11.0/stern_linux_amd64
$ chmod +x stern_linux_amd64
$ mv stern_linux_amd64 /usr/local/bin

如果你使用的是 macOS,可以直接 Homebrew 进行安装。

1
$ brew install stern

使用 Stern

Stern 支持的功能很多,用法也很丰富。下面我们来看几个比较常用的例子:

  1. 实时查看当前 Namespace 中所有 Pod 中所有容器的日志
1
$ stern  .
  1. 实时查看 Pod 中指定容器的日志
1
$ stern envvars --container gateway
  1. 实时查看指定命名空间中除指定容器外的所有容器的日志
1
$ stern -n staging --exclude-container istio-proxy .
  1. 实时查看指定时间范围内容器的日志,下面的例子表示是 15 分钟内
1
$ stern auth -t --since 15m
  1. 实时查看指定命名空间中容器的日志
1
$ stern kubernetes-dashboard --namespace kube-system
  1. 实时查看所有命名空间中符合指定标签容器的日志
1
$ stern --all-namespaces -l run=nginx

更多用法,可参考「Stern 官方文档」。

Kubetail

Kubetail 是一个 Shell 脚本,它可以将多个 Pod 的日志合并到一起,并支持彩色输出。

项目地址:https://github.com/johanhaleby/kubetail

安装 Kubetail

由于 Kubetail 只是一个 Shell 脚本,直接下载后便可使用。

1
2
3
$ wget https://raw.githubusercontent.com/johanhaleby/kubetail/master/kubetail
$ chmod +x kubetail
$ cp kubetail /usr/local/bin

如果你使用的是 macOS,也可以直接 Homebrew 进行安装。

1
$ brew tap johanhaleby/kubetail && brew install kubetail

Kubetail 还支持各种 SHELL 管理框架,比如:Oh-my-zshAntigen 等,具体安装方法可参考「官方安装文档」。

使用 Kubetail

Kubetail 使用也是非常简单的,基本语法如下:

1
$ kubetail <search term> [-h] [-c] [-n] [-t] [-l] [-d] [-p] [-s] [-b] [-k] [-v] [-r] [-i]

一些常用参数的解释:

1
2
3
4
5
6
7
-c:指定多容器 Pod 中的容器名称
-t:指定 Kubeconfig 文件中的 Context
-l:标签过滤器,使用 -l 参数之后,会忽略 Pod 名称
-n:指定命名空间
-s:指定返回一个相对时间之后的日志,例如 5s,2m 或者 3h,缺省是 10s
-b:是否使用 line-buffered,缺省为 false
-k:指定输出内容的具体着色部分,pod:只给 pod 名称上色,line:整行上色(缺省),false:不上色

一些使用实例:

1
2
3
4
5
6
7
$ kubetail my-pod-v1
$ kubetail my-pod-v1 -c my-container
$ kubetail my-pod-v1 -t int1-context -c my-container
$ kubetail '(service|consumer|thing)' -e regex
$ kubetail -l service=my-service
$ kubetail --selector service=my-service --since 10m
$ kubetail --tail 1

至此,两种超实用的多容器实时日志查看工具就介绍完了。如果你还有更好的类似工具推荐,欢迎留言讨论哟!

参考文档

  1. https://www.google.com
  2. https://zhuanlan.zhihu.com/p/60987559
  3. https://blog.fleeto.us/post/introducing-kubetail/