Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

pe_puppet_agent_syslog

Configure Puppet Agent and rsyslog to log to a separate file
Project URLRSS FeedReport issues

6,505 downloads

6,505 latest version

5.0 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.0 (latest)
released Oct 30th 2017
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'abottchen-pe_puppet_agent_syslog', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add abottchen-pe_puppet_agent_syslog
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install abottchen-pe_puppet_agent_syslog --version 0.1.0

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

abottchen/pe_puppet_agent_syslog — version 0.1.0 Oct 30th 2017

pe_puppet_agent_syslog

Table of Contents

  1. Description
  2. Setup - The basics of getting started with pe_puppet_agent_syslog
  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.
  6. Development - Guide for contributing to the module

Description

This module will automatically set up rsyslog and Puppet agent such that all agent logging will be directed to a file of your choosing. This file defaults to /var/log/puppetlabs/puppet-agent.log. This automates the process of splitting Puppet agent messages out from /var/log/messages to their own file.

This module assumes you are running a version of Linux that utilizes rsyslog as the logging subsystem.

This class can be applied to any node in your infrastructure where you would like to have Puppet agent, both command like invocations and automated runs, log to a separate file along with /var/log/messages.

Setup

What pe_puppet_agent_syslog affects

This module will add a new rsyslog configuration file under /etc/rsyslog.d, set to be loaded last. By default, it will log on syslog facility "local6", but this can be configured via parameter if it is already in use in your environment.

Beginning with pe_puppet_agent_syslog

Assign the class to a node group that encompasses the nodes you wish to set up.

Usage

There are two parameters, "facility" and "log_filename":

"facility": The syslog facility on which Puppet agent will log. This defaults to "local6".

"log_filename": The destination file where the Puppet agent logs will be stored. This defaults to "/var/log/puppetlabs/puppet-agent.log"

Reference

Limitations

This module currently only handles systems with rsyslog as the logging subsystem.

Development

Release Notes/Contributors/Etc. Optional