ansible-role-collect-logs 1.5.0

文件收集

• artcl_collect_list – 要从目标收集的文件和目录列表。目录递归收集并需要以‘/’结尾以被收集。应指定为YAML列表，例如。

artcl_collect_list:
    - /etc/nova/
    - /home/stack/*.log
    - /var/log/

• artcl_collect_list_append – 要追加到默认列表中的文件和目录列表。这对于希望保留原始列表并仅添加更多相关路径的用户很有用。

• artcl_exclude_list – 要排除在收集之外的文件和目录列表。此列表传递给rsync作为排除过滤器，并且它优先于收集列表。有关详细信息，请参阅rsync手册页中的“FILTER RULES”主题。

• artcl_exclude_list_append – 要追加到默认排除列表中的文件和目录列表。这对于想要保留原始列表并仅添加更多相关路径的用户很有用。

• artcl_collect_dir – 应该收集日志的本地目录，后面不带斜杠。

• collect_log_types - 要收集的日志类型列表，例如openstack日志、网络日志、系统日志等。可接受值有system、monitoring、network、openstack和container。

• artcl_gzip：归档文件，默认禁用。

• artcl_rsync_collect_list - 如果为true，则生成用于< span class="docutils literal">rsync收集文件的rsync过滤器文件，如果为false，则使用< span class="docutils literal">find生成用于< span class="docutils literal">rsync收集的文件列表。< span class="docutils literal">find带来了某些好处，例如在特定深度（< span class="docutils literal">artcl_find_maxdepth）内搜索文件或达到特定大小（< span class="docutils literal">artcl_find_max_size）。

• artcl_find_maxdepth - 从起始点以下的目录层级数，默认为4。注意：此变量仅在< span class="docutils literal">artcl_rsync_collect_list设置为false时应用。

• artcl_find_max_size - 要包含在find搜索中的文件的最大大小（MB），默认值为256。注意：此变量仅在< span class="docutils literal">artcl_rsync_collect_list设置为false时应用。

• artcl_commands_extras - 在收集期间要运行的附加命令的嵌套字典。第一级包含由< span class="docutils literal">collect_log_types列表定义的组类型，该列表确定哪些组被收集以及哪些组被跳过。

  定义的密钥将覆盖来自默认< span class="docutils literal">artcl_commands的隐式密钥，默认< span class="docutils literal">artcl_commands不期望用户更改。

  第二级密钥用于唯一标识一个命令并确定默认输出文件名，除非通过< span class="docutils literal">capture_file属性指定。

  cmd包含将要运行的shell命令。

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

文档生成相关

• artcl_gen_docs：false/true – 如果为true，则角色将使用构建工件和Sphinx生成用户友好的文档（默认：false）

• artcl_docs_source_dir – 作为Sphinx源目录的本地目录。

• artcl_docs_build_dir – 作为Sphinx构建输出目录的本地目录。

• artcl_create_docs_payload – 指示如何构建文档的列表的字典。

  • included_deployment_scripts – 要转换为rST文件的模板bash脚本列表。

  • included_deployment_scripts – 将包含在输出文档中的静态rST文件列表。

  • table_of_contents – 定义rST文件在输出文档中排列顺序的列表。

• artcl_verify_sphinx_build – false/true – 如果为true，则验证在< span class="docutils literal">artcl_create_docs_payload.table_of_contents中定义的项目存在于sphinx生成的index.html中（默认：false）

artcl_create_docs_payload:
  included_deployment_scripts:
    - undercloud-install
    - undercloud-post-install
  included_static_docs:
    - env-setup-virt
  table_of_contents:
    - env-setup-virt
    - undercloud-install
    - undercloud-post-install

发布相关

• artcl_publish：true/false – 如果为true，则角色将尝试将日志通过< span class="docutils literal">artcl_rsync_url指定的目标进行rsync。使用环境中的< span class="docutils literal">BUILD_URL、< span class="docutils literal">BUILD_TAG变量（在Jenkins作业运行期间设置）并需要设置以下变量。

• artcl_txt_rename：false/true – 重命名基于文本的文件以以.txt.gz结尾，以便上游日志服务器在浏览器中显示它们而不是提供下载

• artcl_publish_timeout：角色上传日志的最大秒数，默认为1800秒（30分钟）

• artcl_use_rsync：false/true – 使用rsync上传日志

• artcl_rsync_use_daemon：false/true – 使用rsync守护进程而不是ssh进行连接

• artcl_rsync_url – 上传日志的rsync目标。本地主机需要对目标进行无密码认证，或在环境中指定PROVISIONER_KEY变量。

• artcl_use_swift：false/true – 使用swift对象存储来发布日志

• artcl_swift_auth_url – Swift的OpenStack认证URL

• artcl_swift_username – Swift的OpenStack用户名

• artcl_swift_password – Swift用户的密码

• artcl_swift_tenant_name – Swift的OpenStack租户（项目）名称

• artcl_swift_container – 要使用的Swift容器名称，默认为logs

• artcl_swift_delete_after – Swift将在多少秒后删除上传的对象，默认为2678400秒=31天。

• artcl_artifact_url – 上传日志上传后可访问的HTTP URL。

• artcl_report_server_key - 访问报告服务器的密钥路径。

Ara相关

• ara_enabled：true/false - 如果为true，则角色将生成ara报告。

• ara_overcloud_db_path：ara overcloud路径的路径（仅限tripleo）。

• ara_generate_html：true/false - 生成ara html。

• ara_graphite_prefix：在graphite中使用的ara前缀。

• ara_only_successful_tasks：true/false - 只发送成功的任务到graphite。

• ara_tasks_map：要映射到graphite的ara任务的字典。

日志解析

“Sova”模块解析日志以查找已知模式，并返回找到的消息。模式按问题类型标记，如“基础设施”、“代码”等。模式位于vars目录下的sova-patterns.yml文件中。

• config - 从文件加载的模式

• files - 文件和模式部分匹配

• result - 写入解析结果的文件路径

• result_file_dir - 写入包含模式的文件的目录

---
- 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"