/puppet-logstash

Puppet module to manage logstash

Primary LanguageRubyOtherNOASSERTION

puppet-logstash

A Puppet module for managing and configuring Logstash.

Build Status

Versions

This overview shows you which Puppet module and Logstash version work together.

------------------------------------
| Puppet module | Logstash         |
------------------------------------
| 0.0.1 - 0.1.0 | 1.1.9            |
------------------------------------
| 0.2.0         | 1.1.10           |
------------------------------------
| 0.3.0 - 0.3.4 | 1.1.12 - 1.1.13  |
------------------------------------
| 0.4.0 - 0.4.2 | 1.2.x - 1.3.x    |
------------------------------------
| 0.5.0 - 0.5.1 | 1.4.1 - 1.4.2    |
------------------------------------

Important notes

0.4.0

Please note that this a backwards compatability breaking release: in particular, the plugin syntax system has been removed entirely in favour of config files.

If you need any help please see the support section.

Requirements

Optional:

  • The apt Puppet library when using repo management on Debian/Ubuntu.
  • The zypprepo Puppet library when using repo management on SLES/SuSE

Usage Examples

The minimum viable configuration ensures that the service is running and that it will be started at boot time: N.B. you will still need to supply a configuration.

 class { 'logstash': }

Specify a particular package (version) to be installed:

 class { 'logstash':
   version => '1.3.3-1_centos'
 }

In the absense of an appropriate package for your environment it is possible to install from other sources as well.

http/https/ftp source:

 class { 'logstash':
   package_url => 'http://download.elasticsearch.org/logstash/logstash/packages/centos/logstash-1.3.3-1_centos.noarch.rpm'
 }

puppet:// source:

 class { 'logstash':
   package_url => 'puppet:///path/to/logstash-1.3.3-1_centos.noarch.rpm'
 }

Local file source:

 class { 'logstash':
   package_url => 'file:/path/to/logstash-1.3.3-1_centos.noarch.rpm'
 }

Attempt to upgrade Logstash if a newer package is detected (false by default):

 class { 'logstash':
   autoupgrade => true
 }

Install everything but disable the service (useful for pre-configuring systems):

 class { 'logstash':
   status => 'disabled'
 }

Under normal circumstances a modification to the Logstash configuration will trigger a restart of the service. This behaviour can be disabled:

 class { 'logstash':
   restart_on_change => false
 }

Disable and remove Logstash entirely:

 class { 'logstash':
   ensure => 'absent'
 }

Contrib package installation

As of Logstash 1.4.0 plugins have been split into 2 packages. To install the contrib package:

via the repository:

 class { 'logstash':
   install_contrib => true
 }

via contrib_package_url:

 class { 'logstash':
   install_contrib => true,
   contrib_package_url => 'http://download.elasticsearch.org/logstash/logstash/packages/centos/logstash-contrib-1.4.0-1_centos.noarch.rpm'
 }

with a version specified:

 class { 'logstash':
   install_contrib => true,
   contrib_version => '1.4.0'
 }

Configuration Overview

The Logstash configuration can be supplied as a single static file or dynamically built from multiple smaller files.

The basic usage is identical in either case: simply declare a file attribute as you would the content attribute of the file type, meaning either direct content, template or a file resource:

 logstash::configfile { 'configname':
   content => template('path/to/config.file')
 }

 or

 logstash::configfile { 'configname':
   source => 'puppet:///path/to/config.file'
 }

 or if you want to use hiera to specify your configs, include the following create_resources call in your node manifest or in manifests/site.pp:

 $logstash_configs = hiera('logstash_configs', {})
 create_resources('logstash::configfile', $logstash_configs)

 and then include the following config within the corresponding hiera file:

 "logstash_configs": {
    "config-name": {
      "template": "logstash/config.file.erb"
    }
  }

  please note you'll have to create your logstash.conf.erb file and place it in the logstash module templates directory prior to using this method

To dynamically build a configuration, simply declare the order in which each section should appear - the lower the number the earlier it will appear in the resulting file (this should be a familiar idiom for most).

 logstash::configfile { 'input_redis':
   template => 'logstash/input_redis.erb',
   order   => 10
 }

 logstash::configfile { 'filter_apache':
   source => 'puppet:///path/to/filter_apache',
   order  => 20
 }

 logstash::configfile { 'output_es':
   template => 'logstash/output_es_cluster.erb'
   order   => 30
 }

Patterns

Many plugins (notably Grok) use patterns. While many are included in Logstash already, additional site-specific patterns can be managed as well; where possible, you are encouraged to contribute new patterns back to the community.

N.B. As of Logstash 1.2 the path to the additional patterns needs to be configured explicitly in the Grok configuration.

 logstash::patternfile { 'extra_patterns':
   source => 'puppet:///path/to/extra_pattern'
 }

By default the resulting filename of the pattern will match that of the source. This can be over-ridden:

 logstash::patternfile { 'extra_patterns_firewall':
   source   => 'puppet:///path/to/extra_patterns_firewall_v1',
   filename => 'extra_patterns_firewall'
 }

IMPORTANT NOTE: Using logstash::patternfile places new patterns in the correct directory, however, it does NOT cause the path to be included automatically for filters (example: grok filter). You will still need to include this path (by default, /etc/logstash/patterns/) explicitly in your configurations.

Example: If using 'grok' in one of your configurations, you must include the pattern path in each filter like this:

grok {
      patterns_dir => "/etc/logstash/patterns/"
      ...
    }

Plugins

Like the patterns above, Logstash comes with a large number of plugins; likewise, additional site-specific plugins can be managed as well. Again, where possible, you are encouraged to contribute new plugins back to the community.

 logstash::plugin { 'myplugin':
   ensure => 'present',
   type   => 'input',
   source => 'puppet:///path/to/my/custom/plugin.rb'
 }

By default the resulting filename of the plugin will match that of the source. This can be over-ridden:

 logstash::plugin { 'myplugin':
   ensure   => 'present',
   type     => 'output',
   source   => 'puppet:///path/to/my/custom/plugin_v1.rb',
   filename => 'plugin.rb'
 }

Java Install

Most sites will manage Java seperately; however, this module can attempt to install Java as well.

 class { 'logstash':
   java_install => true
 }

Specify a particular Java package (version) to be installed:

 class { 'logstash':
   java_install => true,
   java_package => 'packagename'
 }

Repository management

Most sites will manage repositories seperately; however, this module can manage the repository for you.

 class { 'logstash':
   manage_repo  => true,
   repo_version => '1.3'
 }

Note: When using this on Debian/Ubuntu you will need to add the Puppetlabs/apt module to your modules. If no repo_version is provided, default is set to 1.4.

Service Management

Currently only the basic SysV-style init service provider is supported but other systems could be implemented as necessary (pull requests welcome).

init

Defaults File

The defaults file (/etc/defaults/logstash or /etc/sysconfig/logstash) for the Logstash service can be populated as necessary. This can either be a static file resource or a simple key value-style hash object, the latter being particularly well-suited to pulling out of a data source such as Hiera.

file source
 class { 'logstash':
   init_defaults_file => 'puppet:///path/to/defaults'
 }
hash representation
 $config_hash = {
   'LS_USER' => 'logstash',
   'LS_GROUP' => 'logstash',
 }

 class { 'logstash':
   init_defaults => $config_hash
 }

Support

Need help? Join us in #logstash on Freenode IRC or subscribe to the logstash-users@googlegroups.com mailing list.