# (C) 2016, Ievgen Khmelenko # # This file is part of Ansible # # Ansible is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Ansible is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Ansible. If not, see . from __future__ import (absolute_import, division, print_function) __metaclass__ = type import os import json import socket import uuid import logging try: import logstash HAS_LOGSTASH = True except ImportError: HAS_LOGSTASH = False from ansible.plugins.callback import CallbackBase class CallbackModule(CallbackBase): """ ansible logstash callback plugin ansible.cfg: callback_plugins = callback_whitelist = logstash and put the plugin in logstash config: input { tcp { port => 5000 codec => json } } Requires: python-logstash This plugin makes use of the following environment variables: LOGSTASH_SERVER (optional): defaults to localhost LOGSTASH_PORT (optional): defaults to 5000 LOGSTASH_TYPE (optional): defaults to ansible """ CALLBACK_VERSION = 2.0 CALLBACK_TYPE = 'aggregate' CALLBACK_NAME = 'logstash' CALLBACK_NEEDS_WHITELIST = True def __init__(self): super(CallbackModule, self).__init__() if not HAS_LOGSTASH: self.disabled = True self._display.warning("The required python-logstash is not installed. " "pip install python-logstash") else: self.logger = logging.getLogger('python-logstash-logger') self.logger.setLevel(logging.DEBUG) self.handler = logstash.TCPLogstashHandler( os.getenv('LOGSTASH_SERVER', 'localhost'), int(os.getenv('LOGSTASH_PORT', 5000)), version=1, message_type=os.getenv('LOGSTASH_TYPE', 'ansible') ) self.logger.addHandler(self.handler) self.hostname = socket.gethostname() self.session = str(uuid.uuid1()) self.errors = 0 def v2_playbook_on_start(self, playbook): self.playbook = playbook._file_name data = { 'status': "OK", 'host': self.hostname, 'session': self.session, 'ansible_type': "start", 'ansible_playbook': self.playbook, } self.logger.info("ansible start", extra=data) def v2_playbook_on_stats(self, stats): summarize_stat = {} for host in stats.processed.keys(): summarize_stat[host] = stats.summarize(host) if self.errors == 0: status = "OK" else: status = "FAILED" data = { 'status': status, 'host': self.hostname, 'session': self.session, 'ansible_type': "finish", 'ansible_playbook': self.playbook, 'ansible_result': json.dumps(summarize_stat), } self.logger.info("ansible stats", extra=data) def v2_runner_on_ok(self, result, **kwargs): data = { 'status': "OK", 'host': self.hostname, 'session': self.session, 'ansible_type': "task", 'ansible_playbook': self.playbook, 'ansible_host': result._host.name, 'ansible_task': result._task, 'ansible_result': self._dump_results(result._result) } self.logger.info("ansible ok", extra=data) def v2_runner_on_skipped(self, result, **kwargs): data = { 'status': "SKIPPED", 'host': self.hostname, 'session': self.session, 'ansible_type': "task", 'ansible_playbook': self.playbook, 'ansible_task': result._task, 'ansible_host': result._host.name } self.logger.info("ansible skipped", extra=data) def v2_playbook_on_import_for_host(self, result, imported_file): data = { 'status': "IMPORTED", 'host': self.hostname, 'session': self.session, 'ansible_type': "import", 'ansible_playbook': self.playbook, 'ansible_host': result._host.name, 'imported_file': imported_file } self.logger.info("ansible import", extra=data) def v2_playbook_on_not_import_for_host(self, result, missing_file): data = { 'status': "NOT IMPORTED", 'host': self.hostname, 'session': self.session, 'ansible_type': "import", 'ansible_playbook': self.playbook, 'ansible_host': result._host.name, 'missing_file': missing_file } self.logger.info("ansible import", extra=data) def v2_runner_on_failed(self, result, **kwargs): data = { 'status': "FAILED", 'host': self.hostname, 'session': self.session, 'ansible_type': "task", 'ansible_playbook': self.playbook, 'ansible_host': result._host.name, 'ansible_task': result._task, 'ansible_result': self._dump_results(result._result) } self.errors += 1 self.logger.error("ansible failed", extra=data) def v2_runner_on_unreachable(self, result, **kwargs): data = { 'status': "UNREACHABLE", 'host': self.hostname, 'session': self.session, 'ansible_type': "task", 'ansible_playbook': self.playbook, 'ansible_host': result._host.name, 'ansible_task': result._task, 'ansible_result': self._dump_results(result._result) } self.logger.error("ansbile unreachable", extra=data) def v2_runner_on_async_failed(self, result, **kwargs): data = { 'status': "FAILED", 'host': self.hostname, 'session': self.session, 'ansible_type': "task", 'ansible_playbook': self.playbook, 'ansible_host': result._host.name, 'ansible_task': result._task, 'ansible_result': self._dump_results(result._result) } self.errors += 1 self.logger.error("ansible async", extra=data)