1. 前言
对大部分的人来说，解决 Bug 都是依附关键字去日志去定位问题！

在调试状况下，咱们能够实时在控制台查看日志；但对于部署到服务器上的利用，日志都寄存在服务器某个目录下，没法通过本地查看到

这种状况下，就须要咱们先登录服务器，而后进入到日志目录文件夹，最初通过日志文件去定位问题；如果波及到 K8s 容器，可能还须要应用 kubectl 命令进入到服务对应的容器中，进入到日志目录，能力开始定位问题，这所有显得十分繁琐且低效

本篇文章介绍一款 Python 依赖库：pexpect，作为一款命令行自动化工具，它能够帮忙咱们一键获取日志，疾速定位问题！

2. pexpect 介绍
pexpect 是 Python 语言实现的类 Expect 的一种实现，通过产生子应用程序并管制它们，通过冀望模式对子应用程序的输入做出相应解决

它次要对人机对话进行模仿，来实现一些自动化的场景

比方：用来和 SSH、FTP、PASSWD、Telnet 等命令行程序进行自动化交互

在应用之前，咱们先装置依赖包

# 装置依赖库pip3 install pexpect

3. 实战一下
咱们以从服务器 K8S 容器获取日志为例进行解说

3-1 SSH 登录

首先，初始化应用 pexpect 模仿 SSH 近程登录服务器

import pexpectPROMPT = ['# ', '>>> ', '> ', '\$ ']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 实现了一个非常简单的场景

事实上，大部分人机对话自动化交互都能够由它来实现，比方，下载日志、实时配置、近程打包下载等

最近整顿了几百 G 的 Python 学习材料，蕴含新手入门电子书、教程、源码等等，收费分享给大家！想要的返回 “Python 编程学习圈”，发送 “J” 即可收费取得