Skip to content

Latest commit

 

History

History
247 lines (164 loc) · 4.5 KB

README.md

File metadata and controls

247 lines (164 loc) · 4.5 KB
Raw

rsyslog module

===

Build Status

Module to manage rsyslog. Handles both local and remote logging.

Inspired by saz/rsyslog

This module will ensure that sysklogd is absent, which is needed on EL5.

===

Compatability

This module has been tested to work on the following systems with Puppet v3.x and Ruby versions 1.8.7, 1.9.3, and 2.0.0.

  • Debian 7
  • EL 5
  • EL 6
  • Suse 11

===

Parameters

package

Name of the rsyslog package.

  • Default: 'rsyslog'

package_ensure

What state the package should be in. Valid values are 'present', 'absent', 'purged', 'held' and 'latest'.

  • Default: 'present'

pid_file

Path to pid file.

  • Default: based on platform

logrotate_d_config_path

Path of the logrotate config file.

  • Default: '/etc/logrotate.d/syslog'

logrotate_d_config_owner

Owner of the logrotate config file.

  • Default: 'root'

logrotate_d_config_group

Group of the logrotate config file.

  • Default: 'root'

logrotate_d_config_mode

Mode of the logrotate config file.

  • Default: '0644'

config_path

Path of the rsyslog config file.

  • Default: '/etc/rsyslog.conf'

config_owner

Owner of the rsyslog config file.

  • Default: 'root'

config_group

Group of the rsyslog config file.

  • Default: 'root'

config_mode

Mode of the rsyslog config file.

  • Default: '0644'

sysconfig_path

Path of the rsyslog sysconfig config file.

  • Default: '/etc/sysconfig/rsyslog' # EL
  • Default: '/etc/default/rsyslog' # Debian

sysconfig_owner

Owner of the rsyslog sysconfig config file.

  • Default: 'root'

sysconfig_group

Group of the rsyslog sysconfig config file.

  • Default: 'root'

sysconfig_mode

Mode of the rsyslog sysconfig config file.

  • Default: '0644'

daemon

Name of the rsyslog service. 'USE_DEFAULTS' will choose the service name based on the osfamily. 'rsyslog' # RHEL, Debian 'syslog' # Suse

  • Default: 'USE_DEFAULTS'

daemon_ensure

Whether a service should be running. Valid values are 'stopped' and 'running'.

  • Default: 'running'

is_log_server

Whether the system syslog service is meant to recieve messages from remote hosts. Valid values are 'true' and 'false'.

  • Default: 'false'

log_dir

Path to store logs, if $is_log_server is true.

  • Default: '/srv/logs'

log_dir_owner

Owner of $log_dir, if $is_log_server is true.

  • Default: 'root'

log_dir_group

Group of $log_dir, if $is_log_server is true.

  • Default: 'root'

log_dir_mode

Permissions of $log_dir, if $is_log_server is true.

  • Default: '0750'

remote_template

Template path to store logs from remote hosts, appended after log_dir

  • Default: '%HOSTNAME%/%$YEAR%-%$MONTH%-%$DAY%.log'

remote_logging

Wheter to send logs remotely to a centralized logging service.

  • Default: 'false'

spool_dir

Path to place spool files.

  • Default: '/var/spool/rsyslog'

spool_dir_owner

Owner of the spool directory.

  • Default: 'root'

spool_dir_group

Group of the spool directory.

  • Default: 'root'

spool_dir_mode

Mode of the spool directory.

  • Default: '0700'

max_spool_size

Maximum disk space used by spool files. Uses one letter units such as k, m and g.

  • Default: '1g'

transport_protocol

Transport protocol used by rsyslog. Valid values are 'tcp' and 'udp'

  • Default: 'tcp'

log_server

Server to send logs to if remote_logging is true.

  • Default: "log.${::domain}"

log_server_port

Port of the server to send logs to if remote_logging is true.

  • Default: '514'

enable_tcp_server

Whether to enable tcp listening for the service. If undefined, set by $transport_protocol.

  • Default: undef

enable_udp_server

Whether to enable udp listening for the service. If undefined, set by $transport_protocol.

  • Default: undef

kernel_target

Target of kernel logs.

  • Default: '/var/log/messages'

source_facilities

List of source facilities to be sent to remote log server. Only used if remote_logging is true.

  • Default: *.*