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.
input {
zeromq {
add_field => ... # hash (optional), default: {}
address => ... # array (optional), default: ["tcp://*:2120"]
codec => ... # codec (optional), default: "plain"
mode => ... # string, one of ["server", "client"] (optional), default: "server"
sender => ... # string (optional)
sockopt => ... # hash (optional)
tags => ... # array (optional)
topic => ... # array (optional)
topology => ... # string, one of ["pushpull", "pubsub", "pair"] (required)
type => ... # string (optional)
}
}
Add a field to an event
0mq socket address to connect or bind
Please note that inproc://
will not work with logstash
as each we use a context per thread.
By default, inputs bind/listen
and outputs connect
The character encoding used in this input. Examples include “UTF-8” and “cp1252”
This setting is useful if your log files are in Latin-1 (aka cp1252) or in another character set other than UTF-8.
This only affects “plain” format logs since json is UTF-8 already.
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.
The format of input data (plain, json, json_event)
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}
If format is “json_event”, ALL fields except for @type are expected to be present. Not receiving all fields will cause unexpected results.
mode server mode binds/listens client mode connects
sender overrides the sender to set the source of the event default is “zmq+topology://type/”
0mq socket options This exposes zmq_setsockopt for advanced tuning see http://api.zeromq.org/2-1:zmq-setsockopt for details
This is where you would set values like: ZMQ::HWM - high water mark ZMQ::IDENTITY - named queues ZMQ::SWAP_SIZE - space for disk overflow
example: sockopt => [“ZMQ::HWM”, 50, “ZMQ::IDENTITY”, “my_named_queue”]
Add any number of arbitrary tags to your event.
This can help with processing later.
0mq topic This is used for the ‘pubsub’ topology only On inputs, this allows you to filter messages by topic On outputs, this allows you to tag a message for routing NOTE: ZeroMQ does subscriber side filtering. NOTE: All topics have an implicit wildcard at the end You can specify multiple topics here
0mq topology The default logstash topologies work as follows: * pushpull - inputs are pull, outputs are push * pubsub - inputs are subscribers, outputs are publishers * pair - inputs are clients, inputs are servers
If the predefined topology flows don’t work for you, you can change the ‘mode’ setting TODO (lusis) add req/rep MAYBE TODO (lusis) add router/dealer
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 the web interface.
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.