Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

logstash_forwarder

Instal and config logstash forwarder
Project URLRSS FeedReport issues

8,494 downloads

8,494 latest version

3.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.0.1 (latest)
released Aug 11th 2015

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'shidima-logstash_forwarder', '0.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add shidima-logstash_forwarder
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install shidima-logstash_forwarder --version 0.0.1

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

shidima/logstash_forwarder — version 0.0.1 Aug 11th 2015

logstash_forwarder

Table of Contents

  1. Overview
  2. Setup - The basics of getting started with logstash_forwarder
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Overview

Install and config logstash-forwarder. By default it will forward /var/log/syslog and /var/log/autlog. Other logfiles you can add via a array. Tested on Debian 7.8 and Debian 8

Setup

What logstash_forwarder affects

This module will add /etc/apt/sources.list.d/elasticsearch.list and install the logstash-forwarder package and its startup scripts and config file /etc/logstash-forwarder.conf aswell as its certificate in /etc/pki/tls/certs.

Setup Requirements

This module is dependent on puppetlabs-apt, as it will need it to add the repo.

Before you start you will have to generate a certificate for you logstash server to comunicate with the logstash-forwarder. Copy this crt file to files/logstash-forwarder.crt in the module dir. See https://goo.gl/30yTzx for more info.

Beginning with logstash_forwarder

To start using just add the following to you pp file.

include logstash_forwarder

Usage

To change the workign of the module you can do the following

class { 'logstash_forwarder':
        logstash_server      => "192.168.0.1",
        logstash_server_port => 5000,
        timeout              => 15,
        file_paths           => [
                { path => '/var/log/logfile1', type =>'logfiletype'},
                { path => '/var/log/logfile2', type => 'logfiletpe2'},
        ],

}

file_paths will add seperate entries for ever path, type pair. It will expand to

{
    "paths": [ "/var/log/logfile1" ],
    "fields": { "type": "logfiletype" }
},

Reference

Here, list the classes, types, providers, facts, etc contained in your module. This section should include all of the under-the-hood workings of your module so people know what the module is touching on their system but don't need to mess with things. (We are working on automating this section!)

Limitations

This module will only work on Debian based linuxes, as it needs apt to install logstash-forwarder.

Development

Feel free to for or add to this module

Release Notes/Contributors/Etc

11-aug-2015: First release, default install and config