高效办公，Python 自动化教你一键获取日志！-python 自动化办公

[[379781]]

本文转载自微信公众号「AirPython」，作者星安果。转载本文请联系AirPython公众号。

1. 前言

对大部分的人来说，解决 Bug 都是依靠关键字去日志去定位问题!

在调试情况下，我们可以实时在控制台查看日志;但对于部署到服务器上的应用，日志都存放在服务器某个目录下，没法通过本地查看到

这种情况下，就需要我们先登录服务器，然后进入到日志目录文件夹，最后通过日志文件去定位问题;如果涉及到 K8s 容器，可能还需要使用 kubectl 命令进入到服务对应的容器中，进入到日志目录，才能开始定位问题，这一切显得非常繁琐且低效

本篇文章介绍一款 Python 依赖库：pexpect，作为一款命令行自动化工具，它可以帮助我们一键获取日志，快速定位问题!

2. pexpect 介绍

pexpect 是 Python 语言实现的类 Expect 的一种实现，通过产生子应用程序并控制它们，通过期望模式对子应用程序的输出做出相应处理

项目地址：

https://github.com/pexpect/pexpect/tree/5eed1a31a2853a09b7367c59fbd1a4a0b53341df

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

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

在使用之前，我们先安装依赖包

# 安装依赖库 
pip3 install pexpect 
1.
2.

3. 实战一下

我们以从服务器 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('登录失败！') 
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.

其中

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  
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.

需要指出的是，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#') 
1.
2.
3.
4.
5.
6.
7.
8.

3-4 获取日志内容

最后我们只需要组成获取日志的命令

比如：使用 grep/tail 命令组成一个提取日志文件的命令

然后使用句柄对象发送这条命令

最后，对返回内容进行清洗即可

4. 最后

文中使用 pexpect 实现了一个非常简单的场景

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