rsyslog

rsyslog management

jordi prats

eyp

4,035 downloads

3,991 latest version

5.0 quality score

Version information

  • 0.2.1 (latest)
  • 0.2.0
released Aug 23rd 2018
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.8.0
  • RedHat
    ,
    CentOS

Start using this module

Documentation

eyp/rsyslog — version 0.2.1 Aug 23rd 2018

rsyslog

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. Development

Overview

A one-maybe-two sentence summary of what the module does/what problem it solves. This is your 30 second elevator pitch for your module. Consider including OS/Puppet version it works with.

Module Description

If applicable, this section should have a brief description of the technology the module integrates with and what that integration enables. This section should answer the questions: "What does this module do?" and "Why would I use it?"

If your module has a range of functionality (installation, configuration, management, etc.) this is the time to mention it.

Setup

What rsyslog affects

  • rsyslog modules:
    • imfile
    • imtcp
    • imudp

Setup Requirements

This module requires pluginsync enabled and eyp/nsswitch module installed

Beginning with rsyslog

rsyslog example:

classes:
  - rsyslog
rsyslog::modules:
  - imfile
  - imtcp
  - imudp
rsyslogfacilities:
  any:
    facility: '*.*'
    remotesyslogtype: tcp
    remotesyslog: "%{hiera('systemadmin::syslogservers')}"
rsyslogimfiles:
  /opt/tomcat8080/logs/catalina.out:
    inputfiletag: catalina.out
    statefile: stat-catalina1
  /opt/tomcat8080/logs/sso.log:
    inputfiletag: sso.log
    statefile: stat-sso1

Usage

modules:

  • imtcp: TCP Syslog Input Module
  • imudp: UDP Syslog Input Module
  • imfile: Text File Input Module
  • imjournal: provides access to the systemd journal
  • imklog: provides kernel logging support
  • TODO: #$ModLoad immark # provides --MARK-- message capability

Reference

Here, list the classes, types, providers, facts, etc contained in your module. This section should include all of the under-the-hood workings of your module so people know what the module is touching on their system but don't need to mess with things. (We are working on automating this section!)

Limitations

Tested on CentOS 6

Development

We are pushing to have acceptance testing in place, so any new feature should have some test to check both presence and absence of any feature

TODO

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request