gabops.papertrail

This tool installs and sets up Papertrail (remote_syslog2).

Requirements

No requirements needed.

Role Variables

Variable	Value	Description
`papertrail_version`	"0.20"	The version to install. 0.20 is the latest version available as of now.
`papertrail_config_file_path`	/etc/papertrail_conf.yml	The name of the configuration file for remote_syslog.
`papertrail_service_enabled`	true	If true, remote_syslog will start when the system boots up.
`papertrail_service_state`	started	Indicates whether the service is currently running.
`papertrail_check_download_certs`	true	Whether to check server certificates for the package download. It's safer to leave this as true.
`papertrail_managed_conf_file`	true	If false, only installation happens and no configuration changes will be made.
`papertrail_custom_hostname`	""	By default, remote_syslog2 uses the node's hostname, but this can be changed.
`papertrail_destination_host`	""	The Papertrail host where logs will be sent. Check your Papertrail account for this information.
`papertrail_destination_port`	""	The port used to connect to the destination host. Refer to your Papertrail account for this.
`papertrail_destination_protocol`	tls	This can be 'tls' (secure connection) or 'tcp' (insecure connection).
`papertrail_log_facility`	""	The Syslog facility to use. More info can be found here.
`papertrail_log_severity`	""	The Syslog severity level to use. More details can be found here.
`papertrail_new_file_check_interval`	""	If a pattern for log files is used, this controls how often to check for new log files.
`papertrail_files_to_log`	[]	The files or patterns of files to read logs from.
`papertrail_files_to_exclude`	[]	Files to exclude while reading logs in a directory.
`papertrail_exclude_patterns`	[]	Patterns in the log files that you want to ignore.

For more detailed information about configuring remote_syslog2, visit the remote_syslog2 documentation on GitHub.

For more details about Papertrail, please check the official documentation.

Dependencies

No dependencies needed.

Example Playbook

- hosts: webserver-01
  vars:
    papertrail_version: "0.19"
    papertrail_destination_host: logs.papertrailapp.com
    papertrail_destination_port: 12345
    papertrail_destination_protocol: tls
    papertrail_log_facility: local7
    papertrail_log_severity: warn
    papertrail_custom_hostname: "main-server-01"
    papertrail_files_to_log:
      - path: /var/log/messages
        tag: messages
      - /var/log/dmesg
      - /var/log/httpd/access_log
    papertrail_exclude_patterns:
      - ^password.*
    papertrail_exclude_files:
      - .tar.gz
      - "*.old"
  roles:
      - role: papertrail