Python pexpect库实战：自动化获取服务器与K8s日志
本文详解如何利用Python pexpect库实现服务器SSH登录及K8s容器内的日志自动化获取。通过模拟终端交互，解决远程调试低效问题，涵盖命令封装、超时处理及结果清洗，适用于运维自动化场景。
1. 前言
对于大多数开发者而言，排查Bug通常依赖于在日志中搜索关键字来定位问题所在。
在本地调试阶段，我们可以直接在控制台实时查看日志输出；然而，当应用部署到服务器后，日志文件通常存储在服务器的特定目录下，无法直接从本地机器查看。
面对这种情况，操作流程变得繁琐：我们需要先登录服务器，进入日志所在的目录文件夹，再通过日志文件进行问题定位；若涉及K8s容器环境，甚至还需借助kubectl命令进入服务对应的容器内部，定位到日志目录后才能开始工作，整个过程效率低下。
本文介绍一款Python依赖库：pexpect。作为一款命令行自动化工具，它能帮助我们一键获取日志，从而快速定位问题。
2. pexpect 介绍
pexpect是Python语言对Expect机制的一种实现，它通过生成子应用程序并控制它们，根据期望模式对子应用程序的输出做出相应处理。
项目地址：
https://github.com/pexpect/pexpect/tree/5eed1a31a2853a09b7367c59fbd1a4a0b53341df
该库主要模拟人机对话，从而实现多种自动化场景。
例如：用于与SSH、FTP、PASSWD、Telnet等命令行程序进行自动化交互。
在使用之前，我们需要先安装依赖包。
# 安装依赖库
pip3 install pexpect3. 实战一下
我们以从服务器K8S容器获取日志为例进行讲解。
3-1 SSH 登录
首先，初始化使用pexpect模拟SSH远程登录服务器。
import pexpect
PROMPT = ['# ', '>>> ', '> ', '\$ ']
def login_with_pexpect():
"""
登录-pexpect
:return:
"""
# 端口号
port = **
# 用户名
user = **
# 密码
pwd = **
# ip地址
ip = **
ssh_cmd = "ssh -p {} {}@{}".format(port,user,ip)
# 指定登录命令，拿到程序操作句柄
child = pexpect.spawn(ssh_cmd, timeout=60, encoding='utf-8')
# 提示输入密码的字符出现，否则超时
ret = child.expect([pexpect.TIMEOUT, '[P|p]assword: '], timeout=10)
# 匹配成功后，输入密码，执行登陆操作
if ret == 1:
# 发送密码
child.sendline(pwd)
child.expect(PROMPT)
return child
else:
print('登录失败！')其中
pexpect.spawn()：用于执行一个程序，并返回一个操作句柄。
该方法常见的3个参数如下：
- 第一个参数是待执行的命令。
- 第二个参数指定超时时间，程序执行后的输出检查，如果指定时间内没有匹配到结果，就会抛异常。
- 第三个参数用于设置编码格式。
child.expect()：对输出结果，利用正则表达式进行关键字匹配。
代码中的含义是在10s内等待出现关键字'[P|p]assword: '。
最后，如果匹配的结果为1，使用sendline()方法发送带回车符的字符串，模拟密码的输入，完成登录操作。
3-2 封装发送命令
接下来，我们将操作句柄发送命令进行一次封装，并获取返回结果。
def send_command(child, cmd, expected_content=None, timeout=10):
"""
发送一条命令，并打印结果
:param expected_content:
:param child:
:param cmd:
:return:
"""
# 发送一条命令
if expected_content is None:
expected_content = ["#"]
child.sendline(cmd)
# 期望有命令行提示字符出现
child.expect(expected_content, timeout=timeout)
# 将之前的内容都输出
result = child.before
return result 需要指出的是，child.before用于获取到匹配到关键字为止，缓存里面已有的全部数据。
3-3 进入容器 pod 日志目录
使用上面的方法，通过kubectl进入到对应的容器日志目录。
# 登录pod容器
exec_enter_pod = 'kubectl -n %s exec -it %s bash' % (env, pod_name)
# 进入容器
send_command(child, exec_enter_pod)
# 进入到日志目录
send_command(child, "cd logs", expected_content='tomcat/logs#')3-4 获取日志内容
最后我们只需要组成获取日志的命令。
比如：使用grep/tail命令组成一个提取日志文件的命令。
然后使用句柄对象发送这条命令。
最后，对返回内容进行清洗即可。
4. 最后
文中使用pexpect实现了一个非常简单的场景。
事实上，大部分人机对话自动化交互都可以由它来实现，比如，下载日志、实时配置、远程打包下载等。
以上就是python基于pexpect库自动获取日志信息的详细内容，更多关于python pexpect库自动获取日志的资料请关注本站其它相关文章！
本站声明
本文内容仅供参考，不代表本站观点。转载或引用请注明出处。如发现内容问题，请通过联系我们页面反馈。
