How do I get logs details of ansible-playbook module executions

Question

Say I execute the following     cat test sh    bin bash echo Hello World exit 0    cat Hello yml ---  - hosts  MyTestHost   tasks    - name  Hello yourself     script  test sh     ansible-playbook  Hello yml  PLAY  MyTestHost                                                                    GATHERING FACTS                                                                 ok   MyTestHost   TASK   Hello yourself                                                           ok   MyTestHost   PLAY RECAP                                                                      MyTestHost                      ok 2    changed 0    unreachable 0    failed 0      I know for sure that it was successful   Where how do I see the  Hello World  echo ed printed by my script on the remote host  MyTestHost   Or the return exit code of script   My research shows me it would be possible to write a plugin to intercept module execution callbacks or something on those lines and write a log file  I would prefer to not waste my time with that   E g  something like the stdout in below  note that I m running ansible and not ansible-playbook      ansible plabb54 -i  project plab svn plab-maintenance ansible plab hosts txt -m script -a   test sh plabb54   success  gt  gt         rc   0       stderr            stdout    Hello World n

User · Answer

Using callback plugins  you can have the stdout of your commands output in readable form with the play  gist  human log py     Edit for example output                                            lt  TASK  common   install apt packages  gt   -------------------------------------                               oo                                                         ----w                               changed   10 76 71 167    gt   item htop vim-tiny curl git unzip update-motd ssh-askpass gcc python-dev libxml2 libxml2-dev libxslt-dev python-lxml python-pip   stdout  Reading package lists    Building dependency tree    Reading state information    libxslt1-dev is already the newest version  0 upgraded  0 newly installed  0 to remove and 24 not upgraded    stderr   start  2015-03-27 17 12 22 132237  end  2015-03-27 17 12 22 136859

User · Answer

There is also other way to generate log file   Before running ansible-playbook run the following commands to enable logging    Specify the location for the log file       export ANSIBLE LOG PATH   ansible log   Enable Debug      export ANSIBLE DEBUG True   To check that generated log file      less  ANSIBLE LOG PATH

User · Answer

Offical plugins  You can use the output callback plugins  For example  starting in Ansible 2 4  you can use the debug output callback plugin     In ansible cfg   defaults  stdout callback   debug    Altervatively  run export ANSIBLE STDOUT CALLBACK debug before running your playbook   Important  you must run ansible-playbook with the -v  --verbose  option to see the effect  With stdout callback   debug set  the output should now look something like this   TASK  Say Hello                                   changed   192 168 1 2    gt         changed   true       rc   0    STDOUT    Hello     STDERR   Shared connection to 192 168 1 2 closed    There are other modules besides the debug module if you want the output to be formatted differently  There s json  yaml  unixy  dense  minimal  etc   full list    For example  with stdout callback   yaml  the output will look something like this   TASK  Say Hello                                     changed   192 168 1 2    gt  changed true    rc  0   stderr   -     Shared connection to 192 168 1 2 closed    stderr lines    - Shared connection to 192 168 1 2 closed    stdout   2-      Hello    stdout lines   lt omitted gt    Third-party plugins  If none of the official plugins are satisfactory  you can try the human log plugin  There are a few versions    https   github com n0ts ansible-human log https   gist github com cliffano 9868180

User · Answer

If you pass the -v flag to ansible-playbook on the command line  you ll see the stdout and stderr for each task executed     ansible-playbook -v playbook yaml   Ansible also has built-in support for logging  Add the following lines to your ansible configuration file    defaults   log path  path to logfile   Ansible will look in several places for the config file    ansible cfg in the current directory where you ran ansible-playbook    ansible cfg  etc ansible ansible cfg

User · Answer

The playbook script task will generate stdout just like the non-playbook command  it just needs to be saved to a variable using register  Once we ve got that  the debug module can print to the playbook output stream    tasks  - name  Hello yourself   script  test sh   register  hello  - name  Debug hello   debug  var hello  - name  Debug hello stdout as part of a string   debug   msg The script s stdout was     hello stdout         Output should look something like this   TASK   Hello yourself                                                            changed   MyTestHost   TASK   Debug hello                                                               ok   MyTestHost    gt         hello              changed   true            invocation                  module args    test sh                 module name    script                       rc   0            stderr                 stdout    Hello World r n             stdout lines                  Hello World                     TASK   Debug hello stdout as part of a string                                    ok   MyTestHost    gt         msg    The script s stdout was  Hello World r n

User · Answer

Ansible command-line help  such as ansible-playbook --help shows how to increase output verbosity by setting the verbose mode  -v  to more verbosity  -vvv  or to connection debugging verbosity  -vvvv   This should give you some of the details you re after in stdout  which you can then be logged

[logging] How do I get logs/details of ansible-playbook module executions?

Examples related to logging

Examples related to ansible