heartbeat

edit

Generate heartbeat messages.

The general intention of this is to test the performance and availability of Logstash.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

heartbeat {
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

codec

codec

No

"plain"

count

number

No

-1

interval

number

No

60

message

string

No

"ok"

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 -1

How many times to iterate. This is typically used only for testing purposes.

interval

edit
  • Value type is number
  • Default value is 60

Set how frequently messages should be sent.

The default, 60, means send a message every 60 seconds.

message

edit
  • Value type is string
  • Default value is "ok"

The message string to use in the event.

If you set this to epoch then this plugin will use the current timestamp in unix timestamp (which is by definition, UTC). It will output this value into a field called clock

If you set this to sequence then this plugin will send a sequence of numbers beginning at 0 and incrementing each interval. It will output this value into a field called clock

Otherwise, this value will be used verbatim as the event message. It will output this value into a field called 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.