如何仅为特定任务编写日志

问题描述

正在使用 Ansible，并创建了一个用于部署的 Playbook。他在 ansible.cfg 中定义了 log_path，以便将任务输出写入日志文件。然而，他希望只将某些任务的日志发送到该日志文件中。他尝试使用 no_log: True 属性，但这会导致日志不会显示在控制台上。因此，他的需求是在控制台上显示所有任务的日志，但只想将某些任务的日志发送到日志文件中。

解决方案

请注意以下操作可能会涉及版本差异及修改前做好备份。

方案1：使用自定义 Callback 插件

Ansible 提供了一种自定义回调插件的方式，你可以通过创建一个自定义的回调插件来满足你的需求。下面是一种可能的方式，通过创建自己的 Callback 插件来实现将特定任务的日志发送到指定的日志文件中，同时保留其他任务的日志显示在控制台上。

1. 首先，在 Ansible 项目目录下创建一个新的目录，例如 callbacks。
2. 在 callbacks 目录中创建一个 Python 文件，例如 custom_logging.py。
3. 在 custom_logging.py 中编写自定义 Callback 插件的代码。以下是一个示例代码，用于将特定任务的日志发送到指定的日志文件中。

from ansible.plugins.callback import CallbackBase
import os

class CallbackModule(CallbackBase):
    CALLBACK_VERSION = 2.0
    CALLBACK_TYPE = 'notification'
    CALLBACK_NAME = 'custom_logging'

    def __init__(self, display=None):
        super(CallbackModule, self).__init__(display)
        self.log_file = '/path/to/your/log/file.log'
        self.tasks_to_log = ['task_name_1', 'task_name_2']  # 指定需要记录日志的任务名称列表

    def v2_playbook_on_task_start(self, task, is_conditional):
        if task.get_name() in self.tasks_to_log:
            self._log_task(task)

    def _log_task(self, task):
        with open(self.log_file, 'a') as f:
            f.write(f"Task Name: {task.get_name()}\n")
            f.write(f"Task Args: {task.args}\n")
            f.write("===========================\n")

# 以下为 Ansible Callback Plugin 必需的代码
if __name__ == '__main__':
    CallbackModule(display=None).run()

在上述示例中，我们创建了一个自定义 Callback 插件，指定了需要记录日志的特定任务名称列表 tasks_to_log，以及日志文件路径 log_file。每当任务开始时，如果任务名称存在于 tasks_to_log 列表中，该任务的日志将被写入日志文件中。

1. 在运行 Playbook 时，将自定义 Callback 插件设置为使用，通过在命令行中使用 -c 或 --callback 参数。例如：

ansible-playbook -c /path/to/callbacks/custom_logging.py your_playbook.yml

方案2：考虑使用标准输出和重定向

另一种方法是将所有任务的日志都显示在控制台上，然后通过标准输出的重定向，将特定任务的日志写入到指定的日志文件中。这可以通过 shell 脚本或命令来实现。

以下是一个简单的示例，使用 grep 命令将特定任务的日志写入到日志文件中：

ansible-playbook your_playbook.yml | grep -E 'task_name_1|task_name_2' >> /path/to/your/log/file.log

在这个示例中，grep -E 'task_name_1|task_name_2' 会匹配包含 task_name_1 或 task_name_2 的行，并将它们追加到日志文件中。

注意：这种方法只是将包含特定任务日志的行写入日志文件，不会按照严格的任务顺序进行记录。

请根据你的需求选择适合的解决方案，并根据实际情况进行调整。