IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« gelf graphite »

› ›

generator

edit

generator

edit

Generate random log events.

The general intention of this is to test performance of plugins.

An event is generated first

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

generator {
}

Available configuration options:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`codec`	codec	No	`"plain"`
`count`	number	No	`0`
`lines`	array	No
`message`	string	No	`"Hello world!"`
`tags`	array	No
`threads`	number	No	`1`
`type`	string	No

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`codec`

edit

Value type is codec
Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

`count`

edit

Value type is number
Default value is 0

Set how many messages should be generated.

The default, 0, means generate an unlimited number of events.

`lines`

edit

Value type is array
There is no default value for this setting.

The lines to emit, in order. This option cannot be used with the message setting.

Example:

    input {
      generator {
        lines => [
          "line 1",
          "line 2",
          "line 3"
        ]
        # Emit all lines 3 times.
        count => 3
      }
    }

The above will emit line 1 then line 2 then line, then line 1, etc…

`message`

edit

Value type is string
Default value is "Hello world!"

The message string to use in the event.

If you set this to stdin then this plugin will read a single line from stdin and use that as the message string for every event.

Otherwise, this value will be used verbatim as the event message.

`tags`

edit

Value type is array
There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

`threads`

edit

Value type is number
Default value is 1

`type`

edit

Value type is string
There is no default value for this setting.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

« gelf graphite »