https://github.com/octplane/ansible_stdout_compact_logger

Ansible Stdout Compact Logger
https://github.com/octplane/ansible_stdout_compact_logger

ansible logging

Last synced: 5 months ago
JSON representation

Ansible Stdout Compact Logger

• Host: GitHub
• URL: https://github.com/octplane/ansible_stdout_compact_logger
• Owner: octplane
• License: mit
• Created: 2016-12-29T09:22:59.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-03-09T20:41:46.000Z (about 2 years ago)
• Last Synced: 2024-08-03T09:05:33.140Z (8 months ago)
• Topics: ansible, logging
• Language: Python
• Size: 614 KB
• Stars: 205
• Watchers: 16
• Forks: 26
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list-ansible - ansible_stdout_compact_logger

README

        
# Ansible Stdout Compact Logger

## Installation

- put somewhere on your disk

- add `callback_plugins` settings in your `[defaults]` settings in your ansible configuration

- change stdout_callback to `anstomlog`

cf `ansible.cfg`.

## Features

- [x] one-line display

- [x] pylint compatible (almost...)

- [x] displays tasks content in a nice way

- [x] including UTF-8 strings

- [x] indents structs, displays empty arrays, strings

- [x] puts fields on top when available `['stdout', 'rc', 'stderr', 'start', 'end', 'msg']`

- [x] removes some fields when present `[, 'stdout_lines', '_ansible_verbose_always', '_ansible_verbose_override']` to avoid too much clutter

- [x] reverts to standard logger when more than `vv` verbosity

- [x] supports `no_log` attribute in Task

- [x] supports `_ansible_verbose_always` and `_ansible_verbose_override`

- [x] supports multiple items in task (#1)

- [x] multi host support

- [x] correct duration computation

- [x] Display duration in minutes when tasks last for more than 1 minute

- [x] diff display support

- [x] displays `stdout` and `stderr` nicely even when they contain `\n`

- [x] displays handlers calls

- [x] Python 2/3 compatible

- [ ] better line colouring

- [ ] more test around curious errors

## Without anstomlog

![Stdout Display without anstomlog](img/without_anstomlog.png)

## With anstomlog

![Stdout Display with multiline outputs](img/with_anstomlog.png)

## Test the logger

- clone this repository

```

ansible-playbook test-1.yml

```

- to run the tests, call `python callbacks/anstomlog.py`

## License

MIT, see LICENSE file.

## Tips and tricks

- Issue with non-ascii or utf-8 chars? Have a look at #4

## Contributors

- Pierre BAILLET @octplane

- Frédéric COMBES @marthym

- @tterranigma

- @OurFriendIrony

- Farzad FARID @farzy

- Jérôme BAROTIN @jbarotin

- Dale Henries @dalehenries

- Thomas Decaux @ebuildy