A Puppet module for managing and configuring Logstash.
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 - 1.5.1 | 1.4.1 |
------------------------------------
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.
- Puppet 2.7.x or better.
- The stdlib Puppet library.
- The file_concat Puppet library.
Optional:
- The apt Puppet library when using repo management on Debian/Ubuntu.
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 using either a configs parameter or the logstash::configfile define.
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'
}Enable Hiera Hash Merging for parameter lookups. When using the Hiera Automatic Parameter Lookup functionality, only priority based lookups are supported. Setting this to enabled will override this behaviour to allow hash merging.
class { 'logstash':
hieramerge => true
}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'
}The Logstash configuration can be supplied as a single static file or dynamically built from multiple smaller files or using raw content.
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'
}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':
content => template('logstash/input_redis.erb'),
order => 10
}
logstash::configfile { 'filter_apache':
source => 'puppet:///path/to/filter_apache',
order => 20
}
logstash::configfile { 'output_es':
content => template('logstash/output_es_cluster.erb')
order => 30
}You may alternatively specify a list of configfile directives via the hash parameter configs during the module load. This allows storing the configuration data in hiera.
class { 'logstash':
configs => {
input_redis => {
content => template('logstash/input_redis.erb'),
order => 10
},
filter_apache => {
source => 'puppet:///path/to/filter_apache',
order => 20
},
output_es => {
content => template('logstash/output_es_cluster.erb'),
order => 30
},
}
}The following example stores raw configuration settings in Hiera (YAML):
logstash::configs:
input_json:
order : 10
content : |
input {
tcp {
port => 3333
type => "json-tcp"
codec => "json"
}
}
output_plain:
order : 20
content : |
output {
file {
codec => "plain"
flush_interval => 2
gzip => false
path => "/var/log/logstash/test.log"
workers => 1
}
}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'
}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'
}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'
}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.
Currently only the basic SysV-style init service provider is supported but other systems could be implemented as necessary (pull requests welcome).
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.
class { 'logstash':
init_defaults_file => 'puppet:///path/to/defaults'
} $config_hash = {
'LS_USER' => 'logstash',
'LS_GROUP' => 'logstash',
}
class { 'logstash':
init_defaults => $config_hash
}Need help? Join us in #logstash on Freenode IRC or subscribe to the [email protected] mailing list.