Reference

Table of Contents

Classes

• logstash_tcp_reporter: Reports logs and metrics to logstash via tcp
• logstash_tcp_reporter::params: Default values

Classes

logstash_tcp_reporter

Reports logs and metrics to logstash via tcp

• See also https://www.github.com/syseleven/puppet-logstash-tcp-reporter

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

0.9.5 (Apr 16th 2019) SSL/TLS support

features

• added SSL/TLS support over TCP
• added client certificate/key

breaking changes

• adjusted parameter names without deprecating old parameter

upcoming

• add switch to disable 'OpenSSL::SSL::VERIFY_PEER'

0.9.0 (Apr 10th 2019) first official release

summary

• added basic logstash tcp reporter
• added rspec tests
• added beaker-rspec tests

features

• writing a config file to puppet config directory
• sends metrics and logs to logstash over tcp input