Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

syslog_ng

Installs, configures, and manages Syslog-ng package including client and server configuration
Project URLRSS FeedReport issues

29,928 downloads

24,368 latest version

4.6 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.2.0 (latest)
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Mar 13th 2017
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 'soerenbe-syslog_ng', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add soerenbe-syslog_ng
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install soerenbe-syslog_ng --version 0.2.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

soerenbe/syslog_ng — version 0.2.0 Mar 13th 2017

syslog_ng

Table of Contents

  1. Overview

  2. Setup

  3. Usage

  4. Classes and Defined Types

  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

This is a puppet syslog_ng module. On basic settings it simply installs the syslog-ng deamon. You can configure the module to setup complex client/server logserver server setups. It is heavily tested under Ubuntu 14.04, but through the nature of syslog-ng at least Debian and other Ubuntu versions should work fine.

Setup

What syslog_ng affects

Mainly this module manages all file in /etc/syslog-ng. It creates a basic /etc/syslog/syslog-ng.conf and include configuration fragments in /etc/syslog-ng/conf.d.

WARNING: Typically syslog-ng replaces the current (and default) syslog deamon. This means it will uninstall rsyslogd!

Setup Requirements

syslog_ng requires puppetlabs-stdlib and puppetlabs-concat

Beginning with syslog_ng

    include syslog_ng

This will install the basic syslog-ng deamon. It should behave like a normal installation with default config file.

Usage

Beside the basic configuration the module gives a abstraction to the typical syslog-ng concepts of source, destination, filter and log

In addition the module provides some basic resources for typical application scenarios like a log server, log client or "Log the application xyz to file".

Custom logging

You can use the resources to build custom log rules. The basic system log source is defined in syslog_ng::params::local_source. By default it is set to the package default s_src. You can use this source in your custom log rules. The following example uses the standard syslog-ng config and logs all messages of the program puppet-agent to its own log file /var/log/puppet.log

    include syslog_ng
    puppet
    syslog_ng::destination::file { 'puppet_log_file':
      file => '/var/log/puppet.log'
    }
    syslog_ng::filter {'puppet_agent':
      spec => 'program("puppet-agent")'
    }
    syslog_ng::log { 'puppet_agent':
      source      => 's_src',
      filter      => 'puppet_agent',
      destination => 'puppet_log_file'
    }

You may provide also provide a list for filter or destination

In most cases (like above) you simply want to generate a filter, apply it to a source and log this to a new log file. For this the syslog_ng::log resource provides a shortcut. You may define the example above like:

    include syslog_ng
    syslog_ng::log { 'puppet_agent':
      source      => 's_src',
      filter_spec => 'program("puppet-agent")',
      file        => '/var/log/puppet.log'
    }

Log server

If you want your syslog-ng installation to act like a log server you can use define them completly free by using syslog_ng::source resource. You may find a detailed description below. In most cases you want to use the predefined server resources.

    include syslog_ng
    syslog_ng::udpserver {'udp_source_514':
        ip   => '0.0.0.0',
        port => '514'
    }
    syslog_ng::source::network {'tcp_source_5514':
        ip    => '0.0.0.0',
        port  => '5514',
        proto => 'tcp'
    }

Log client

If you want your syslog-ng deamon to log to a remote location you have to define a remote destination resource and use it in your `syslog_ng::log`` resource. The following example logs all puppet-agent logs to the remote log server defined above.

    include syslog_ng
    syslog_ng::destination::network {'logserver': 
        log_server => '192.168.122.10',
        log_port => '514'
    } 
    syslog_ng::log { 'puppet_agent':
      source      => 's_src',
      filter_spec => 'program("puppet-agent")',
      destination => 'logserver'
    }

Classes and Defined Types

Many resource type use following parameters. The will not be mentioned in the detailed description:

    $owner     = undef,
    $group     = undef,
    $dir_owner = undef,
    $dir_group = undef,
    $perm      = undef,

If they are not set the, the file/directory permission are managed by syslog-ng and will be set to the defaults defined in the syslog-ng module class.

Class: syslog_ng

This is the main class for the syslog-ng installation. See syslog_ng::params for a the detailed defaults.

    class syslog_ng (
      $system_log_dir            = $syslog_ng::params::system_log_dir,             # This is the default log directory
      $config_dir                = $syslog_ng::params::config_dir,                 # This is the default config directory
      $local_source              = $syslog_ng::params::local_source,               # This source is used for the local logging source.
      $reminder_file             = $syslog_ng::params::reminder_file,              # Reminder file name (see syslog_ng::logdir)
      $create_dirs               = $syslog_ng::params::create_dirs,                # If this is set to 'true' syslog-ng will create all required directories for a log file.
      $default_owner             = $syslog_ng::params::default_owner,              # global default for syslog-ng
      $default_group             = $syslog_ng::params::default_group,              # global default for syslog-ng
      $default_perm              = $syslog_ng::params::default_perm,               # global default for syslog-ng
      $use_fqdn                  = $syslog_ng::params::use_fqdn,                   # syslog-ng config parameter
      $use_dns                   = $syslog_ng::params::use_dns,                    # syslog-ng config parameter
      $chain_hostnames           = $syslog_ng::params::chain_hostnames,            # syslog-ng config parameter
      $stats_freq                = $syslog_ng::params::stats_freq,                 # syslog-ng config parameter
      $mark_freq                 = $syslog_ng::params::mark_freq,                  # syslog-ng config parameter
      $threaded                  = $syslog_ng::params::threaded,                   # syslog-ng config parameter
      $flush_lines               = $syslog_ng::params::flush_lines,                # syslog-ng config parameter
      $log_fifo_size             = $syslog_ng::params::log_fifo_size,              # syslog-ng config parameter
      $log_fifo_size_destination = $syslog_ng::params::log_fifo_size_destination,  # syslog-ng config parameter
    )

Defined Type: syslog_ng::source

This is a general source resource type. In most cases you want to use syslog_ng::source::network or the predefined and already existing source s_src

define syslog_ng::source (
  $spec     = undef,         # specification of the source
  $fallback = undef,         # use the fallback tag
  )

Defined Type: syslog_ng::source::network

This type defines a network source. It is typically used on a log server.

    define syslog_ng::source::network(
      $ip       = undef,               # The IP Adress of the remote source
      $port     = undef,               # The port of the remote source
      $proto    = "udp",               # The protocol to use. Only 'udp', 'udp6', 'tcp', 'tcp6', 'all', or 'all6' is supported
      $fallback = undef,               # The fallback file
    )

Defined Type: syslog_ng::destination

This type defines a destination within syslog_ng. Typically you want to use syslog_ng::destination::file or syslog_ng::destination::network.

    define syslog_ng::destination (
      $spec   = undef,               # specification of the destination
    )

Defined Type: syslog_ng::destination::file

This type defines a log file as a destination.

    define syslog_ng::destination::file (
      $file      = undef,                  # the file name of the destination
      $owner     = undef,
      $group     = undef,
      $dir_owner = undef,
      $dir_group = undef,
      $perm      = undef,
    )

Defined Type: syslog_ng::destination::network

This type defines a remote host as a destination. Typically this is used by a log client to log to a remote server.

    class syslog_ng::destination::network (
      $log_server = undef,               # The IP Adress of the remote source
      $log_port = undef,               # The port of the remote source
      $proto    = "udp",               # The protocol to use. Only 'udp', 'udp6', 'tcp', or 'tcp6' is supported
    )

Defined Type: syslog_ng::filter

This type defines a syslog-ng filter. You may use any filter syntax syslog-ng provides.

    define syslog_ng::filter (
      $spec = undef,           # specification of the filter
      )

Defined Type: syslog_ng::rewrite

This type defines a syslog-ng rewrite. You may use any filter syntax syslog-ng provides.

    define syslog_ng::rewrite (
      $spec = undef,           # specification of the rewrite
      )

Defined Type: syslog_ng::parser

This type defines a syslog-ng parser. You may use any filter syntax syslog-ng provides.

    define syslog_ng::parser (
      $spec = undef,           # specification of the parser
      )

Examples:

    syslog_ng::filter {'host_filter':    spec => 'host("webserver")' }
    syslog_ng::filter {'program_filter': spec => 'program("puppet-agent")' }
    syslog_ng::filter {'nodebug_apache': spec => 'program("apache2") and level(info..emerg)' }

Defined Type: syslog_ng::log

This type defines the general log behaviour. It used defined sources, filter and destination and combine them to a logging rule.

    define syslog_ng::log (
      $source          = undef,   # The source to log from
      $filter          = undef,   # The filter to apply (can be a list)
      $filter_spec     = undef,   # The new filter to apply
      $destination     = undef,   # The destination to log to
      $file            = undef,   # The logfile to log to
      $fallback        = undef,   # evaluate the syslog-ng fallback flag
      $owner           = undef,   # This applies to $file
      $group           = undef,   # This applies to $file
      $dir_owner       = undef,   # This applies to $file
      $dir_group       = undef,   # This applies to $file
      $perm            = undef,   # This applies to $file
    )

Examples that logs everything that is more or equal than an 'error' to the remote log server and to a file:

    syslog_ng::log {'remote_error':
        source => 's_src',
        filter_spec => 'level(error..emerg)',
        destination => 'logserver',
        file        => '/var/log/private_errors'       
    }

Defined Type: syslog_ng::default

This type is typically used to create the default syslog-ng configuration. You may use it on your own for completely logging a remote server to a log server without completly define all filters, files and log entries. Note that a normal setup will fill the $directory with a log of different files.

    define syslog_ng::default (
      $source    = undef,                           # the source to log from
      $directory = $::syslog_ng::system_log_dir,    # The directory to log from
      $host      = undef,                           # The host which should be filtered
      $owner     = undef,
      $group     = undef,
      $dir_owner = undef,
      $dir_group = undef,
      $perm      = undef,
    )

Example:

    syslog_ng::source::network {'log_server':
      ip   => '0.0.0.0'
      port => '514'
    }
    syslog_ng::logdir {'/var/log/hosts/webserver'}
    syslog_ng::defaut { 'from_webserver':
      source    => 'log_server',
      host      => 'webserver.mydomain.com',
      directory => '/var/log/hosts/webserver',
    }

Defined Type: syslog_ng::logdir

This type may define some log dirs which will be generated. syslog_ng::reminder_file is set, it will place this file in this directory. It also ensures that the directory is generated and have the correct permissions.

Defined Type: syslog_ng::block

This type can define a syslog-ng block instance. Note that this module currently don't support building such blocks. You may deploy them with syslog_ng::config::file.

Example:

  syslog_ng::block{'my_block_instance':
    block_name   => 'test_block',
    block_config => {
      'host'      => 'www.google.de',
      'directory' => '/var/log/google.de',
      'net'       => '192.168.0.0/255.255.255.0',
    }
  }

will create a syslog-ng config entry

test_block (host(www.google.de), directory(/var/log/google.de), net(192.168.0.0/255.255.255.0), )

Defined Type: syslog_ng::config::file

This define installs a plain config file into the syslog-ng config folder. This is useful when you want to deploy a already existing configuration or simply dont't want to express everything in the puppet language. You have to use the source parameter to point to the config file. This typically have to be placed in another module.

Example:

  syslog_ng::config::file {'my_block':
    source      => 'puppet:///modules/filesource/custom_block.conf';
  }

Defined Type: syslog_ng::config::template

Like syslog_ng::config::file you can provide a configuration template. You may pass a parameter config with a hash. This variable can be used inside the template.

  syslog_ng::config::template {'my_template':
    template => 'filesource/custom_template.erb',
    config   => {
      ip      => '192.168.10.10',
      comment => '# This is a comment in a hash'
    },
  }

Reference

  • syslog-ng administation guide Link
  • syslog-ng reference options Link
  • Since your log files may run out of control have a look at rodjek/logrotate

Limitations

This module heavily tested under Ubuntu 14.04, but through the nature of syslog-ng at least Debian and other Ubuntu versions should work fine.

The module does not cover all features by syslog-ng. Some examples:

  • message flags that are not the fallback flags
  • message templates
  • message reformating

Futher releases may add some features depending on the developers motivation/requirements or community feedback.

Development

If you have any bugfixes, enhancements that should be included in this module feel free to send me a pull request.