Forge Home


Manage rsyslog, the rocket-fast system for log processing


5,599 latest version

1.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.1 (latest)
  • 0.1.0
  • 0.0.15
  • 0.0.14
  • 0.0.13
  • 0.0.12
  • 0.0.11
  • 0.0.10
  • 0.0.9
  • 0.0.8
  • 0.0.7
  • 0.0.6
  • 0.0.5
  • 0.0.4
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Aug 10th 2017
This version is compatible with:
  • Puppet Enterprise 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 5.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'm4ce-rsyslog', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add m4ce-rsyslog
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install m4ce-rsyslog --version 0.1.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Tags: rsyslog


m4ce/rsyslog — version 0.1.1 Aug 10th 2017

Puppet rsyslog module

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with the rsyslog module
  4. Reference - Types reference and additional functionalities
  5. Hiera integration
  6. Contact


Module to manage rsyslog configuration and runtime. Configuration and filters are totally driven via Hiera.

Module Description

The rsyslog module allows to automate the configuration and deployment of the rsyslog daemon.


The include the main class as follows:

include rsyslog





include rsyslog
filter_properties (optional)

rsyslog property-based filters in the form of {'filter_name' => { .. }}

filter_facilities (optional)

rsyslog facility-based filters in the form of {'filter_name' => { .. }}

opts (optional)

rsyslog daemon options in the form of {'option' => 'value'}.

Defaults to:

    - "imuxsock"
    - "imjournal"
  "WorkDirectory": "/var/lib/rsyslog"
  "ActionFileDefaultTemplate": "RSYSLOG_TraditionalFileFormat"
  "IncludeConfig": "%{lookup('rsyslog::config_dir')}/*.conf"
  "OmitLocalLogging": true
  "IMJournalStateFile": "imjournal.state"
packages (optional)

Installation packages for rsyslog

Defaults to:

  "rsyslog": {}
config_dir (optional)

Path to the rsyslog configuration directory (default: /etc/rsyslog.d)

config_dir_purge (optional)

Whether we should purge unmanaged resources under the rsyslog's configuration directory (default: true)

config_file (optional)

Path to the rsyslog configuration file (default: /etc/rsyslog.conf)

config_file_manage (optional)

Whether we should manage rsyslog's configuration file or not (default: true)

service_name (optional)

rsyslog service name (default: 'rsyslog')

service_manage (optional)

Whether we should manage the service runtime or not (default: true)

service_ensure (optional)

Whether the resource is running or not. Valid values are running, stopped. (default: running)

service_enable (optional)

Whether the service is onboot enabled or not. Defaults to true.

Defined Types


rsyslog::filter_property manages rsyslog property-based filters

rsyslog::filter_property {"filter_name": }
name (required)

Filter name

order (optional)

Filter order

operator (required)

Filter condition comparison operator (can be contains, isequal, startswidth, regex, ereregex). You can use the bang-character (!) immediately in front of a compare-operation, the outcome of this operation is negated.

value (required)

Filter condition value

action (required)

Filter action(s). Multiple actions can be specified as an Array of Strings.

ensure (optional)

Whether the resource is present or not. Valid values are present, absent. Defaults to present.


rsyslog::filter_facility manages rsyslog property-facility filters

rsyslog::filter_facility {"filter_name": }
name (required)

Filter name

order (optional)

Filter order

facility (required)

Filter facility

actions (required)

Filter action(s). Multiple actions can be specified as an Array of Strings.

ensure (optional)

Whether the resource is present or not. Valid values are present, absent. Defaults to present.

Hiera integration

You can optionally define your filters in Hiera as follows.

    property: "programname"
    operator: "isequal"
    value: "mesos-slave"
    actions: '~'
    ensure: "present"
    facility: "kern.*"
    actions: "/dev/console"
    ensure: "present"


Matteo Cerutti -