-
-
Save cliffano/9868180 to your computer and use it in GitHub Desktop.
# This gist is compatible with Ansible 1.x . | |
# For Ansible 2.x , please check out: | |
# - https://gist.github.com/dmsimard/cd706de198c85a8255f6 | |
# - https://github.com/n0ts/ansible-human_log | |
# This program 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. | |
# | |
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>. | |
FIELDS = ['cmd', 'command', 'start', 'end', 'delta', 'msg', 'stdout', 'stderr'] | |
def human_log(res): | |
if type(res) == type(dict()): | |
for field in FIELDS: | |
if field in res.keys(): | |
# use default encoding, check out sys.setdefaultencoding | |
print u'\n{0}:\n{1}'.format(field, res[field]) | |
# or use specific encoding, e.g. utf-8 | |
#print '\n{0}:\n{1}'.format(field, res[field].encode('utf-8')) | |
class CallbackModule(object): | |
def on_any(self, *args, **kwargs): | |
pass | |
def runner_on_failed(self, host, res, ignore_errors=False): | |
human_log(res) | |
def runner_on_ok(self, host, res): | |
human_log(res) | |
def runner_on_error(self, host, msg): | |
pass | |
def runner_on_skipped(self, host, item=None): | |
pass | |
def runner_on_unreachable(self, host, res): | |
human_log(res) | |
def runner_on_no_hosts(self): | |
pass | |
def runner_on_async_poll(self, host, res, jid, clock): | |
human_log(res) | |
def runner_on_async_ok(self, host, res, jid): | |
human_log(res) | |
def runner_on_async_failed(self, host, res, jid): | |
human_log(res) | |
def playbook_on_start(self): | |
pass | |
def playbook_on_notify(self, host, handler): | |
pass | |
def playbook_on_no_hosts_matched(self): | |
pass | |
def playbook_on_no_hosts_remaining(self): | |
pass | |
def playbook_on_task_start(self, name, is_conditional): | |
pass | |
def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None): | |
pass | |
def playbook_on_setup(self): | |
pass | |
def playbook_on_import_for_host(self, host, imported_file): | |
pass | |
def playbook_on_not_import_for_host(self, host, missing_file): | |
pass | |
def playbook_on_play_start(self, pattern): | |
pass | |
def playbook_on_stats(self, stats): | |
pass |
Hi, I support ansible 2.0 human_log.py.
https://github.com/n0ts/ansible-human_log
Thanks.
I´m always getting the following error:
[WARNING]: Error when using <bound method CallbackModule.v2_runner_on_ok of
</Users/alexlawrence/projects/efa/sixsteps/sources/ansible/callback_plugins/human_log.CallbackModule object at 0x10dfcbd90>>: 'ascii' codec can't encode character u'\u03bc'
in position 696: ordinal not in range(128)
Tried both of the mentioned Version 2 compatible versions. Why is that?
Hi,
For me, it doesn't work at all:
PLAY [all] ********************************************************************
TASK: [shell ls -l /home/testuser1] ********************************************
<192.168.1.11> ESTABLISH CONNECTION FOR USER: testuser1
<192.168.1.11> REMOTE_MODULE command ls -l /home/testuser1 #USE_SHELL
<192.168.1.11> EXEC ssh -C -tt -vvv -o ControlMaster=auto -o ControlPersist=60s -o ControlPath="/home/testuser1/.ansible/cp/ansible-ssh-%h-%p-%r" -o Port=22 -o KbdInteractiveAuthentication=no -o PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey -o PasswordAuthentication=no -o ConnectTimeout=60 192.168.1.11 /bin/sh -c 'mkdir -p $HOME/.ansible/tmp/ansible-tmp-1459331257.64-268749318559137 && chmod a+rx $HOME/.ansible/tmp/ansible-tmp-1459331257.64-268749318559137 && echo $HOME/.ansible/tmp/ansible-tmp-1459331257.64-268749318559137'
<192.168.1.11> PUT /tmp/tmpEHSdFS TO /home/testuser1/.ansible/tmp/ansible-tmp-1459331257.64-268749318559137/command
<192.168.1.11> EXEC ssh -C -tt -vvv -o ControlMaster=auto -o ControlPersist=60s -o ControlPath="/home/testuser1/.ansible/cp/ansible-ssh-%h-%p-%r" -o Port=22 -o KbdInteractiveAuthentication=no -o PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey -o PasswordAuthentication=no -o ConnectTimeout=60 192.168.1.11 /bin/sh -c 'LANG=C LC_CTYPE=C /usr/bin/python /home/testuser1/.ansible/tmp/ansible-tmp-1459331257.64-268749318559137/command; rm -rf /home/testuser1/.ansible/tmp/ansible-tmp-1459331257.64-268749318559137/ >/dev/null 2>&1'
changed: [192.168.1.11] => {"changed": true, "cmd": "ls -l /home/testuser1", "delta": "0:00:00.007463", "end": "2016-03-30 09:48:50.682502", "rc": 0, "start": "2016-03-30 09:48:50.675039", "stderr": "", "stdout": "total 0", "warnings": []}
TASK: [shell pwd] *************************************************************
<192.168.1.11> ESTABLISH CONNECTION FOR USER: testuser1
<192.168.1.11> REMOTE_MODULE command pwd #USE_SHELL
<192.168.1.11> EXEC ssh -C -tt -vvv -o ControlMaster=auto -o ControlPersist=60s -o ControlPath="/home/testuser1/.ansible/cp/ansible-ssh-%h-%p-%r" -o Port=22 -o KbdInteractiveAuthentication=no -o PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey -o PasswordAuthentication=no -o ConnectTimeout=60 192.168.1.11 /bin/sh -c 'mkdir -p $HOME/.ansible/tmp/ansible-tmp-1459331279.72-7524347037387 && chmod a+rx $HOME/.ansible/tmp/ansible-tmp-1459331279.72-7524347037387 && echo $HOME/.ansible/tmp/ansible-tmp-1459331279.72-7524347037387'
<192.168.1.11> PUT /tmp/tmpJNMLJj TO /home/testuser1/.ansible/tmp/ansible-tmp-1459331279.72-7524347037387/command
<192.168.1.11> EXEC ssh -C -tt -vvv -o ControlMaster=auto -o ControlPersist=60s -o ControlPath="/home/testuser1/.ansible/cp/ansible-ssh-%h-%p-%r" -o Port=22 -o KbdInteractiveAuthentication=no -o PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey -o PasswordAuthentication=no -o ConnectTimeout=60 192.168.1.11 /bin/sh -c 'LANG=C LC_CTYPE=C /usr/bin/python /home/testuser1/.ansible/tmp/ansible-tmp-1459331279.72-7524347037387/command; rm -rf /home/testuser1/.ansible/tmp/ansible-tmp-1459331279.72-7524347037387/ >/dev/null 2>&1'
changed: [192.168.1.11] => {"changed": true, "cmd": "pwd", "delta": "0:00:00.004878", "end": "2016-03-30 09:48:51.042734", "rc": 0, "start": "2016-03-30 09:48:51.037856", "stderr": "", "stdout": "/home/testuser1", "warnings": []}
TASK: [shell uname -r] ********************************************************
<192.168.1.11> ESTABLISH CONNECTION FOR USER: testuser1
<192.168.1.11> REMOTE_MODULE command uname -r #USE_SHELL
<192.168.1.11> EXEC ssh -C -tt -vvv -o ControlMaster=auto -o ControlPersist=60s -o ControlPath="/home/testuser1/.ansible/cp/ansible-ssh-%h-%p-%r" -o Port=22 -o KbdInteractiveAuthentication=no -o PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey -o PasswordAuthentication=no -o ConnectTimeout=60 192.168.1.11 /bin/sh -c 'mkdir -p $HOME/.ansible/tmp/ansible-tmp-1459331280.07-169513232619370 && chmod a+rx $HOME/.ansible/tmp/ansible-tmp-1459331280.07-169513232619370 && echo $HOME/.ansible/tmp/ansible-tmp-1459331280.07-169513232619370'
<192.168.1.11> PUT /tmp/tmp0ENH6t TO /home/testuser1/.ansible/tmp/ansible-tmp-1459331280.07-169513232619370/command
<192.168.1.11> EXEC ssh -C -tt -vvv -o ControlMaster=auto -o ControlPersist=60s -o ControlPath="/home/testuser1/.ansible/cp/ansible-ssh-%h-%p-%r" -o Port=22 -o KbdInteractiveAuthentication=no -o PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey -o PasswordAuthentication=no -o ConnectTimeout=60 192.168.1.11 /bin/sh -c 'LANG=C LC_CTYPE=C /usr/bin/python /home/testuser1/.ansible/tmp/ansible-tmp-1459331280.07-169513232619370/command; rm -rf /home/testuser1/.ansible/tmp/ansible-tmp-1459331280.07-169513232619370/ >/dev/null 2>&1'
changed: [192.168.1.11] => {"changed": true, "cmd": "uname -r", "delta": "0:00:00.006859", "end": "2016-03-30 09:48:51.417846", "rc": 0, "start": "2016-03-30 09:48:51.410987", "stderr": "", "stdout": "2.6.39-400.250.2.el6uek.x86_64", "warnings": []}
PLAY RECAP ********************************************************************
192.168.1.11 : ok=3 changed=3 unreachable=0 failed=0
It was raised in the past, but after updating it to support 2.0, why not pushing it to ansible (probably ansible-modules-extra)? It would be nice to have it available by default!
+1 for pushing it to ansible
ansible 2.1.1.0 don't support
[WARNING]: Failure using method (v2_runner_on_ok) in callback plugin (</usr/share/ansible_plugins/callback_plugins/human_log.CallbackModule object at 0x7fbf1d78f910>): runner_on_ok() takes
exactly 3 arguments (2 given)
How to get rid of the double output? example: http://hastebin.com/obejuximun
@snevs: I tried this with ansible 1.9 and the only way I could have double output was by using -v flags.
So omit them and the double output is gone :)
Re: double output. It's just how plugins work - see https://gist.github.com/dmsimard/cd706de198c85a8255f6#gistcomment-1908752
i have same issue like @stevenlee87 . Does it work for anyone running v 2.1+ ?
Such an output plugin was merged in Ansible and has been released in 2.2.
To enable it, just export ANSIBLE_STDOUT_CALLBACK=debug
environment variable.
@DanyC97: this version should work with 2.1, otherwise try something like this: https://github.com/openshift/openshift-ansible/blob/master/callback_plugins/default.py
@jpic big thanks to you!
@jpic thank you !
@cliffano Using this, I get clean output but the output is not stored in ansible.log
Is there a way around that I use this callback, and also store logs in ansible.log
, without having to print the output twice?
thank you for this!
May I ask how to use this ???
ansible -m ping all -vvvv
has error on my machine, but the log is too long, I have no idea how to pretty print it.
@jpic Many thanks!
@alexlawrence do you have the error ( 'ascii' codec can't encode character u'\u03bc'
in position 696: ordinal not in range(128)) resolved? if so, would you please share the fix.
echoing the tanks here to @jpic - I had forked a version of this same plugin downstream from someone else only to find that with the version of ansible I am currently using 2.4.3.0
it was not even needed!
ansible/ansible#27078 (comment)
https://github.com/ansible/ansible/blob/v2.4.3.0-1/lib/ansible/plugins/callback/debug.py
Hi, i am new to Ansible. Can you please list the steps how to use it.
I have a playbook and i need to hook up this callback plugin to my playbook to create a log files.
any advise will be highly appreciated!!
The object has no property 'CallbackModule', I configured my ansible_plugins path to the callback plug-in, and now report this error.Please check it for me
I forked a version that is compatible with Ansible 2 and also gives special treatment to the "results" field that is used by the yum and dnf modules.
It's here: https://gist.github.com/dmsimard/cd706de198c85a8255f6