301 lines
10 KiB
Python
301 lines
10 KiB
Python
# (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
|
|
# based on the log_plays example
|
|
# skvidal@fedoraproject.org
|
|
|
|
# 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 <http://www.gnu.org/licenses/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = r'''
|
|
callback: logdetail
|
|
callback_type: notification
|
|
short_description: Logs playbook results, per date, playbook and host.
|
|
description: Logs playbook results, per date, playbook and host, in I(log_path).
|
|
options:
|
|
log_path:
|
|
description: The path where log files will be created.
|
|
default: /var/log/ansible
|
|
ini:
|
|
- section: callback_logdetail
|
|
key: log_path
|
|
env:
|
|
- name: ANSIBLE_LOGDETAIL_PATH
|
|
'''
|
|
|
|
import os
|
|
import time
|
|
import json
|
|
import pwd
|
|
import gzip
|
|
|
|
try:
|
|
from ansible.utils.hashing import secure_hash
|
|
except ImportError:
|
|
from ansible.utils import md5 as secure_hash
|
|
|
|
try:
|
|
from ansible.plugins.callback import CallbackBase
|
|
except ImportError:
|
|
# Ansible v1 compat
|
|
CallbackBase = object
|
|
|
|
TIME_FORMAT = "%b %d %Y %H:%M:%S"
|
|
|
|
MSG_FORMAT = "%(now)s\t%(count)s\t%(category)s\t%(name)s\t%(data)s\n"
|
|
|
|
|
|
def getlogin():
|
|
try:
|
|
user = os.getlogin()
|
|
except OSError as e:
|
|
user = pwd.getpwuid(os.geteuid())[0]
|
|
return user
|
|
|
|
|
|
class LogMech(object):
|
|
def __init__(self, logpath):
|
|
self.started = time.time()
|
|
self.pid = str(os.getpid())
|
|
self._pb_fn = None
|
|
self._last_task_start = None
|
|
self.play_info = {}
|
|
self.logpath = logpath
|
|
if not os.path.exists(self.logpath):
|
|
try:
|
|
os.makedirs(self.logpath, mode=0o750)
|
|
except OSError as e:
|
|
if e.errno != 17:
|
|
raise
|
|
|
|
# checksum of full playbook?
|
|
|
|
@property
|
|
def playbook_id(self):
|
|
if self._pb_fn:
|
|
return os.path.basename(self._pb_fn).replace('.yml', '').replace('.yaml', '')
|
|
else:
|
|
return "ansible-cmd"
|
|
|
|
@playbook_id.setter
|
|
def playbook_id(self, value):
|
|
self._pb_fn = value
|
|
|
|
@property
|
|
def logpath_play(self):
|
|
# this is all to get our path to look nice ish
|
|
tstamp = time.strftime('%Y/%m/%d/%H.%M.%S', time.localtime(self.started))
|
|
path = os.path.normpath(self.logpath + '/' + self.playbook_id + '/' + tstamp + '/')
|
|
|
|
if not os.path.exists(path):
|
|
try:
|
|
os.makedirs(path)
|
|
except OSError as e:
|
|
if e.errno != 17: # if it is not dir exists then raise it up
|
|
raise
|
|
|
|
return path
|
|
|
|
def play_log(self, content):
|
|
# record out playbook.log
|
|
# include path to playbook, checksums, user running playbook
|
|
# any args we can get back from the invocation
|
|
fd = open(self.logpath_play + '/' + 'playbook-' + self.pid + '.info', 'a')
|
|
fd.write('%s\n' % content)
|
|
fd.close()
|
|
|
|
def task_to_json(self, task):
|
|
res = {}
|
|
res['task_name'] = task.name
|
|
res['task_module'] = task.action
|
|
res['task_args'] = task.args
|
|
if self.playbook_id == 'ansible-cmd':
|
|
res['task_userid'] = getlogin()
|
|
for k in ("delegate_to", "environment", "with_first_found",
|
|
"local_action", "notified_by", "notify",
|
|
"register", "sudo", "sudo_user", "tags",
|
|
"transport", "when"):
|
|
v = getattr(task, k, None)
|
|
if v:
|
|
res['task_' + k] = v
|
|
|
|
return res
|
|
|
|
def log(self, host, category, data, task=None, count=0):
|
|
if not host:
|
|
host = 'HOSTMISSING'
|
|
|
|
if type(data) == dict:
|
|
name = data.get('module_name', None)
|
|
else:
|
|
name = "unknown"
|
|
|
|
# we're in setup - move the invocation info up one level
|
|
if 'invocation' in data:
|
|
invoc = data['invocation']
|
|
if not name and 'module_name' in invoc:
|
|
name = invoc['module_name']
|
|
|
|
# don't add this since it can often contain complete passwords :(
|
|
del(data['invocation'])
|
|
|
|
if task:
|
|
name = task._name
|
|
data['task_start'] = self._last_task_start
|
|
data['task_end'] = time.time()
|
|
data.update(self.task_to_json(task))
|
|
|
|
if 'task_userid' not in data:
|
|
data['task_userid'] = getlogin()
|
|
|
|
if category == 'OK' and data.get('changed', False):
|
|
category = 'CHANGED'
|
|
|
|
if self.play_info.get('check', False) and self.play_info.get('diff', False):
|
|
category = 'CHECK_DIFF:' + category
|
|
elif self.play_info.get('check', False):
|
|
category = 'CHECK:' + category
|
|
|
|
# Sometimes this is None.. othertimes it's fine. Othertimes it has
|
|
# trailing whitespace that kills logview. Strip that, when possible.
|
|
if name:
|
|
name = name.strip()
|
|
|
|
sanitize_host = host.replace(' ', '_').replace('>', '-')
|
|
fd = gzip.open(self.logpath_play + '/' + sanitize_host + '.log.gz', 'at')
|
|
now = time.strftime(TIME_FORMAT, time.localtime())
|
|
fd.write(MSG_FORMAT % dict(now=now, name=name, count=count, category=category, data=json.dumps(data)))
|
|
fd.close()
|
|
|
|
|
|
class CallbackModule(CallbackBase):
|
|
"""
|
|
logs playbook results, per host, in /var/log/ansible/hosts
|
|
"""
|
|
CALLBACK_NAME = 'logdetail'
|
|
CALLBACK_TYPE = 'notification'
|
|
CALLBACK_VERSION = 2.0
|
|
CALLBACK_NEEDS_WHITELIST = True
|
|
|
|
def __init__(self):
|
|
self._task_count = 0
|
|
self._play_count = 0
|
|
self.task = None
|
|
self.playbook = None
|
|
|
|
super(CallbackModule, self).__init__()
|
|
self.set_options()
|
|
self.logmech = LogMech(self.get_option('log_path'))
|
|
|
|
def set_play_context(self, play_context):
|
|
self.play_context = play_context
|
|
|
|
def v2_runner_on_failed(self, result, ignore_errors=False):
|
|
category = 'FAILED'
|
|
self.logmech.log(result._host.get_name(), category, result._result, self.task, self._task_count)
|
|
|
|
def v2_runner_on_ok(self, result):
|
|
category = 'OK'
|
|
self.logmech.log(result._host.get_name(), category, result._result, self.task, self._task_count)
|
|
|
|
def v2_runner_on_skipped(self, result):
|
|
category = 'SKIPPED'
|
|
res = {}
|
|
res['item'] = self._get_item_label(getattr(result._result, 'results', {}))
|
|
self.logmech.log(result._host.get_name(), category, res, self.task, self._task_count)
|
|
|
|
def v2_runner_on_unreachable(self, result):
|
|
category = 'UNREACHABLE'
|
|
res = {}
|
|
res['output'] = result._result
|
|
self.logmech.log(result._host.get_name(), category, res, self.task, self._task_count)
|
|
|
|
def v2_runner_on_async_failed(self, result):
|
|
category = 'ASYNC_FAILED'
|
|
self.logmech.log(result._host.get_name(), category, result._result, self.task, self._task_count)
|
|
|
|
def v2_playbook_on_start(self, playbook):
|
|
self.playbook = playbook
|
|
|
|
def v2_playbook_on_task_start(self, task, is_conditional):
|
|
self.task = task
|
|
if self.task:
|
|
self.task._name = task.get_name().strip()
|
|
self.logmech._last_task_start = time.time()
|
|
self._task_count += 1
|
|
|
|
def v2_playbook_on_setup(self):
|
|
self._task_count += 1
|
|
|
|
def v2_playbook_on_import_for_host(self, result, imported_file):
|
|
res = {}
|
|
res['imported_file'] = imported_file
|
|
self.logmech.log(result._host.get_name(), 'IMPORTED', res, self.task)
|
|
|
|
def v2_playbook_on_not_import_for_host(self, result, missing_file):
|
|
res = {}
|
|
res['missing_file'] = missing_file
|
|
self.logmech.log(result._host.get_name(), 'NOTIMPORTED', res, self.task)
|
|
|
|
def v2_playbook_on_play_start(self, play):
|
|
self._task_count = 0
|
|
|
|
if play:
|
|
# figure out where the playbook FILE is
|
|
path = os.path.abspath(self.playbook._file_name)
|
|
|
|
# tel the logger what the playbook is
|
|
self.logmech.playbook_id = path
|
|
|
|
# if play count == 0
|
|
# write out playbook info now
|
|
if not self._play_count:
|
|
pb_info = {}
|
|
pb_info['playbook_start'] = time.time()
|
|
pb_info['playbook'] = path
|
|
pb_info['userid'] = getlogin()
|
|
pb_info['extra_vars'] = play._variable_manager.extra_vars
|
|
pb_info['inventory'] = play._variable_manager._inventory._sources
|
|
pb_info['playbook_checksum'] = secure_hash(path)
|
|
if hasattr(self, "play_context"):
|
|
pb_info['check'] = self.play_context.check_mode
|
|
pb_info['diff'] = self.play_context.diff
|
|
self.logmech.play_log(json.dumps(pb_info, indent=4))
|
|
|
|
self._play_count += 1
|
|
# then write per-play info that doesn't duplcate the playbook info
|
|
info = {}
|
|
info['play'] = play.name
|
|
info['hosts'] = play.hosts
|
|
info['number'] = self._play_count
|
|
if hasattr(self, "play_context"):
|
|
info['transport'] = str(self.play_context.connection)
|
|
info['check'] = self.play_context.check_mode
|
|
info['diff'] = self.play_context.diff
|
|
self.logmech.play_info = info
|
|
try:
|
|
self.logmech.play_log(json.dumps(info, indent=4))
|
|
except TypeError:
|
|
print(("Failed to conver to JSON:", info))
|
|
|
|
def v2_playbook_on_stats(self, stats):
|
|
results = {}
|
|
for host in list(stats.processed.keys()):
|
|
results[host] = stats.summarize(host)
|
|
self.logmech.log(host, 'STATS', results[host])
|
|
self.logmech.play_log(json.dumps({'stats': results}, indent=4))
|
|
self.logmech.play_log(json.dumps({'playbook_end': time.time()}, indent=4))
|
|
print(('logs written to: %s' % self.logmech.logpath_play))
|