Skip to content

jonmosco/puppet-logwatch

Repository files navigation

logwatch

Build Status

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 logwatch ¦ * What logwatch affects ¦ * Setup requirements
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

The logwatch module configures logwatch on Linux bases systems.

Module Description

The logwatch module will manage the installation and configuration of logwatch on Linux based systems.

Setup

NOTE: You must have a proper MTA installed and configured to send mail externally.

Stdlib

This module requires puppetlabs-stdlib >= 3.2.0

What logwatch affects

  • logwatch package.
  • logwatch configuration files.

Usage

Using default values

  class { '::logwatch': }

Using available parameters

 class { '::logwatch':
   mail_to   => [ '[email protected] ', '[email protected]' ],
   mail_from => '[email protected]',
   service   => [ 'sshd', 'httpd' ],
 }

Managing ignore.conf

Add a regex to ignore.conf to suppress that output from the logwatch report

  logwatch::ignore { 'my_rule':
    regex => 'ignore_lines_that_match_this_regex',
  }

Reference

Classes

Public Classes

  • logwatch: Main class, includes all other classes.
  • logwatch::ignore: Manage the contents of ignore.conf

Private Classes

  • logwatch::install: Handles the packages.
  • logwatch::config: Handles the configuration file.

Parameters

logwatch
output
format
mail_to
mail_from
range
detail
service
package_ensure
package_name
logwatch::ignore
regex

Limitations

This module has been built on and tested against Puppet 3.

The module has been tested on:

  • RedHat Enterprise Linux 6/7
  • CentOS 6/7
  • Ubuntu 12.04/14.04

Development

Contributing