Ansible Papertrail Role

Important Note

This role is not gaining popularity, so I will archive it. Anyone is welcome to contribute or create their own version if needed.

Introduction

This role is designed to set up the Papertrail service. Currently, it only works with rsyslog. It has been tested and confirmed to work on Debian and Red Hat-based systems.

Requirements

• You must set the papertrail_destination.

Role Variables

Mandatory:

• papertrail_destination: This is required.

Not Editable:

• papertrail_rsyslog_packages: The names of rsyslog packages for your system.
• papertrail_rsyslog_tls_packages: The names of TLS packages for your system.
• papertrail_rsyslog_service: The name of the rsyslog service for your system.
• papertrail_ca_url: A fixed URL for downloading the CA certificate, used when papertrail_enable_tls is True.
• papertrail_ca_checksum: A fixed checksum for the CA file, used when papertrail_enable_tls is True.

Editable:

• papertrail_logforwarder: The type of forwarder used for Papertrail, currently only rsyslog is supported.
• papertrail_enable_tls: Set this to True to use TCP with TLS for log forwarding. Defaults to UDP.
• papertrail_enable_tcp: Set this to True to use TCP for log forwarding instead of UDP, without TLS.
• papertrail_loglevel: The level of logging.
• papertrail_rsyslog_config: A list of key-value items added to the rsyslog configuration.
• papertrail_verify_ca_checksum: Toggle for checking the MD5 checksum of the PEM file.

Defaults

• The default papertrail_logforwarder is set to "rsyslog".
• Both papertrail_enable_tls and papertrail_enable_tcp are off by default.
• Turning on papertrail_enable_tls will also turn on papertrail_enable_tcp unless you specifically prevent that.
• The default papertrail_loglevel is *.* (which means send all logs).
• There are predefined defaults for papertrail_rsyslog_config. Check the defaults in defaults/main.yml.
• The default setting for papertrail_verify_ca_checksum is False.

Example Playbook

- hosts: all
  roles:
     - { role: evrardjp.papertrail, papertrail_destination: logs1234.papertrailapp.com:1234 }

Next Steps

Future plans include support for:

• syslog-ng
• remote_syslog2
• additional operating systems

License

Apache2

Author Information

Jean-Philippe Evrard