For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub.

Generate synthetic log events.

This plugin generates a stream of synthetic events that can be used to test the correctness or performance of a Logstash pipeline.

This plugin supports the following configuration options plus theCommon options described later.

Also seeCommon options for a list of options supported by all input plugins.

• Value type isnumber
• Default value is0

Sets the number of events that should be generated.

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

• Value type isnumber
• Default value is0

Sets the rate at which events should be generated. Fractional values may be specified. For example, a rate of0.25 means that one event will be generated every four seconds.

The default,0, means generate events as fast as possible.

• Value type isarray
• There is no default value for this setting.

The lines to emit, in order. This option overrides themessage setting if it has also been specified.

Example:

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

The above will emit a series of three eventsline 1 thenline 2 thenline 3 two times for a total of 6 events.

• Value type isstring
• Default value is"Hello world!"

The message string to use in the event.

• Value type isnumber
• Default value is1

Increasing the number of generator threads up to about the number of CPU cores generally increases overall event throughput. Thecount,eps, andlines settings all apply on a per-thread basis. In other words, each thread will emit the number of events specified in thecount setting for a total ofthreads * count events. Each thread will emit events at theeps rate for a total rate ofthreads * eps, and each thread will emit each line specified in thelines option.

These configuration options are supported by all input plugins:

• Value type ishash
• Default value is{}

Add a field to an event

• Value type iscodec
• 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.

• Value type isboolean
• Default value istrue

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

• Value type isstring
• There is no default value for this setting.

Add a uniqueID 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 useful when you have two or more plugins of the same type, for example, if you have 2 java_generator inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {  java_generator {    id => "my_plugin_id"  }}

• Value type isarray
• There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

• Value type isstring
• There is no default value for this setting.

Add atype 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.