For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Generate random log events.
The general intention of this is to test performance of plugins.
An event is generated first
This plugin supports the following configuration options plus the Common Options described later.
Also see Common Options for a list of options supported by allinput plugins.
0
Set how many messages should be generated.
The default, 0
, means generate an unlimited number of events.
The lines to emit, in order. This option cannot be used with the messagesetting.
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…
"Hello world!"
The message string to use in the event.
If you set this to stdin
then this plugin will read a single line fromstdin and use that as the message string for every event.
Otherwise, this value will be used verbatim as the event message.
1
The following configuration options are supported by all input plugins:
"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.
true
Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type, for example, if you have 2 generator inputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { generator { id => "my_plugin_id" }}
Add any number of arbitrary tags to your event.
This can help with processing later.
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 canalso use the type to search for it in Kibana.
If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.