Defined Type: logstash::output::syslog

Defined in:
manifests/output/syslog.pp

Overview

Define: logstash::output::syslog

Send events to a syslog server.  You can send messages compliant with
RFC3164 or RFC5424 UDP or TCP syslog transport is supported

Parameters

appname

application name for syslog message Value type is string Default value: “LOGSTASH” This variable is optional

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

facility

facility label for syslog message Value can be any of: “kernel”, “user-level”, “mail”, “daemon”, “security/authorization”, “syslogd”, “line printer”, “network news”, “uucp”, “clock”, “security/authorization”, “ftp”, “ntp”, “log audit”, “log alert”, “clock”, “local0”, “local1”, “local2”, “local3”, “local4”, “local5”, “local6”, “local7” Default value: None This variable is required

fields

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

host

syslog server address to connect to Value type is string Default value: None This variable is required

msgid

message id for syslog message Value type is string Default value: “-” This variable is optional

port

syslog server port to connect to Value type is number Default value: None This variable is required

procid

process id for syslog message Value type is string Default value: “-” This variable is optional

protocol

syslog server protocol. you can choose between udp and tcp Value can be any of: “tcp”, “udp” Default value: “udp” This variable is optional

rfc

syslog message format: you can choose between rfc3164 or rfc5424 Value can be any of: “rfc3164”, “rfc5424” Default value: “rfc3164” This variable is optional

severity

severity label for syslog message Value can be any of: “emergency”, “alert”, “critical”, “error”, “warning”, “notice”, “informational”, “debug” Default value: None This variable is required

sourcehost

source host for syslog message Value type is string Default value: “%@source_host” 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

timestamp

timestamp for syslog message Value type is string Default value: “%@timestamp” 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

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/syslog

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

Authors

Parameters:

  • facility (Any)
  • severity (Any)
  • port (Any)
  • host (Any)
  • protocol (Any) (defaults to: '')
  • msgid (Any) (defaults to: '')
  • appname (Any) (defaults to: '')
  • procid (Any) (defaults to: '')
  • fields (Any) (defaults to: '')
  • rfc (Any) (defaults to: '')
  • exclude_tags (Any) (defaults to: '')
  • sourcehost (Any) (defaults to: '')
  • tags (Any) (defaults to: '')
  • timestamp (Any) (defaults to: '')
  • type (Any) (defaults to: '')
  • instances (Any) (defaults to: [ 'agent' ]) 


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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'manifests/output/syslog.pp', line 126

define logstash::output::syslog (
  $facility,
  $severity,
  $port,
  $host,
  $protocol     = '',
  $msgid        = '',
  $appname      = '',
  $procid       = '',
  $fields       = '',
  $rfc          = '',
  $exclude_tags = '',
  $sourcehost   = '',
  $tags         = '',
  $timestamp    = '',
  $type         = '',
  $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_syslog_${name}")
    $services     = prefix($instances, 'logstash-')
    $filesdir     = "${logstash::configdir}/files/output/syslog/${name}"

  } else {

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

  }

  #### Validate parameters

  validate_array($instances)

  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"
  }

  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 ($facility != '') {
    if ! ($facility in ['kernel', 'user-level', 'mail', 'daemon', 'security/authorization', 'syslogd', 'line printer', 'network news', 'uucp', 'clock', 'security/authorization', 'ftp', 'ntp', 'log audit', 'log alert', 'clock', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']) {
      fail("\"${facility}\" is not a valid facility parameter value")
    } else {
      $opt_facility = "  facility => \"${facility}\"\n"
    }
  }

  if ($severity != '') {
    if ! ($severity in ['emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'informational', 'debug']) {
      fail("\"${severity}\" is not a valid severity parameter value")
    } else {
      $opt_severity = "  severity => \"${severity}\"\n"
    }
  }

  if ($rfc != '') {
    if ! ($rfc in ['rfc3164', 'rfc5424']) {
      fail("\"${rfc}\" is not a valid rfc parameter value")
    } else {
      $opt_rfc = "  rfc => \"${rfc}\"\n"
    }
  }

  if ($protocol != '') {
    if ! ($protocol in ['tcp', 'udp']) {
      fail("\"${protocol}\" is not a valid protocol parameter value")
    } else {
      $opt_protocol = "  protocol => \"${protocol}\"\n"
    }
  }

  if ($procid != '') {
    validate_string($procid)
    $opt_procid = "  procid => \"${procid}\"\n"
  }

  if ($msgid != '') {
    validate_string($msgid)
    $opt_msgid = "  msgid => \"${msgid}\"\n"
  }

  if ($sourcehost != '') {
    validate_string($sourcehost)
    $opt_sourcehost = "  sourcehost => \"${sourcehost}\"\n"
  }

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

  if ($timestamp != '') {
    validate_string($timestamp)
    $opt_timestamp = "  timestamp => \"${timestamp}\"\n"
  }

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

  if ($appname != '') {
    validate_string($appname)
    $opt_appname = "  appname => \"${appname}\"\n"
  }

  #### Write config file

  file { $conffiles:
    ensure  => present,
    content => "output {\n syslog {\n${opt_appname}${opt_exclude_tags}${opt_facility}${opt_fields}${opt_host}${opt_msgid}${opt_port}${opt_procid}${opt_protocol}${opt_rfc}${opt_severity}${opt_sourcehost}${opt_tags}${opt_timestamp}${opt_type} }\n}\n",
    mode    => '0440',
    notify  => Service[$services],
    require => Class['logstash::package', 'logstash::config']
  }
}