Defined Type: logstash::input::dlq

Defined in:
modules/logstash/manifests/input/dlq.pp

Overview

Define: logstash::input::dlq

Configure logstash to collect input from the dead letter queue.

Parameters:

  • $ensure: Whether the config should exist. Default: present

  • $path: base path of the dead letter queue (logstash.yml:path.dead_letter_queue). Default: /var/lib/logstash/dead_letter_queue

  • $pipeline_id: ID of the pipeline whose events you want to read from. Default: $title.

  • $commit_offsets: Should Logstash mark events as consumed. Default: true.

  • $priority: Configuration loading priority. Default: 10.

  • $plugin_id: Name associated with Logstash metrics. Default: input/dlq

  • $tags: Array of tags to be added to the logs. Default: undef

Sample usage:

logstash::input::dlq { 'main': }

Parameters:

  • ensure (Wmflib::Ensure) (defaults to: present)
  • path (Stdlib::Unixpath) (defaults to: '/var/lib/logstash/dead_letter_queue')
  • pipeline_id (String) (defaults to: $title)
  • commit_offsets (Boolean) (defaults to: true)
  • priority (Integer) (defaults to: 10)
  • plugin_id (String) (defaults to: 'input/dlq')
  • tags (Optional[Array]) (defaults to: ['dlq'])


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'modules/logstash/manifests/input/dlq.pp', line 18

define logstash::input::dlq(
    Wmflib::Ensure   $ensure         = present,
    Stdlib::Unixpath $path           = '/var/lib/logstash/dead_letter_queue',
    String           $pipeline_id    = $title,
    Boolean          $commit_offsets = true,
    Integer          $priority       = 10,
    String           $plugin_id      = 'input/dlq',
    Optional[Array]  $tags           = ['dlq'],
) {
    logstash::conf { "input-dlq-${title}":
        ensure   => $ensure,
        content  => template('logstash/input/dlq.erb'),
        priority => $priority,
    }

    file { "dlq-path-${title}":
        ensure => 'directory',
        path   => $path,
        owner  => 'logstash',
        group  => 'logstash',
    }
}