mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-06 17:21:30 -07:00
2ef7759be1
* Allow syslog_json callback options to be set in an Ansible configuration file. The syslog_json documentation says that it supports options via an Ansible configuration file. In fact, they can only be specified via environment variables. I've updated the module to use the standard "get_options" handling which means that it can now support options via environment variables *or* the configuration file. Options can be set in the configuration file as follows: ``` callback_whitelist = syslog_json [callback_syslog_json] syslog_server = localhost syslog_port = 514 syslog_facility = user ``` * Use the original, documented, names for the modules options. In the documentation text change syslog_server to server, syslog_port to port and syslog_facility to facility. * Add an item to the changelog. * Update 57232-syslog-json-configuration-options.yml Fix a YAML syntax error / typo.
105 lines
3.6 KiB
Python
105 lines
3.6 KiB
Python
# (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
callback: syslog_json
|
|
callback_type: notification
|
|
requirements:
|
|
- whitelist in configuration
|
|
short_description: sends JSON events to syslog
|
|
version_added: "1.9"
|
|
description:
|
|
- This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format
|
|
- Before 2.9 only environment variables were available for configuration
|
|
options:
|
|
server:
|
|
description: syslog server that will receive the event
|
|
env:
|
|
- name: SYSLOG_SERVER
|
|
default: localhost
|
|
ini:
|
|
- section: callback_syslog_json
|
|
key: syslog_server
|
|
port:
|
|
description: port on which the syslog server is listening
|
|
env:
|
|
- name: SYSLOG_PORT
|
|
default: 514
|
|
ini:
|
|
- section: callback_syslog_json
|
|
key: syslog_port
|
|
facility:
|
|
description: syslog facility to log as
|
|
env:
|
|
- name: SYSLOG_FACILITY
|
|
default: user
|
|
ini:
|
|
- section: callback_syslog_json
|
|
key: syslog_facility
|
|
'''
|
|
|
|
import os
|
|
import json
|
|
|
|
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 = 'aggregate'
|
|
CALLBACK_NAME = 'syslog_json'
|
|
CALLBACK_NEEDS_WHITELIST = True
|
|
|
|
def __init__(self):
|
|
|
|
super(CallbackModule, self).__init__()
|
|
|
|
self.set_options()
|
|
|
|
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 runner_on_failed(self, host, res, ignore_errors=False):
|
|
self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s', self.hostname, host, self._dump_results(res))
|
|
|
|
def runner_on_ok(self, host, res):
|
|
self.logger.info('%s ansible-command: task execution OK; host: %s; message: %s', self.hostname, host, self._dump_results(res))
|
|
|
|
def runner_on_skipped(self, host, item=None):
|
|
self.logger.info('%s ansible-command: task execution SKIPPED; host: %s; message: %s', self.hostname, host, 'skipped')
|
|
|
|
def runner_on_unreachable(self, host, res):
|
|
self.logger.error('%s ansible-command: task execution UNREACHABLE; host: %s; message: %s', self.hostname, host, self._dump_results(res))
|
|
|
|
def runner_on_async_failed(self, host, res, jid):
|
|
self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s', self.hostname, host, self._dump_results(res))
|
|
|
|
def playbook_on_import_for_host(self, host, imported_file):
|
|
self.logger.info('%s ansible-command: playbook IMPORTED; host: %s; message: imported file %s', self.hostname, host, imported_file)
|
|
|
|
def playbook_on_not_import_for_host(self, host, missing_file):
|
|
self.logger.info('%s ansible-command: playbook NOT IMPORTED; host: %s; message: missing file %s', self.hostname, host, missing_file)
|