Ansible AWX 调试技巧全解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01199/article/details/148377869

Ansible AWX 调试技巧全解析

awx AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is one of the upstream projects for Red Hat Ansible Automation Platform. 项目地址: https://gitcode.com/gh_mirrors/aw/awx

前言

Ansible AWX 作为企业级的自动化平台，在生产环境中运行时难免会遇到性能问题或需要调试的场景。本文将全面介绍 AWX 提供的多种调试工具和技术，帮助开发者和运维人员快速定位和解决问题。

SQL 查询性能分析

慢查询追踪工具

AWX 内置了一个强大的 SQL 查询分析工具，可以追踪所有 Python 进程中的慢查询。使用方法如下：

awx-manage profile_sql --threshold 2 --minutes 5

参数说明：

--threshold：查询时间阈值（秒），超过此时间的查询会被记录
--minutes：记录持续时间（分钟）

执行后，所有运行时间超过 2 秒的 SQL 查询都会被记录到 /var/log/tower/profile 目录下的 SQLite 数据库中。

查询日志分析

生成的 SQLite 数据库可以使用 sqlite3 命令行工具进行分析：

sqlite3 -column -header /var/log/tower/profile/uwsgi.sqlite

数据库结构包含以下重要字段：

time：查询执行时间（秒）
sql：实际执行的 SQL 语句
explain：查询执行计划
bt：触发查询的 Python 调用栈

通过分析这些数据，可以快速定位性能瓶颈所在。

PostgreSQL 慢查询追踪

配置 PostgreSQL 日志

要追踪 PostgreSQL 慢查询，需要在配置文件中启用相关选项：

log_min_duration_statement = 500 # 毫秒
log_line_prefix = '< %m %a >'   # 包含时间戳和应用名

查询追踪标识

AWX 增强了查询追踪能力，日志中会显示如下格式的信息：

< 2021-04-21 12:42:10.307 UTC awx_1-1540765-/bin/awx-manage gather_analytics --dry-run -v 3 >

其中包含三个关键信息：

主机名（awx_1）
进程 ID（1540765）
执行的命令（/bin/awx-manage...）

活动查询监控

可以通过查询 pg_stat_activity 视图监控长时间运行的查询：

SELECT
  now() - pg_stat_activity.query_start AS duration,
  query,
  state,
  application_name
FROM pg_stat_activity
WHERE (now() - pg_stat_activity.query_start) > interval '5 minutes' and state='active';

远程调试技巧

远程调试器 sdb

在开发环境中，AWX 使用进程管理工具管理后台进程，无法直接使用标准 pdb。AWX 提供了远程调试工具 sdb：

import sdb
sdb.set_trace()

设置断点后，日志会显示调试端口：

[2017-01-30 22:26:04,366: WARNING/Worker-11] Remote Debugger:6900: Please telnet into 0.0.0.0 6900.

自动连接调试会话

开发环境中可以使用 sdb-listen 命令自动发现并连接调试会话：

sdb-listen

作业状态可视化

graph_jobs 工具

awx-manage graph_jobs 命令可以可视化作业状态变化：

awx-manage graph_jobs --width 100 --height 30 --refresh 1

参数说明：

--width：图表宽度
--height：图表高度
--refresh：刷新间隔（秒）

该工具会实时显示作业从 pending 到 waiting 再到 running 的状态变化。

代码性能分析

性能分析装饰器

AWX 提供了 @profile 装饰器用于代码性能分析：

from awx.main.utils.profiling import profile

@profile(name="task_manager_profile")
def task_manager():
    ...

需要安装依赖：

pip3 install gprof2dot

分析结果包括：

文本格式的性能数据（.pstats 文件）
可视化调用图（.dot 文件）

可以使用 xdot 查看可视化结果：

xdot /var/log/tower/profile/xxx.dot

执行时间测量装饰器

对于简单的执行时间测量，可以使用 @timing 装饰器：

from awx.main.utils.profiling import timing

@timing(name="my_task_manager_timing")
def task_manager():
    ...

测量结果会记录到 /var/log/tower/timing 目录下。

手动性能分析

也可以直接使用 AWXProfiler 类进行手动分析：

from awx.main.utils.profiling import AWXProfiler

prof = AWXProfiler("hello_world")
prof.start()
# 待分析代码
prof.stop()

总结

AWX 提供了从数据库查询分析到代码级性能剖析的全套调试工具。合理使用这些工具可以快速定位性能瓶颈，优化系统性能。对于生产环境，建议重点关注 SQL 查询性能和作业状态监控；对于开发环境，则可以利用远程调试和代码剖析工具提高开发效率。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考