zeromq

Status: experimental

Read events over a 0MQ SUB socket.

You need to have the 0mq 2.1.x library installed to be able to use this input plugin.

The default settings will create a subscriber binding to tcp://127.0.0.1:2120 waiting for connecting publishers.

Synopsis

This is what it might look like in your config file:

input {
  zeromq {
    add_field => ... # hash (optional), default: {}
    address => ... # string (optional), default: "tcp://127.0.0.1:2120"
    debug => ... # boolean (optional)
    format => ... # ["plain", "json", "json_event"] (optional)
    message_format => ... # string (optional)
    mode => ... # ["server", "client"] (optional), default: "client"
    queue => ... # string (optional), default: ""
    queue_size => ... # number (optional), default: 20
    tags => ... # array (optional)
    type => ... # string (required)
  }
}

Details

add_field

• Value type is hash
• Default value is {}

Add a field to an event

address

• Value type is string
• Default value is "tcp://127.0.0.1:2120"

0mq socket address to connect or bind to

debug

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

Set this to true to enable debugging on an input.

format

• Value can be any of: "plain", "json", "json_event"
• There is no default value for this setting.

The format of input data (plain, json, json_event)

message_format

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

If format is "json", an event sprintf string to build what the display @message should be given (defaults to the raw JSON). sprintf format strings look like %{fieldname} or %{@metadata}.

mode

• Value can be any of: "server", "client"
• Default value is "client"

wether to bind ("server") or connect ("client") to the socket

queue

• Value type is string
• Default value is ""

0mq topic (Used with ZMQSUBSCRIBE, see http://api.zeromq.org/2-1:zmq-setsockopt for 'ZMQSUBSCRIBE: Establish message filter')

queue_size

• Value type is number
• Default value is 20

0mq queue size

tags

• 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 (required setting)

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

Label this input with a type. Types are used mainly for filter activation.

If you create an input with type "foobar", then only filters which also have type "foobar" will act on them.

The type is also stored as part of the event itself, so you can also use the type to search for in the web interface.

---

This is documentation from lib/logstash/inputs/zeromq.rb