Ansible自定义Callback插件日志重复输出问题求助

从你提供的插件加载日志和重复输出的现象来看，这个问题的核心原因是你的自定义Callback插件没有正确适配Ansible 2.4.x的v2插件规范，导致被识别为旧版（v1）插件并被多次加载实例化，具体细节如下：

1. 插件类型识别错误 #

你的加载日志里反复出现：

Loading callback plugin unnamed of type old, v1.0 from /usr/lib/python2.7/site-packages/ansible/plugins/callback/init.pyc

这说明Ansible没有把你的自定义插件识别为v2版本的callback插件，而是当作了v1的旧版插件。在Ansible 2.4+中，v2插件需要满足以下要求：

• 插件文件中必须定义继承自ansible.plugins.callback.CallbackBase的CallbackModule类
• 必须包含DOCUMENTATION块（哪怕是空的），或者至少设置CALLBACK_NAME、CALLBACK_TYPE等属性来标识插件信息
• 如果缺少这些元数据，Ansible会将其归类为未命名的旧版插件，并且可能在扫描插件路径时多次加载它

2. 插件路径重复扫描 #

另外，需要检查你的callback_plugins配置：

• 确认是否在ansible.cfg的defaults部分重复设置了callback_plugins路径
• 检查是否同时通过环境变量ANSIBLE_CALLBACK_PLUGINS指定了插件目录，导致同一个目录被多次扫描
• 查看你的playbook是否通过vars或者命令行参数额外指定了插件路径，造成重复加载

3. 插件实例化逻辑问题 #

如果你的自定义插件代码中没有正确处理单例模式，或者在日志输出部分没有做幂等处理，每次插件被实例化时都会重复输出日志内容，这也会导致你看到的重复现象。

解决步骤 #

针对这些问题，你可以按以下顺序排查修复：

1. 规范自定义插件的v2结构：
   修改你的插件代码，确保它符合Ansible v2 callback插件的标准：

   from ansible.plugins.callback import CallbackBase
   
   DOCUMENTATION = '''
   callback: your_custom_plugin_name
   type: stdout
   short_description: Your custom callback description
   description:
     - This is a custom callback plugin for logging task timings
   '''
   
   class CallbackModule(CallbackBase):
       CALLBACK_NAME = 'your_custom_plugin_name'
       CALLBACK_TYPE = 'stdout'
       CALLBACK_VERSION = 2.0
       CALLBACK_NEEDS_WHITELIST = False  # 如果不需要白名单的话
   
       # 你的插件逻辑代码...
   

2. 检查插件路径配置：
   打开ansible.cfg，确保callback_plugins只配置一次：

   [defaults]
   callback_plugins = /path/to/your/custom/callback_plugins
   

   同时检查环境变量：

   echo $ANSIBLE_CALLBACK_PLUGINS
   

   如果有多余的路径，清理掉重复的配置。
3. 验证插件加载情况：
   运行playbook时加上-vvv参数，查看更详细的插件加载日志，确认你的自定义插件被正确识别为v2插件，而不是unnamed old类型：

   ansible-playbook -u ansible -i inventory/test-env release.yml -vvv
   

4. 检查插件日志输出逻辑：
   确保你的插件中日志输出的部分不会在每次实例化时重复执行，比如将统计数据存储在类变量中，而不是实例变量，避免多次实例化导致重复输出。

内容的提问来源于stack exchange，提问作者ahmetcetin