Forge Home

logstash_reporter

Install and configure Logstash reporter for Puppet

83,616 downloads

83,616 latest version

3.1 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.1.0 (latest)
released Jun 5th 2015
This version is compatible with:
  • Puppet Enterprise >= 3.2.2
  • Puppet >=3.2.0 <4.0.0
  • , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'elasticsearch-logstash_reporter', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add elasticsearch-logstash_reporter
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install elasticsearch-logstash_reporter --version 0.1.0

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

elasticsearch/logstash_reporter — version 0.1.0 Jun 5th 2015

#Logstash Reporter Puppet module

####Table of Contents

  1. Overview
  2. Module description - What the module does and why it is useful
  3. Setup - The basics of getting started with the Logstash Reporter
  1. Usage - Configuration options and additional functionality
  2. Limitations - OS compatibility, etc.
  3. Development - Guide for contributing to the module
  4. Support - When you need help with this module
  5. Credits

##Overview

This module manages the Logstash reporter which sends puppet reports to Logstash ( http://www.elasticsearch.org/overview/logstash/ )

##Module description

The logstash_reporter module sets up and configures the reporter

##Setup

###The module manages the following

  • reporter configuration file.

###Requirements

  • json
  • yaml
  • Master puppet.conf needs to use the logstash reporter.
[master]
report = true
reports = logstash
pluginsync = true
  • Agent puppet.conf needs to send the reports to master.
[agent]
report = true
pluginsync = true

##Usage

###Main class

####Basic usesage

class { 'logstash_reporter':
}

And have a TCP input configured in logstash

input {
  tcp {
    type => "puppet-report"
    port => 5999
    codec => json
  }
}

####Separate logstash host and port

class { 'logstash_reporter':
  logstash_host => '123.123.123.123',
  logstash_port => 1234,
}

##Limitations

This module has been built on and tested against Puppet 3.2 and higher.

The module has been tested on:

  • Debian 6/7/8
  • CentOS 6/7
  • Ubuntu 12.04, 14.04
  • OpenSuSE 13.x

Other distro's that have been reported to work:

  • RHEL 6
  • OracleLinux 6
  • Scientific 6

Testing on other platforms has been light and cannot be guaranteed.

##Development

##Support

Need help? Join us in #logstash on Freenode IRC or go to our Discuss groups

##Credits

This module was originally posted by John Vincent at https://github.com/lusis/puppet-logstash-reporter