Forge Home

logstash_reporter

Report processor that sends logs and metrics as json_events to Logstash

11,224 downloads

11,224 latest version

3.8 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 Aug 14th 2013

Start using this module

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

Add this module to your Puppetfile:

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

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install evenup-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

evenup/logstash_reporter — version 0.1.0 Aug 14th 2013

evenup-logstash_report

Description

A Puppet report handler for sending logs, event and metrics to a Logstash TCP input.

Requirements

  • json
  • yaml

A working logstash install with a defined tcp input matching the report configuration.

input { tcp { type => "puppet-report" port => "5959" } }

NOTE

  • Create a simple Logstash config like so (called logstash.conf):
input { tcp { type => "puppet-report" port => "5959" format => "json_event" } }
output { stdout { debug => true debug_format => "json" } }
  • run logstash with the configuration file
java -jar build/logstash-<version>-flatjar.jar agent -f logstash.conf
  • Follow the installation instructions below, changing host to the host where logstash is running and port to match the port you defined in your Logstash configuration file.

  • Profit?

Installation and Usage

  1. Define a TCP input as described above in your Logstash configuration file
  2. Copy the logstash.yaml to /etc/puppet
  3. Enable pluginsync and reports on your puppetmaster and clients in puppet.conf
[master]
report = true
reports = logstash
pluginsync = true
[agent]
report = true
pluginsync = true
  1. Run the Puppet client and sync the report as a plugin

Credits

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