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

« Irc input plugin Java_stdin input plugin »

› ›

Java_generator input plugin

edit

Java_generator input plugin

edit

Logstash Core Plugin. The java_generator input plugin cannot be installed or uninstalled independently of Logstash.

Getting Help

edit

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

Description

edit

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.

Java_generator Input Configuration Options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting	Input type	Required
`count`	number	No
`eps`	number	No
`lines`	array	No
`message`	string	No
`threads`	number	No

Also see Common Options for a list of options supported by all input plugins.

`count`

edit

Value type is number
Default value is 0

Sets the number of events that should be generated.

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

`eps`

edit

Value type is number
Default value is 0

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

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

`lines`

edit

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

The lines to emit, in order. This option overrides the message 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 events line 1 then line 2 then line 3 two times for a total of 6 events.

`message`

edit

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

The message string to use in the event.

`threads`

edit

Value type is number
Default value is 1

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

Common Options

edit

The following configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`tags`	array	No
`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.

`enable_metric`

edit

Value type is boolean
Default value is true

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.

`id`

edit

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

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

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

`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.

`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.

« Irc input plugin Java_stdin input plugin »