Defined Type: logstash::output::zabbix

Defined in:
manifests/output/zabbix.pp

Overview

Define: logstash::output::zabbix

The zabbix output is used for sending item data to zabbix via the
zabbix_sender executable.  For this output to work, your event must
have the following fields:  "zabbix_host"    (the host configured in
Zabbix) "zabbix_item"    (the item key on the host in Zabbix) In
Zabbix, create your host with the same name (no spaces in the name of
the host supported) and create your item with the specified key as a
Zabbix Trapper item.  The easiest way to use this output is with the
grep filter. Presumably, you only want certain events matching a given
pattern to send events to zabbix, so use grep to match and also to add
the required fields.   filter {    grep {      type =>
"linux-syslog"      match => [ "@message", "(error|ERROR|CRITICAL)"
]      add_tag => [ "zabbix-sender" ]      add_field => [
"zabbix_host", "%{@source_host}",        "zabbix_item", "item.key"
]   } }  output {   zabbix {     # only process events with this tag
tags => "zabbix-sender"      # specify the hostname or ip of your
zabbix server     # (defaults to localhost)     host => "localhost"
# specify the port to connect to (default 10051)     port =>
"10051"      # specify the path to zabbix_sender     # (defaults to
"/usr/local/bin/zabbix_sender")     zabbix_sender =>
"/usr/local/bin/zabbix_sender"   } }

Parameters

exclude_tags

Only handle events without any of these tags. Note this check is additional to type and tags. Value type is array Default value: [] This variable is optional

fields

Only handle events with all of these fields. Optional. Value type is array Default value: [] This variable is optional

host

Value type is string Default value: “localhost” This variable is optional

port

Value type is number Default value: 10051 This variable is optional

tags

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional. Value type is array Default value: [] This variable is optional

type

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional. Value type is string Default value: “” This variable is optional

zabbix_sender

Value type is path Default value: “/usr/local/bin/zabbix_sender” This variable is optional

instances

Array of instance names to which this define is. Value type is array Default value: [ ‘array’ ] This variable is optional

Extra information

This define is created based on LogStash version 1.1.12
Extra information about this output can be found at:
http://logstash.net/docs/1.1.12/outputs/zabbix

Need help? http://logstash.net/docs/1.1.12/learn

Authors

Parameters:

  • exclude_tags (Any) (defaults to: '')
  • fields (Any) (defaults to: '')
  • host (Any) (defaults to: '')
  • port (Any) (defaults to: '')
  • tags (Any) (defaults to: '')
  • type (Any) (defaults to: '')
  • zabbix_sender (Any) (defaults to: '')
  • instances (Any) (defaults to: [ 'agent' ]) 


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'manifests/output/zabbix.pp', line 88

define logstash::output::zabbix (
  $exclude_tags  = '',
  $fields        = '',
  $host          = '',
  $port          = '',
  $tags          = '',
  $type          = '',
  $zabbix_sender = '',
  $instances     = [ 'agent' ]
) {

  require logstash::params

  File {
    owner => $logstash::logstash_user,
    group => $logstash::logstash_group
  }

  if $logstash::multi_instance == true {

    $confdirstart = prefix($instances, "${logstash::configdir}/")
    $conffiles    = suffix($confdirstart, "/config/output_zabbix_${name}")
    $services     = prefix($instances, 'logstash-')
    $filesdir     = "${logstash::configdir}/files/output/zabbix/${name}"

  } else {

    $conffiles = "${logstash::configdir}/conf.d/output_zabbix_${name}"
    $services  = 'logstash'
    $filesdir  = "${logstash::configdir}/files/output/zabbix/${name}"

  }

  #### Validate parameters
  if ($exclude_tags != '') {
    validate_array($exclude_tags)
    $arr_exclude_tags = join($exclude_tags, '\', \'')
    $opt_exclude_tags = "  exclude_tags => ['${arr_exclude_tags}']\n"
  }

  if ($fields != '') {
    validate_array($fields)
    $arr_fields = join($fields, '\', \'')
    $opt_fields = "  fields => ['${arr_fields}']\n"
  }


  validate_array($instances)

  if ($tags != '') {
    validate_array($tags)
    $arr_tags = join($tags, '\', \'')
    $opt_tags = "  tags => ['${arr_tags}']\n"
  }

  if ($port != '') {
    if ! is_numeric($port) {
      fail("\"${port}\" is not a valid port parameter value")
    } else {
      $opt_port = "  port => ${port}\n"
    }
  }

  if ($zabbix_sender != '') {
    if $zabbix_sender =~ /^puppet\:\/\// {

      validate_re($zabbix_sender, '\Apuppet:\/\/')

      $filenameArray_zabbix_sender = split($zabbix_sender, '/')
      $basefilename_zabbix_sender = $filenameArray_zabbix_sender[-1]

      $opt_zabbix_sender = "  zabbix_sender => \"${filesdir}/${basefilename_zabbix_sender}\"\n"

      file { "${filesdir}/${basefilename_zabbix_sender}":
        source  => $zabbix_sender,
        mode    => '0440',
        require => File[$filesdir]
      }
    } else {
      $opt_zabbix_sender = "  zabbix_sender => \"${zabbix_sender}\"\n"
    }
  }

  if ($type != '') {
    validate_string($type)
    $opt_type = "  type => \"${type}\"\n"
  }

  if ($host != '') {
    validate_string($host)
    $opt_host = "  host => \"${host}\"\n"
  }


  #### Create the directory where we place the files
  exec { "create_files_dir_output_zabbix_${name}":
    cwd     => '/',
    path    => ['/usr/bin', '/bin'],
    command => "mkdir -p ${filesdir}",
    creates => $filesdir
  }

  #### Manage the files directory
  file { $filesdir:
    ensure  => directory,
    mode    => '0640',
    purge   => true,
    recurse => true,
    require => Exec["create_files_dir_output_zabbix_${name}"],
    notify  => Service[$services]
  }

  #### Write config file

  file { $conffiles:
    ensure  => present,
    content => "output {\n zabbix {\n${opt_exclude_tags}${opt_fields}${opt_host}${opt_port}${opt_tags}${opt_type}${opt_zabbix_sender} }\n}\n",
    mode    => '0440',
    notify  => Service[$services],
    require => Class['logstash::package', 'logstash::config']
  }
}