Benchmark input
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
The Benchmark input generates generic events and sends them to the output. This can be useful when you want to benchmark the difference between outputs or output settings.
Example configurations:
Basic example, infinite events as quickly as possible:
filebeat.inputs:
- type: benchmark
enabled: true
message: "test message"
threads: 1
Send 1024 events and stop example:
filebeat.inputs:
- type: benchmark
enabled: true
message: "test message"
threads: 1
count: 1024
Send 5 events per second example:
filebeat.inputs:
- type: benchmark
enabled: true
message: "test message"
threads: 1
eps: 5
The Benchmark input supports the following configuration options plus the Common options described later.
This is the value that will be in the message field of the json document.
This is the number of goroutines that will be started generating messages. Normally 1 thread can saturate an output but if necessary this can be increased.
This is the number of messages to send. 0 represents sending infinite messages. This is mutually exclusive with the eps option.
This is the number of events per second to send. 0 represents sending as quickly as possible. This is mutually exclusive with the count option.
This input exposes metrics under the HTTP monitoring endpoint. These metrics are exposed under the /inputs path. They can be used to observe the activity of the input.
| Metric | Description |
|---|---|
events_published_total |
Number of events published. |
publishing_time |
Histogram of the elapsed in nanoseconds (time of publisher.Publish). |
The following configuration options are supported by all inputs.
Use the enabled option to enable and disable inputs. By default, enabled is set to true.
A list of tags that Filebeat includes in the tags field of each published event. Tags make it easy to select specific events in Kibana or apply conditional filtering in Logstash. These tags will be appended to the list of tags specified in the general configuration.
Example:
filebeat.inputs:
- type: benchmark
. . .
tags: ["json"]
Optional fields that you can specify to add additional information to the output. For example, you might add fields that you can use for filtering log data. Fields can be scalar values, arrays, dictionaries, or any nested combination of these. By default, the fields that you specify here will be grouped under a fields sub-dictionary in the output document. To store the custom fields as top-level fields, set the fields_under_root option to true. If a duplicate field is declared in the general configuration, then its value will be overwritten by the value declared here.
filebeat.inputs:
- type: benchmark
. . .
fields:
app_id: query_engine_12
If this option is set to true, the custom fields are stored as top-level fields in the output document instead of being grouped under a fields sub-dictionary. If the custom field names conflict with other field names added by Filebeat, then the custom fields overwrite the other fields.
A list of processors to apply to the input data.
See Processors for information about specifying processors in your config.
The ingest pipeline ID to set for the events generated by this input.
The pipeline ID can also be configured in the Elasticsearch output, but this option usually results in simpler configuration files. If the pipeline is configured both in the input and output, the option from the input is used.
The pipeline is always lowercased. If pipeline: Foo-Bar, then the pipeline name in Elasticsearch needs to be defined as foo-bar.
If this option is set to true, fields with null values will be published in the output document. By default, keep_null is set to false.
If present, this formatted string overrides the index for events from this input (for elasticsearch outputs), or sets the raw_index field of the event’s metadata (for other outputs). This string can only refer to the agent name and version and the event timestamp; for access to dynamic fields, use output.elasticsearch.index or a processor.
Example value: "%{[agent.name]}-myindex-%{+yyyy.MM.dd}" might expand to "filebeat-myindex-2019.11.01".
By default, all events contain host.name. This option can be set to true to disable the addition of this field to all events. The default value is false.