ansible-role-collect-logs - An Ansible role for aggregating logs from different nodes.
Project description
Ansible role for aggregating logs from different nodes.
The only supported way to call this role is using its main entry point. Do not use tasks_from as this count as using private interfaces.
Requirements
This role gathers logs and debug information from a target system and collates them in a designated directory, artcl_collect_dir, on the localhost.
Additionally, the role will convert templated bash scripts, created and used by TripleO-Quickstart during deployment, into rST files. These rST files are combined with static rST files and fed into Sphinx to create user friendly post-build-documentation specific to an original deployment.
Finally, the role optionally handles uploading these logs to a rsync server or to an OpenStack Swift object storage. Logs from Swift can be exposed with os-loganalyze.
Role Variables
File Collection
artcl_collect_list – A list of files and directories to gather from the target. Directories are collected recursively and need to end with a ‘/’ to get collected. Should be specified as a YaML list, e.g.:
artcl_collect_list:
- /etc/nova/
- /home/stack/*.log
- /var/log/
artcl_collect_list_append – A list of files and directories to be appended in the default list. This is useful for users that want to keep the original list and just add more relevant paths.
artcl_exclude_list – A list of files and directories to exclude from collecting. This list is passed to rsync as an exclude filter and it takes precedence over the collection list. For details see the ‘FILTER RULES’ topic in the rsync man page.
artcl_exclude_list_append – A list of files and directories to be appended in the default exclude list. This is useful for users that want to keep the original list and just add more relevant paths.
artcl_collect_dir – A local directory where the logs should be gathered, without a trailing slash.
collect_log_types - A list of which type of logs will be collected, such as openstack logs, network logs, system logs, etc. Acceptable values are system, monitoring, network, openstack and container.
artcl_gzip: Archive files, disabled by default.
artcl_rsync_collect_list - if true, a rsync filter file is generated for rsync to collect files, if false, find is used to generate list of files to collect for rsync. find brings some benefits like searching for files in a certain depth (artcl_find_maxdepth) or up to certain size (artcl_find_max_size).
artcl_find_maxdepth - Number of levels of directories below the starting points, default is 4. Note: this variable is applied only when artcl_rsync_collect_list is set to false.
artcl_find_max_size - Max size of a file in MBs to be included in find search, default value is 256. Note: this variable is applied only when artcl_rsync_collect_list is set to false.
artcl_commands_extras - A nested dictionary of additional commands to be run during collection. First level contains the group type, as defined by collect_log_types list which determines which groups are collected and which ones are skipped.
Defined keys will override implicit ones from defaults artcl_commands which is not expected to be changed by user.
Second level keys are used to uniqly identify a command and determine the default output filename, unless is mentioned via capture_file property.
cmd contains the shell command that would be run.
artcl_commands_extras:
system:
disk-space:
cmd: df
# will save output to /var/log/extras/dist-space.log
mounts:
cmd: mount -a
capture_file: /mounts.txt # <-- custom capture file location
openstack:
key2:
cmd: touch /foo.txt
capture_disable: true # <-- disable implicit std redirection
when: "1 > 2" # <-- optional condition
Logs parsing
“Sova” module parses logs for known patterns and returns messages that were found. Patterns are tagged by issues types, like “infra”, “code”, etc. Patterns are located in file sova-patterns.yml in vars/ directory.
config - patterns loaded from file
files - files and patterns sections match
result - path to file to write a result of parsing
result_file_dir - directory to write a file with patterns in name
Example of usage of “sova” module:
---
- name: Run sova task
sova:
config: "{{ pattern_config }}"
files:
console: "{{ ansible_user_dir }}/workspace/logs/quickstart_install.log"
errors: "/var/log/errors.txt"
"ironic-conductor": "/var/log/containers/ironic/ironic-conductor.log"
syslog: "/var/log/journal.txt"
logstash: "/var/log/extra/logstash.txt"
result: "{{ ansible_user_dir }}/workspace/logs/failures_file"
result_file_dir: "{{ ansible_user_dir }}/workspace/logs"
Example Role Playbook
---
- name: Gather logs
hosts: all:!localhost
roles:
- collect_logs
- ** Note:
The tasks that collect data from the nodes are executed with ignore_errors. For example:
Templated Bash to rST Conversion Notes
Templated bash scripts used during deployment are converted to rST files during the create-docs portion of the role’s call. Shell scripts are fed into an awk script and output as restructured text. The awk script has several simple rules:
Only lines between ### ---start_docs and ### ---stop_docs will be parsed.
Lines containing # nodoc will be excluded.
Lines containing ## :: indicate subsequent lines should be formatted as code blocks
Other lines beginning with ## <anything else> will have the prepended ## removed. This is how and where general rST formatting is added.
All other lines, including shell comments, will be indented by four spaces.
Enabling sosreport Collection
sosreport is a unified tool for collecting system logs and other debug information. To enable creation of sosreport(s) with this role, create a custom config (you can use centosci-logs.yml as a template) and ensure that artcl_collect_sosreport: true is set.
Sanitizing Log Strings
Logs can contain senstive data such as private links and access passwords. The ‘collect’ task provides an option to replace private strings with sanitized strings to protect private data.
The ‘sanitize_log_strings’ task makes use of the Ansible ‘replace’ module and is enabled by defining a sanitize_lines variable as shown in the example below:
---
sanitize_lines:
- dir_path: '/tmp/{{ inventory_hostname }}/etc/repos/'
file_pattern: '*'
orig_string: '^(.*)download(.*)$'
sanitized_string: 'SANITIZED_STR_download'
- dir_path: '/tmp/{{ inventory_hostname }}/home/zuul/'
file_pattern: '*'
orig_string: '^(.*)my_private_host\.com(.*)$'
sanitized_string: 'SANITIZED_STR_host'
The task searches for files containing the sensitive strings (orig_string) within a file path, and then replaces the sensitive strings in those files with the sanitized_string.
Usage with InfraRed
Run the following steps to execute the role with infrared.
Install infrared and add ansible-role-collect-logs plugin by providing the url to this repo:
(infrared)$ ir plugin add https://opendev.org/openstack/ansible-role-collect-logs.git --src-path infrared_plugin
Verify that the plugin is imported by:
(infrared)$ ir plugin list
Run the plugin:
(infrared)$ ir ansible-role-collect-logs
License
Apache 2.0
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ansible-role-collect-logs-1.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c66b115650009c6dfd6685bdee2d9bd9123418fc6ad90d949013116c4a6ca9c3 |
|
MD5 | d041370bdaee7571da1a5adc5ac3af5b |
|
BLAKE2b-256 | fe22e909dfa40edb078228054c8ddb308c87f0ff0613aec19d6ac18fb7b3f95e |
Hashes for ansible_role_collect_logs-1.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0abe265d1be40bec168a8ebe524b884fbca211a1d493009f6f8e663687db6129 |
|
MD5 | a021d9fccd9d582630e67b6dddba9354 |
|
BLAKE2b-256 | bc37ac363be721a6553ce6b456e090c132e8b1f8d07016179745db26ddb95073 |