Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

logstash_tcp_reporter

Installs and configures a reporter to send metrics and logs of Puppet Runs to logstash tcp server
Project URLRSS FeedReport issues

5,092 downloads

4,564 latest version

5.0 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.9.5 (latest)
  • 0.9.0
released Apr 17th 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 7.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'syseleven-logstash_tcp_reporter', '0.9.5'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add syseleven-logstash_tcp_reporter
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install syseleven-logstash_tcp_reporter --version 0.9.5

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

syseleven/logstash_tcp_reporter — version 0.9.5 Apr 17th 2019

Reference

Table of Contents

Classes

Classes

logstash_tcp_reporter

Reports logs and metrics to logstash via tcp

Examples

1 - configure puppet send data to logstash without ssl
class { 'logstash_tcp_reporter':
  host => 'logstash.example.com',
  port => 5999,
}
1 - configure your logstash tcp input without ssl
input {
  tcp {
    codec => json
    host => <host> (Optional)
    port => 5999
    type => "puppet"
  }
}
2 - send data to logstash with ssl
class { 'logstash_tcp_reporter':
  host       => 'logstash.example.com',
  port       => 5999,
  ssl_enable => true,
}
2 - configure your logstash tcp input with ssl
input {
  tcp {
    codec => json
    host => <host> (Optional)
    port => 5999
    type => "puppet"
    ssl_enable => true
    ssl_cert => <path to ssl cert>
    ssl_key => <path to ssl key>
    ssl_extra_chain_certs => [ <path to ssl chain> ]
    ssl_verify => false (this is very important if you don't use client certificates)
  }
}

Parameters

The following parameters are available in the logstash_tcp_reporter class.

host

Data type: Stdlib::Host

Hostname or IP of the logstash server

Default value: '127.0.0.1'

port

Data type: Stdlib::Port

Port of the logstash server

Default value: 5999

timeout

Data type: Integer

Timeout in seconds to connect to the logstash server

Default value: 10

ssl_enable

Data type: Boolean

Enable SSL/TLS support

Default value: false

ssl_cert

Data type: Optional[Stdlib::Absolutepath]

Client certificate path

Default value: undef

ssl_key

Data type: Optional[Stdlib::Absolutepath]

Client certificate path

Default value: undef

ssl_version

Data type: String

SSL version for connection to logstash server

Default value: ':TLSv1_2'

ssl_ca_path

Data type: Stdlib::Absolutepath

directory path of CA certificates

Default value: '/etc/ssl/certs'

ssl_ca_file

Data type: Optional[Stdlib::Absolutepath]

file path of a CA certificate

Default value: '/etc/ssl/certs/ca-certificates.crt'

config_owner

Data type: String

Owner of the configuration file

Default value: $logstash_tcp_reporter::params::config_owner

config_group

Data type: String

Group of the configuration file

Default value: $logstash_tcp_reporter::params::config_group

logstash_tcp_reporter::params

Default values