Defined Type: logstash::output::elasticsearch_river

Defined in:
manifests/output/elasticsearch_river.pp

Overview

Define: logstash::output::elasticsearch_river

This output lets you store logs in elasticsearch. It's similar to the
'elasticsearch' output but improves performance by using a queue
server, rabbitmq, to send data to elasticsearch.  Upon startup, this
output will automatically contact an elasticsearch cluster and
configure it to read from the queue to which we write.  You can learn
more about elasticseasrch at http://elasticsearch.org More about the
elasticsearch rabbitmq river plugin:
https://github.com/elasticsearch/elasticsearch-river-rabbitmq/blob/master/README.md

Parameters

debug

Value type is boolean Default value: false This variable is optional

document_id

The document ID for the index. Useful for overwriting existing entries in elasticsearch with the same ID. Value type is string Default value: nil This variable is optional

durable

RabbitMQ durability setting. Also used for ElasticSearch setting Value type is boolean Default value: true This variable is optional

es_bulk_size

ElasticSearch river configuration: bulk fetch size Value type is number Default value: 1000 This variable is optional

es_bulk_timeout_ms

ElasticSearch river configuration: bulk timeout in milliseconds Value type is number Default value: 100 This variable is optional

es_host

The name/address of an ElasticSearch host to use for river creation Value type is string Default value: None This variable is required

es_ordered

ElasticSearch river configuration: is ordered? Value type is boolean Default value: false This variable is optional

es_port

ElasticSearch API port Value type is number Default value: 9200 This variable is optional

exchange

RabbitMQ exchange name Value type is string Default value: “elasticsearch” This variable is optional

exchange_type

The exchange type (fanout, topic, direct) Value can be any of: “fanout”, “direct”, “topic” Default value: “direct” 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

fields

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

index

The index to write events to. This can be dynamic using the %foo syntax. The default value will partition your indeces by day so you can more easily delete old data or only search specific date ranges. Value type is string Default value: “logstash-%+YYYY+YYYY.MM+YYYY.MM.dd” This variable is optional

index_type

The index type to write events to. Generally you should try to write only similar events to the same ‘type’. String expansion ‘%foo’ works here. Value type is string Default value: “%@type” This variable is optional

key

RabbitMQ routing key Value type is string Default value: “elasticsearch” This variable is optional

password

RabbitMQ password Value type is string Default value: “guest” This variable is optional

persistent

RabbitMQ persistence setting Value type is boolean Default value: true This variable is optional

queue

RabbitMQ queue name Value type is string Default value: “elasticsearch” This variable is optional

rabbitmq_host

Hostname of RabbitMQ server Value type is string Default value: None This variable is required

rabbitmq_port

Port of RabbitMQ server Value type is number Default value: 5672 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

user

RabbitMQ user Value type is string Default value: “guest” This variable is optional

vhost

RabbitMQ vhost 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/elasticsearch_river

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

Authors

Parameters:

  • es_host (Any)
  • rabbitmq_host (Any)
  • index (Any) (defaults to: '')
  • es_bulk_size (Any) (defaults to: '')
  • es_bulk_timeout_ms (Any) (defaults to: '')
  • debug (Any) (defaults to: '')
  • es_ordered (Any) (defaults to: '')
  • es_port (Any) (defaults to: '')
  • exchange (Any) (defaults to: '')
  • exchange_type (Any) (defaults to: '')
  • exclude_tags (Any) (defaults to: '')
  • fields (Any) (defaults to: '')
  • durable (Any) (defaults to: '')
  • index_type (Any) (defaults to: '')
  • key (Any) (defaults to: '')
  • password (Any) (defaults to: '')
  • persistent (Any) (defaults to: '')
  • queue (Any) (defaults to: '')
  • document_id (Any) (defaults to: '')
  • rabbitmq_port (Any) (defaults to: '')
  • tags (Any) (defaults to: '')
  • type (Any) (defaults to: '')
  • user (Any) (defaults to: '')
  • vhost (Any) (defaults to: '')
  • instances (Any) (defaults to: [ 'agent' ]) 


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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'manifests/output/elasticsearch_river.pp', line 185

define logstash::output::elasticsearch_river (
  $es_host,
  $rabbitmq_host,
  $index              = '',
  $es_bulk_size       = '',
  $es_bulk_timeout_ms = '',
  $debug              = '',
  $es_ordered         = '',
  $es_port            = '',
  $exchange           = '',
  $exchange_type      = '',
  $exclude_tags       = '',
  $fields             = '',
  $durable            = '',
  $index_type         = '',
  $key                = '',
  $password           = '',
  $persistent         = '',
  $queue              = '',
  $document_id        = '',
  $rabbitmq_port      = '',
  $tags               = '',
  $type               = '',
  $user               = '',
  $vhost              = '',
  $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_elasticsearch_river_${name}")
    $services     = prefix($instances, 'logstash-')
    $filesdir     = "${logstash::configdir}/files/output/elasticsearch_river/${name}"

  } else {

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

  }

  #### Validate parameters

  validate_array($instances)

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

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

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

  if ($persistent != '') {
    validate_bool($persistent)
    $opt_persistent = "  persistent => ${persistent}\n"
  }

  if ($durable != '') {
    validate_bool($durable)
    $opt_durable = "  durable => ${durable}\n"
  }

  if ($es_ordered != '') {
    validate_bool($es_ordered)
    $opt_es_ordered = "  es_ordered => ${es_ordered}\n"
  }

  if ($debug != '') {
    validate_bool($debug)
    $opt_debug = "  debug => ${debug}\n"
  }

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

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

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

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

  if ($exchange_type != '') {
    if ! ($exchange_type in ['fanout', 'direct', 'topic']) {
      fail("\"${exchange_type}\" is not a valid exchange_type parameter value")
    } else {
      $opt_exchange_type = "  exchange_type => \"${exchange_type}\"\n"
    }
  }

  if ($exchange != '') {
    validate_string($exchange)
    $opt_exchange = "  exchange => \"${exchange}\"\n"
  }

  if ($key != '') {
    validate_string($key)
    $opt_key = "  key => \"${key}\"\n"
  }

  if ($password != '') {
    validate_string($password)
    $opt_password = "  password => \"${password}\"\n"
  }

  if ($index_type != '') {
    validate_string($index_type)
    $opt_index_type = "  index_type => \"${index_type}\"\n"
  }

  if ($queue != '') {
    validate_string($queue)
    $opt_queue = "  queue => \"${queue}\"\n"
  }

  if ($rabbitmq_host != '') {
    validate_string($rabbitmq_host)
    $opt_rabbitmq_host = "  rabbitmq_host => \"${rabbitmq_host}\"\n"
  }

  if ($es_host != '') {
    validate_string($es_host)
    $opt_es_host = "  es_host => \"${es_host}\"\n"
  }

  if ($document_id != '') {
    validate_string($document_id)
    $opt_document_id = "  document_id => \"${document_id}\"\n"
  }

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

  if ($user != '') {
    validate_string($user)
    $opt_user = "  user => \"${user}\"\n"
  }

  if ($vhost != '') {
    validate_string($vhost)
    $opt_vhost = "  vhost => \"${vhost}\"\n"
  }

  if ($index != '') {
    validate_string($index)
    $opt_index = "  index => \"${index}\"\n"
  }

  #### Write config file

  file { $conffiles:
    ensure  => present,
    content => "output {\n elasticsearch_river {\n${opt_debug}${opt_document_id}${opt_durable}${opt_es_bulk_size}${opt_es_bulk_timeout_ms}${opt_es_host}${opt_es_ordered}${opt_es_port}${opt_exchange}${opt_exchange_type}${opt_exclude_tags}${opt_fields}${opt_index}${opt_index_type}${opt_key}${opt_password}${opt_persistent}${opt_queue}${opt_rabbitmq_host}${opt_rabbitmq_port}${opt_tags}${opt_type}${opt_user}${opt_vhost} }\n}\n",
    mode    => '0440',
    notify  => Service[$services],
    require => Class['logstash::package', 'logstash::config']
  }
}