1. Description
2. Setup - The basics of getting started with filebeat
   • What filebeat affects
   • Setup requirements
   • Beginning with filebeat
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

The filebeat module installs and configures the filebeat log shipper maintained by elastic.

By default filebeat adds a software repository to your system, and installs filebeat along with required configurations.

The filebeat module depends on puppetlabs/stdlib, and on puppetlabs/apt on Debian based systems.

filebeat can be installed with puppet module install pcfens-filebeat (or with r10k, librarian-puppet, etc.)

The only required parameter, other than which files to ship, is the outputs parameter.

All of the default values in filebeat follow the upstream defaults (at the time of writing).

To ship files to elasticsearch:

class { 'filebeat':
  outputs => {
    'elasticsearch' => {
     'hosts' => [
       'http://localhost:9200',
       'http://anotherserver:9200'
     ],
     'index'       => 'packetbeat',
     'cas'         => [
        '/etc/pki/root/ca.pem',
     ],
    },
  },
}

To ship log files through logstash:

class { 'filebeat':
  outputs => {
    'logstash'     => {
     'hosts' => [
       'localhost:5044',
       'anotherserver:5044'
     ],
     'loadbalance' => true,
    },
  },
}

Shipper and logging options can be configured the same way, and are documented on the elastic website.

This module doesn't load the elasticsearch index template into elasticsearch (required when shipping directly to elasticsearch).

Pull requests and bug reports are welcome. If you're sending a pull request, please consider writing tests if applicable.