community.general/plugins/callback/syslog_json.py

# Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later

# Make coding more python3-ish
from __future__ import annotations

DOCUMENTATION = r"""
author: Unknown (!UNKNOWN)
name: syslog_json
type: notification
requirements:
  - whitelist in configuration
short_description: Sends JSON events to syslog
description:
  - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format.
options:
  server:
    description: Syslog server that receives the event.
    type: str
    env:
      - name: SYSLOG_SERVER
    default: localhost
    ini:
      - section: callback_syslog_json
        key: syslog_server
  port:
    description: Port on which the syslog server is listening.
    type: int
    env:
      - name: SYSLOG_PORT
    default: 514
    ini:
      - section: callback_syslog_json
        key: syslog_port
  facility:
    description: Syslog facility to log as.
    type: str
    env:
      - name: SYSLOG_FACILITY
    default: user
    ini:
      - section: callback_syslog_json
        key: syslog_facility
  setup:
    description: Log setup tasks.
    env:
      - name: ANSIBLE_SYSLOG_SETUP
    type: bool
    default: true
    ini:
      - section: callback_syslog_json
        key: syslog_setup
    version_added: 4.5.0
"""

import logging
import logging.handlers

import socket

from ansible.plugins.callback import CallbackBase


class CallbackModule(CallbackBase):
    """
    logs ansible-playbook and ansible runs to a syslog server in json format
    """

    CALLBACK_VERSION = 2.0
    CALLBACK_TYPE = "notification"
    CALLBACK_NAME = "community.general.syslog_json"
    CALLBACK_NEEDS_WHITELIST = True

    def __init__(self):
        super().__init__()

    def set_options(self, task_keys=None, var_options=None, direct=None):
        super().set_options(task_keys=task_keys, var_options=var_options, direct=direct)

        syslog_host = self.get_option("server")
        syslog_port = int(self.get_option("port"))
        syslog_facility = self.get_option("facility")

        self.logger = logging.getLogger("ansible logger")
        self.logger.setLevel(logging.DEBUG)

        self.handler = logging.handlers.SysLogHandler(address=(syslog_host, syslog_port), facility=syslog_facility)
        self.logger.addHandler(self.handler)
        self.hostname = socket.gethostname()

    def v2_runner_on_failed(self, result, ignore_errors=False):
        res = result._result
        host = result._host.get_name()
        self.logger.error(
            "%s ansible-command: task execution FAILED; host: %s; message: %s",
            self.hostname,
            host,
            self._dump_results(res),
        )

    def v2_runner_on_ok(self, result):
        res = result._result
        host = result._host.get_name()
        if result._task.action != "gather_facts" or self.get_option("setup"):
            self.logger.info(
                "%s ansible-command: task execution OK; host: %s; message: %s",
                self.hostname,
                host,
                self._dump_results(res),
            )

    def v2_runner_on_skipped(self, result):
        host = result._host.get_name()
        self.logger.info(
            "%s ansible-command: task execution SKIPPED; host: %s; message: %s", self.hostname, host, "skipped"
        )

    def v2_runner_on_unreachable(self, result):
        res = result._result
        host = result._host.get_name()
        self.logger.error(
            "%s ansible-command: task execution UNREACHABLE; host: %s; message: %s",
            self.hostname,
            host,
            self._dump_results(res),
        )

    def v2_runner_on_async_failed(self, result):
        res = result._result
        host = result._host.get_name()
        # jid = result._result.get("ansible_job_id")
        self.logger.error(
            "%s ansible-command: task execution FAILED; host: %s; message: %s",
            self.hostname,
            host,
            self._dump_results(res),
        )

    def v2_playbook_on_import_for_host(self, result, imported_file):
        host = result._host.get_name()
        self.logger.info(
            "%s ansible-command: playbook IMPORTED; host: %s; message: imported file %s",
            self.hostname,
            host,
            imported_file,
        )

    def v2_playbook_on_not_import_for_host(self, result, missing_file):
        host = result._host.get_name()
        self.logger.info(
            "%s ansible-command: playbook NOT IMPORTED; host: %s; message: missing file %s",
            self.hostname,
            host,
            missing_file,
        )