Forge Home

rsyslog

Defined typed based management of rsyslog.

12,543 downloads

12,262 latest version

4.5 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
released Sep 1st 2015
This version is compatible with:
  • ,

Start using this module

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

Add this module to your Puppetfile:

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

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install asciiduck-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.

Download

Documentation

asciiduck/rsyslog — version 0.1.1 Sep 1st 2015

Table of Contents

  1. Overview
  2. Setup - The basics of getting started with rsyslog
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.

Overview

This module presents a more flexible, if not yet feature parity, alternative to other rsyslog modules on the forge currently. The biggest gain is the defined types which allow more flexibility in adding logging rules.

Setup

What rsyslog affects

  • /etc/rsyslog.conf
  • /etc/rsyslog.d/
  • rsyslog run directory

Setup Requirements

No current special requirements, other than puppetlabs/stdlib

Beginning with rsyslog

The main class will create a very basic configuration with no rules.

include 'rsyslog'

To make use of the default rules for your OS you should also use include rsyslog::default_configuration

include 'rsyslog'
include 'rsyslog::default\_configuration'

Usage

To add new rule to log to a file

rsyslog::rule{'user7':
  pattern => 'user7.\*',
  file    => '/var/log/user7.log',
}

To add new rule to log to a remote host, you must provide at least the host and the protocol. The protocol may be one of three options, 'udp', 'tcp', or 'tcpo' (TCP with octet framing).

rsyslog::rule{'user7':
  pattern => 'user7.\*',
  host    => 'logger.example.com',
  proto   => 'udp'
}

Reference

Limitations

Currently no overt support for more complicated configurations, like TLS.

Development

Do the usual fork/commit/pull request shuffle. Be sure to keep tests up to date.