REFERENCE.md

Reference

Table of Contents

Classes

• logstash: Class: logstash =========================== Full description of class logstash here. Parameters ---------- * sample parameter Explanat
• logstash::install: == Class logstash::install This class is called from logstash for install.
• logstash::params: == Class logstash::params This class is meant to be called from logstash. It sets variables according to platform.

Defined types

• logstash::config
• logstash::instance: Logstash instance A logstash instance defines a logstash service instance, and an empty configuration file. To include your own configuratio

Classes

logstash

Class: logstash

Full description of class logstash here.

Parameters

• sample parameter Explanation of what this parameter affects and what it defaults to. e.g. "Specify one or more upstream ntp servers as an array."

Parameters

The following parameters are available in the logstash class:

• package_name

package_name

Data type: Any

Default value: $logstash::params::package_name

logstash::install

== Class logstash::install

This class is called from logstash for install.

logstash::params

== Class logstash::params

This class is meant to be called from logstash. It sets variables according to platform.

Defined types

logstash::config

The logstash::config class.

Parameters

The following parameters are available in the logstash::config defined type:

• instance
• ensure
• order
• content
• source

instance

Data type: Any

ensure

Data type: Any

Default value: 'present'

order

Data type: Any

Default value: undef

content

Data type: Any

Default value: undef

source

Data type: Any

Default value: undef

logstash::instance

Logstash instance

A logstash instance defines a logstash service instance, and an empty configuration file. To include your own configuration, add logstash::config resources.

Example

logstash::instance { 'test': }

logstash::config { 'test input one': content => template('...') target => 'logstash::instance::test' }

ensure: present | absent

command: full path to logstash binary

config_file: full path to logstash instance config (default: /etc/logstash/${title}.conf)

user: user for running logstash (default: logstash)

group: group for running logstash (default: logstash)

workers: number of filter workers (default: '')

Parameters

The following parameters are available in the logstash::instance defined type:

• ensure
• command
• config_file
• user
• group
• workers

ensure

Data type: Any

Default value: 'present'

command

Data type: Any

Default value: '/opt/logstash/bin/logstash'

config_file

Data type: Any

Default value: "/etc/logstash/${title}.conf"

user

Data type: Any

Default value: 'logstash'

group

Data type: Any

Default value: 'logstash'

workers

Data type: Any

Default value: ''